1
0
mirror of https://github.com/imgproxy/imgproxy.git synced 2024-12-09 09:56:01 +02:00
Fast and secure standalone server for resizing and converting remote images
Go to file
2020-02-27 23:15:44 +06:00
.circleci Cache go mod in CircleCI 2019-09-16 21:02:05 +06:00
.github Add funding 2019-10-16 15:52:56 +06:00
.lefthook Always run tests on push 2019-09-19 19:47:04 +06:00
docker Freeze libvips and ImageMagick versions in Dockerfile 2020-02-04 15:25:38 +06:00
docs Update docs 2020-02-27 23:15:44 +06:00
examples dart signature example (#320) 2020-01-13 19:29:58 +06:00
heroku Add build arg to Heroku Dockerfile 2019-06-18 20:49:26 +06:00
imagemeta Fix heic magic bytes 2020-02-27 18:31:38 +06:00
structdiff Refactor subpackages 2019-12-25 15:18:51 +06:00
.dockerignore Use golang:1-alpine3.10 for docker build 2019-10-03 18:13:06 +06:00
.gitignore Ignore .tmp 2019-06-04 19:30:46 +06:00
.golangci.yml Better linter settings + linting errors fix 2019-09-11 14:42:36 +06:00
app.json Fix logo in app.json 2019-06-18 20:52:05 +06:00
BENCHMARK.md Add benchmark results 2019-05-08 16:45:47 +06:00
bufpool.go Better linter settings + linting errors fix 2019-09-11 14:42:36 +06:00
c_strings.go Extract Vips stuff into vips.go and CString stuff into c_strings.go 2019-06-06 16:51:29 +06:00
CHANGELOG.md Bump version 2020-02-27 22:33:21 +06:00
cmyk_profile.go Refactored logging; Syslog support 2019-01-14 16:50:59 +06:00
config.go Get rid of os.Exit 2020-02-27 21:44:59 +06:00
crypt_test.go Multiple key/salt pairs support 2018-11-15 18:35:06 +06:00
crypt.go Token => signature 2018-11-20 19:05:16 +06:00
download.go Properly name go module & update docs 2020-02-27 22:30:31 +06:00
errors_reporting.go Better Sentry support 2019-08-19 18:07:27 +06:00
errors.go IMGPROXY_REPORT_DOWNLOADING_ERRORS config 2019-10-01 15:18:37 +06:00
etag.go Refactored image downloading and watermark preparation 2019-09-20 17:01:00 +06:00
free_memory_linux.go Use malloc_trim 2020-01-10 20:52:40 +06:00
free_memory.go Use malloc_trim 2020-01-10 20:52:40 +06:00
fs_transport.go Simple filesystem transport 2019-02-04 20:06:46 +06:00
gcs_transport.go Get rid of os.Exit 2020-02-27 21:44:59 +06:00
go.mod Properly name go module & update docs 2020-02-27 22:30:31 +06:00
go.sum Update go-nanoid 2020-02-27 22:10:49 +06:00
gzippool.go Get rid of os.Exit 2020-02-27 21:44:59 +06:00
healthcheck.go Get rid of os.Exit 2020-02-27 21:44:59 +06:00
heroku.yml Add build arg to Heroku Dockerfile 2019-06-18 20:49:26 +06:00
image_type.go Properly marshal imageType, resizingType and gravityType 2019-10-10 21:06:46 +06:00
landing.go Favicon dummy handler & hello message at the root 2019-08-20 19:26:17 +06:00
lefthook.yml Add lefthook 2019-08-20 19:45:52 +06:00
LICENSE Initial commit 2017-06-20 17:00:17 +03:00
listen_no_reuseport.go SO_REUSEPORT support 2019-06-27 14:00:39 +06:00
listen_reuseport.go SO_REUSEPORT support 2019-06-27 14:00:39 +06:00
log_formatter.go New logging; JSON and structured log formats 2019-09-16 15:53:45 +06:00
log.go Get rid of os.Exit 2020-02-27 21:44:59 +06:00
logo.svg Optimize logo 2019-08-20 16:49:26 +06:00
main_test.go Get rid of init() in config.go 2019-06-06 19:26:00 +06:00
main.go Bump version 2020-02-27 22:33:21 +06:00
newrelic.go Get rid of os.Exit 2020-02-27 21:44:59 +06:00
pprof.go Require pprof build tag to enable net/pprof 2019-06-06 19:39:16 +06:00
presets_test.go Fix options rewrite 2019-07-22 17:35:52 +06:00
presets.go Tests 2018-11-06 17:19:34 +06:00
process.go Properly name go module & update docs 2020-02-27 22:30:31 +06:00
processing_handler.go Get rid of os.Exit 2020-02-27 21:44:59 +06:00
processing_options_test.go Change IMGPROXY_ALLOWED_SOURCES behavior to allow more complex limitations 2019-12-25 17:30:23 +06:00
processing_options.go Properly name go module & update docs 2020-02-27 22:30:31 +06:00
prometheus.go Get rid of os.Exit 2020-02-27 21:44:59 +06:00
README.md Add special thanks to dragonsmith 2020-02-05 20:35:20 +06:00
router.go Respond to HEAD 2020-01-30 20:41:28 +06:00
s3transport.go Get rid of os.Exit 2020-02-27 21:44:59 +06:00
server.go Get rid of os.Exit 2020-02-27 21:44:59 +06:00
syslog.go New logging; JSON and structured log formats 2019-09-16 15:53:45 +06:00
timer.go Respond with 499 is a client closed the connection 2020-01-31 20:00:05 +06:00
utils.go DRY some calculations 2019-09-11 16:45:26 +06:00
vips.c Fix build with libvips < 8.6 2020-02-27 18:40:54 +06:00
vips.go Get rid of os.Exit 2020-02-27 21:44:59 +06:00
vips.h Add option to keep metadata/tags in output image (#329) 2020-01-30 21:43:08 +06:00
watermark_data.go Refactored image downloading and watermark preparation 2019-09-20 17:01:00 +06:00

imgproxy

CircleCI branch Docker MicroBadger Size Docker Pulls Gitter

imgproxy is a fast and secure standalone server for resizing and converting remote images. The main principles of imgproxy are simplicity, speed, and security.

imgproxy can be used to provide a fast and secure way to replace all the image resizing code of your web application (like calling ImageMagick or GraphicsMagick, or using libraries), while also being able to resize everything on the fly, fast and easy. imgproxy is also indispensable when handling lots of image resizing, especially when images come from a remote source.

imgproxy does one thing — resizing remote images — and does it well. It works great when you need to resize multiple images on the fly to make them match your application design without preparing a ton of cached resized images or re-doing it every time the design changes.

imgproxy is a Go application, ready to be installed and used in any Unix environment — also ready to be containerized using Docker.

See this article for a good intro and all the juicy details! imgproxy: Resize your images instantly and securely

Sponsored by Evil Martians

Simplicity

"No code is better than no code."

imgproxy only includes the must-have features for image processing, fine-tuning and security. Specifically,

  • It would be great to be able to rotate, flip and apply masks to images, but in most of the cases, it is possible — and is much easier — to do that using CSS3.
  • It may be great to have built-in HTTP caching of some kind, but it is way better to use a Content-Delivery Network or a caching proxy server for this, as you will have to do this sooner or later in the production environment.
  • It might be useful to have everything built in — such as HTTPS support — but an easy way to solve that would be just to use a proxying HTTP server such as nginx.

Speed

imgproxy uses probably the most efficient image processing library there is, called libvips. It is screaming fast and has a very low memory footprint; with it, we can handle the processing for a massive amount of images on the fly.

imgproxy also uses native Go's net/http routing for the best HTTP networking support.

You can see benchmarking results and comparison with some well-known alternatives in our benchmark report.

Security

Massive processing of remote images is a potentially dangerous thing, security-wise. There are many attack vectors, so it is a good idea to consider attack prevention measures first. Here is how imgproxy can help:

  • imgproxy checks image type and "real" dimensions when downloading, so the image will not be fully downloaded if it has an unknown format or the dimensions are too big (there is a setting for that). That is how imgproxy protects you from so called "image bombs" like those described at https://www.bamsoftware.com/hacks/deflate.html.

  • imgproxy protects image URLs with a signature, so an attacker cannot cause a denial-of-service attack by requesting multiple image resizes.

  • imgproxy supports authorization by an HTTP header. That prevents using imgproxy directly by an attacker but allows to use it through a CDN or a caching server — just by adding a header to a proxy or CDN config.

Documentation

  1. Getting started
  2. Installation
  3. Configuration
  4. Generating the URL
  5. Watermark
  6. Presets
  7. Serving local files
  8. Serving files from Amazon S3
  9. Serving files from Google Cloud Storage
  10. New Relic
  11. Prometheus
  12. Image formats support
  13. About processing pipeline
  14. Health check
  15. Memory usage tweaks

Author

Sergey "DarthSim" Alexandrovich

Special thanks

Many thanks to:

License

imgproxy is licensed under the MIT license.

See LICENSE for the full license text.

Security Contact

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.