Fast and secure standalone server for resizing and converting remote images
Go to file
2022-02-21 18:17:36 +06:00
.circleci Fix autorelease 2021-12-15 21:25:51 +06:00
.github Add Github action to notify imgproxy-helm about updates (#634) 2021-06-23 15:49:50 +06:00
.lefthook Always run tests on push 2019-09-19 19:47:04 +06:00
bufpool Bump version 2021-09-30 20:23:30 +06:00
bufreader Bump version 2021-09-30 20:23:30 +06:00
config IMGPROXY_HEALTH_CHECK_PATH config 2022-02-21 18:06:20 +06:00
cookies Polish cookies passthrough 2021-11-11 15:30:32 +06:00
docker Use native Go in Docker build 2022-02-11 18:30:46 +06:00
docs IMGPROXY_HEALTH_CHECK_PATH config 2022-02-21 18:06:20 +06:00
errorreport Bump version 2021-09-30 20:23:30 +06:00
etag Add ETag buster 2021-12-07 15:34:35 +06:00
examples Merge branch 'master' into version/3 2021-05-17 18:25:04 +06:00
heroku Add build arg to Heroku Dockerfile 2019-06-18 20:49:26 +06:00
ierrors Better downloading error reporting cause 2021-11-01 18:29:26 +06:00
imagedata IMGPROXY_MAX_REDIRECTS config (#797) 2022-02-16 15:42:09 +06:00
imagemeta Bump version 2021-09-30 20:23:30 +06:00
imagetype Escape quotes in content disposition 2021-11-23 13:32:42 +06:00
imath Crop between scale-on-load and scale 2022-01-17 18:39:59 +06:00
logger Bump version 2021-09-30 20:23:30 +06:00
memory Combine new & old build contraints format 2021-11-15 16:42:36 +06:00
metrics Move metrics.StartRequest to middleware && Fix Datadog 2022-01-14 00:40:14 +06:00
options Add zoom option 2022-01-18 16:16:14 +06:00
processing Add zoom option 2022-01-18 16:16:14 +06:00
reuseport Combine new & old build contraints format 2021-11-15 16:42:36 +06:00
router Start requiest timer in router 2022-01-14 00:18:48 +06:00
security Bump version 2021-09-30 20:23:30 +06:00
structdiff format_quality processing option 2021-09-29 19:49:18 +06:00
testdata Global refactoring 2021-05-07 17:10:21 +06:00
transport Fix ETag+S3 2021-12-16 01:27:07 +06:00
version Bump version 2022-02-21 18:17:36 +06:00
vips Fix AVIF speed 2022-02-07 16:33:09 +06:00
.dockerignore Use native Go in Docker build 2022-02-11 18:30:46 +06:00
.gitignore Add robots.txt and sitemap.txt 2022-02-16 20:54:37 +06:00
.golangci.yml Global refactoring 2021-05-07 17:10:21 +06:00
app.json Fix logo in app.json 2019-06-18 20:52:05 +06:00
BENCHMARK.md Update BENCHMARK.md (#505) 2020-11-20 10:43:59 +06:00
build-docs-sitemap.sh Add robots.txt and sitemap.txt 2022-02-16 20:54:37 +06:00
cgo_symbolizer.go Combine new & old build contraints format 2021-11-15 16:42:36 +06:00
CHANGELOG.md Bump version 2022-02-21 18:17:36 +06:00
cloudbuild.yaml Configure cloudbuild logging 2022-02-15 18:23:24 +06:00
go.mod Update deps 2022-02-21 18:17:27 +06:00
go.sum Update deps 2022-02-21 18:17:27 +06:00
healthcheck.go Fix health command when path prefix is set 2021-11-23 15:09:50 +06:00
heroku.yml Add build arg to Heroku Dockerfile 2019-06-18 20:49:26 +06:00
landing.go Fix typo in response header name (#693) 2021-09-06 15:47:10 +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
logo.svg Optimize logo 2019-08-20 16:49:26 +06:00
main.go Proper cli command detection 2021-11-15 15:54:00 +06:00
netlify.toml Add robots.txt and sitemap.txt 2022-02-16 20:54:37 +06:00
NOTICE Add CGIF to NOTICE 2021-11-23 13:13:51 +06:00
pprof.go Combine new & old build contraints format 2021-11-15 16:42:36 +06:00
processing_handler_test.go Stabilize etag tests 2021-09-30 22:00:28 +06:00
processing_handler.go Move metrics.StartRequest to middleware && Fix Datadog 2022-01-14 00:40:14 +06:00
README.md Typo 2022-02-01 15:45:17 +06:00
server.go IMGPROXY_HEALTH_CHECK_PATH config 2022-02-21 18:06:20 +06:00

imgproxy

CircleCI branch Docker Docker Pulls Gitter

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

imgproxy is able to quickly and easily resize images on the fly, and it's well-equipped to handle a large amount of image resizing. imgproxy is a fast, secure replacement for all the image resizing code inside your web application (such as resizing libraries, or code that calls ImageMagick or GraphicsMagic). It's also an indispensable tool for processing images from a remote source. With imgproxy, you dont need to repeatedly prepare images to fit your design every time it changes.

To get an even better introduction, and to dive deeper into the nitty gritty details, check out this article: 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 takes advantage of probably the most efficient image processing library out there libvips. Its scary fast and comes with a very low memory footprint. Thanks to libvips, we can readily and extemporaneously process a massive amount of images.

imgproxy uses Gos raw (no wrappers) native net/http package to omit any overhead while processing requests and provides the best possible HTTP support.

You can take a look at some benchmarking results and compare imgproxy with some well-known alternatives in our benchmark report.

Security

In terms of security, the massive processing of remote images is a potentially dangerous endeavor. There are a number of possible attack vectors, so its a good idea to take an approach that considers attack prevention measures as a priority. Heres how imgproxy does this:

  • imgproxy checks the image type and its “real” dimensions when downloading. The image will not be fully downloaded if it has an unknown format or if the dimensions are too big (you can set the max allowed dimensions). This is how imgproxy protects from so called "image bombs”, like those described in this doc.

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

  • imgproxy supports authorization by HTTP header. This prevents imgproxy from being used directly by an attacker, but allows it to be used via a CDN or a caching server — simply by adding a header to a proxy or CDN config.

Usage

Check out our 📑 Documentation.

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.