Skip to content
Fast and secure standalone server for resizing and converting remote images
Go C Other
Branch: master
Clone or download

Latest commit

Latest commit 3dcaeed May 13, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Update CircleCI image and config Mar 19, 2020
.github Add funding Oct 16, 2019
.lefthook Always run tests on push Sep 19, 2019
docker Update vips in Dockerfile May 6, 2020
docs typo Apr 17, 2020
examples dart signature example (#320) Jan 13, 2020
heroku Add build arg to Heroku Dockerfile Jun 18, 2019
imagemeta Fix heic magic bytes Feb 27, 2020
structdiff Refactor subpackages Dec 25, 2019
.dockerignore Use golang:1-alpine3.10 for docker build Oct 3, 2019
.gitignore Ignore .tmp Jun 4, 2019
.golangci.yml Better linter settings + linting errors fix Sep 11, 2019
BENCHMARK.md Add benchmark results May 8, 2019
CHANGELOG.md Bump version May 6, 2020
LICENSE Initial commit Jun 20, 2017
NOTICE Update NOTICE Apr 3, 2020
README.md
app.json Fix logo in app.json Jun 18, 2019
bufpool.go Better linter settings + linting errors fix Sep 11, 2019
c_strings.go Extract Vips stuff into vips.go and CString stuff into c_strings.go Jun 6, 2019
cmyk_profile.go Refactored logging; Syslog support Jan 14, 2019
config.go Implement fallback images in a similar fashion to watermarks. (#374) Apr 8, 2020
crypt.go Token => signature Nov 20, 2018
crypt_test.go Multiple key/salt pairs support Nov 15, 2018
download.go Minor changes in fallback images feature; Add docs for fallback images Apr 8, 2020
errors.go IMGPROXY_REPORT_DOWNLOADING_ERRORS config Oct 1, 2019
errors_reporting.go Better Sentry support Aug 19, 2019
etag.go Refactored image downloading and watermark preparation Sep 20, 2019
free_memory.go Use malloc_trim Jan 10, 2020
free_memory_linux.go Use malloc_trim Jan 10, 2020
fs_transport.go Simple filesystem transport Feb 4, 2019
gcs_transport.go Get rid of os.Exit Feb 27, 2020
go.mod Bump github.com/sirupsen/logrus from 1.4.2 to 1.5.0 (#366) Apr 7, 2020
go.sum Tidy mods Apr 7, 2020
gzippool.go Get rid of os.Exit Feb 27, 2020
healthcheck.go Get rid of os.Exit Feb 27, 2020
heroku.yml Add build arg to Heroku Dockerfile Jun 18, 2019
image_data.go Minor changes in fallback images feature; Add docs for fallback images Apr 8, 2020
image_type.go Properly marshal imageType, resizingType and gravityType Oct 10, 2019
landing.go Favicon dummy handler & hello message at the root Aug 20, 2019
lefthook.yml Add lefthook Aug 20, 2019
listen_no_reuseport.go SO_REUSEPORT support Jun 27, 2019
listen_reuseport.go SO_REUSEPORT support Jun 27, 2019
log.go Get rid of os.Exit Feb 27, 2020
log_formatter.go New logging; JSON and structured log formats Sep 16, 2019
logo.svg Optimize logo Aug 20, 2019
main.go Bump version May 6, 2020
main_test.go Get rid of init() in config.go Jun 6, 2019
newrelic.go Get rid of os.Exit Feb 27, 2020
panic_group.go Fix unhandled panics during animated images processing Apr 22, 2020
pprof.go Require pprof build tag to enable net/pprof Jun 6, 2019
presets.go Tests Nov 6, 2018
presets_test.go Fix options rewrite Jul 22, 2019
process.go Fix and optimize processing of animated images May 6, 2020
processing_handler.go Minor changes in fallback images feature; Add docs for fallback images Apr 8, 2020
processing_options.go Implement padding option (#358) Apr 9, 2020
processing_options_test.go Change IMGPROXY_ALLOWED_SOURCES behavior to allow more complex limita… Dec 25, 2019
prometheus.go Get rid of os.Exit Feb 27, 2020
router.go Add IMGPROXY_PATH_PREFIX config Apr 7, 2020
s3transport.go Get rid of os.Exit Feb 27, 2020
server.go Add IMGPROXY_PATH_PREFIX config Apr 7, 2020
syslog.go New logging; JSON and structured log formats Sep 16, 2019
timer.go Respond with 499 is a client closed the connection Jan 31, 2020
utils.go DRY some calculations Sep 11, 2019
vips.c Improve trim method to accept color to be cut off and hor/ver alignme… Apr 7, 2020
vips.go Improve trim method to accept color to be cut off and hor/ver alignme… Apr 7, 2020
vips.h Improve trim method to accept color to be cut off and hor/ver alignme… Apr 7, 2020

README.md

imgproxy

CircleCI branch Docker 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.

You can’t perform that action at this time.