1
0
mirror of https://github.com/imgproxy/imgproxy.git synced 2024-11-24 08:12:38 +02:00
Fast and secure standalone server for resizing and converting remote images
Go to file
2018-11-02 18:11:35 +06:00
.circleci CircleCI 2018-10-31 03:13:34 +06:00
docs Fix docs resize_type -> resizing_type (#91) 2018-11-01 13:22:57 +06:00
examples Update Elixir example (#77) 2018-10-18 19:47:21 +06:00
vendor fasthttp; Optimized memory allocation 2018-10-05 21:17:36 +06:00
.dockerignore Add Dockerfile and .dockerignore to .dockerignore 2018-10-25 22:27:57 +06:00
.gitignore Enable s3 transport scheme 2018-10-04 21:03:59 +06:00
app.json Make kay and salt optional in app.json 2018-10-03 19:35:40 +06:00
CHANGELOG.md Fix changelog 2018-10-08 12:36:55 +06:00
cmyk_profile.go Fix processing of CMYK without embedded profile 2018-01-10 16:10:20 +06:00
config.go Merge branch 'crohr/s3-protocol' into version/2.0 2018-10-05 00:46:04 +06:00
crypt.go Typo 2018-10-06 03:01:54 +06:00
Dockerfile Fix Dockerfile 2018-10-25 22:25:54 +06:00
download.go Remove redundant URL validation 2018-11-02 18:11:35 +06:00
errors.go Predefine static errors 2018-10-06 02:29:55 +06:00
etag.go Predefine static errors 2018-10-06 02:29:55 +06:00
Gopkg.lock fasthttp; Optimized memory allocation 2018-10-05 21:17:36 +06:00
Gopkg.toml fasthttp; Optimized memory allocation 2018-10-05 21:17:36 +06:00
gzip.go fasthttp; Optimized memory allocation 2018-10-05 21:17:36 +06:00
heroku.yml Deploy to Heroku with Docker (#50) 2018-02-02 19:18:14 +06:00
image_types.h Rename processing options constants and move them to processing_options.go 2018-10-02 17:30:20 +06:00
LICENSE Initial commit 2017-06-20 17:00:17 +03:00
logo.svg Logo 2017-09-21 10:15:37 +03:00
main.go Bump version 2018-10-25 22:26:25 +06:00
mutex.go fasthttp; Optimized memory allocation 2018-10-05 21:17:36 +06:00
presets.go Check presets options on start; Exit on preset error 2018-10-02 17:31:51 +06:00
process.go Fix smart crop + brur/sharpen SIGSEGV on Alpine 2018-10-25 20:22:58 +06:00
processing_options.go Validate url format after adding BASE_URL (#97) 2018-11-02 18:02:33 +06:00
README.md CircleCI 2018-10-31 03:13:34 +06:00
s3transport.go Merge branch 'crohr/s3-protocol' into version/2.0 2018-10-05 00:46:04 +06:00
server.go Fix path parsing 2018-10-08 13:42:08 +06:00
timer.go Remove forgotten struct 2018-10-09 19:55:19 +06:00
utils.go Focus point gravity 2018-10-02 17:31:51 +06:00
vips.h Background option 2018-10-02 18:20:23 +06:00

imgproxy

CircleCI Docker MicroBadger Size Docker Pulls

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 fasthttp for the best HTTP networking speed and less memory usage.

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. Presets
  6. Serving local files
  7. Serving files from Amazon S3
  8. Source image formats support
  9. About processing pipeline
  10. Health check

Author

Sergey "DarthSim" Alexandrovich

Many thanks to Roman Shamin for the awesome logo.

Great bunch of kudos goes to John Cupitt who develops libvips and helps me to optimize its usage under the hood of imgproxy.

License

imgproxy is licensed under the MIT license.

See LICENSE for the full license text.