Dockerized PHP application runs as a Microservice to resize and crop images on the fly. Get optimised images with MozJPEG, WebP or PNG using ImageMagick. Includes face detection, cropping, face blurring, image rotation and many other options. Abstract storage based on FlySystem in order to store images on any provider (local, AWS S3...).
Image resizing, cropping and compression on the fly with the impressive MozJPEG compression algorithm. One Docker container to build your own Cloudinary-like service.
You pass the image URL and a set of keys with options, like size or compression. Flyimg will fetch the image, convert it, store it, cache it and serve it. The next time the request comes, it will serve the cached version.
<!-- https://www.mozilla.org/media/img/firefox/firefox-256.e2c1fc556816.jpg --> <img src="https://my.img.service.io/upload/w_333,h_333,q_90/https://www.mozilla.org/media/img/firefox/firefox-256.e2c1fc556816.jpg">
You will need to have Docker on your machine. Optionally you can use Docker machine to create a virtual environment. We have tested on Mac, Windows and Ubuntu.
Pull the image
docker pull flyimg/flyimg-build
Start the container
docker run -itd -p 8080:80 flyimg/flyimg-build
You can spin up your own working server in 10 minutes using the provision scripts for AWS Elastic Beanstalk or the DigitalOcean Ubuntu Droplets (more environments to come). For other environments or if you want to tweak and play in your machine before rolling out, read along…
You can use
composer for the first step.
git clone https://github.com/flyimg/flyimg.git
Create the project with
composer create .
composer create-project flyimg/flyimg
CD into the folder and to build the docker image by running:
docker build -t flyimg .
This will download and build the main image, It will take a few minutes. If you get some sort of error related to files not found by apt-get or similar, try this same command again.
Then run the container:
docker run -itd -p 8080:80 -v $(pwd):/var/www/html --name flyimg flyimg
For Fish shell users:
docker run -itd -p 8080:80 -v $PWD:/var/www/html --name flyimg flyimg
The above command will make the Dockerfile run supervisord command which launches 2 processes: nginx and php-fpm and starts listening on port 8080.
IMPORTANT! If you cloned the project, only for the first time, you need to run
composer install inside the container:
docker exec -it flyimg composer install
Again, it will take a few minutes to download the dependencies. Same as before, if you get some errors you should try running
composer install again.
You can navigate to your machine’s IP in port 8080 (ex: http://127.0.0.1:8080/ ) ; you should get a message saying: Hello from Flyimg! and a small homepage of flyimg already working. If you get any errors at this stage it’s most likely that composer has not finished installing or skipped something.
You can test your image resizing service by navigating to: http://127.0.0.1:8080/upload/w_130,h_113,q_90/https://www.mozilla.org/media/img/firefox/firefox-256.e2c1fc556816.jpg
This is fetching an image from Mozilla, resizing it, saving it and serving it.
You go to your server URL
http://imgs.kitty.com and append
/upload/; after that you can pass these options below, followed by an underscore and a value
w_250,q_50 Options are separated by coma (configurable to other separator) .
After the options put the source of your image, it can be relative to your server or absolute:
So to get a pretty kitten at 250 pixels wide, with 50% compression, you would write.
options_keys: moz: mozjpeg q: quality o: output unsh: unsharp fc: face-crop fcp: face-crop-position fb: face-blur w: width h: height c: crop bg: background st: strip rz: resize g: gravity f: filter r: rotate sc: scale sf: sampling-factor rf: refresh ett: extent par: preserve-aspect-ratio pns: preserve-natural-size webpl: webp-lossless
default_options: mozjpeg: 1 quality: 90 output: auto unsharp: null face-crop: 0 face-crop-position: 0 face-blur: 0 width: null height: null crop: null background: null strip: 1 resize: null gravity: Center filter: Lanczos rotate: null scale: null sampling-factor: 1x1 refresh: false extent: null preserve-aspect-ratio: 1 preserve-natural-size: 1 webp-lossless: 0
Most of these options are ImageMagick flags, many can get pretty advanced, use the ImageMagick docs. We put a lot of defaults in place to prevent distortion, bad quality
default: auto : Output format requested, for example you can force the output as jpeg file in case of source file is png.
default: 1 : Use moz-jpeg compression library, if
false it fallback to the default ImageMagick compression algorithm.
default: 90 : Sets the compression level for the output image. Your best results will be between 70 and 95.
default: null : Sets the target width of the image. If not set, width will be calculated in order to keep aspect ratio.
default: null : Sets the target height of the image. If not set, height will be calculated in order to keep aspect ratio.
By default setting width and height together, works like defining a rectangle that will define a max-width and max-height and the image will scale propotionally to fit that area without cropping.
By default; width, height, or both will not scale up an image that is smaller than the defined dimensions.
default: false : When both width and height are set, this allows the image to be cropped so it fills the width x height area.
default: Center : When crop is applied, changing the gravity will define which part of the image is kept inside the crop area.
The basic options are:
[...] -gravity NorthWest ...
default: white : Sets the background of the canvas for the cases where padding is added to the images. It supports hex, css color names, rgb.
Only css color names are supported without quotation marks.
For the hex code, the hash
# character should be replaced by
[...] -background red ... [...] -background "#ff4455" -> "%23ff4455" [...] -background "rgb(255,120,100)" ...
default: 1 : removes exif data and additional color profile.
default: null : The alternative resizing method to -thumbnail.
default: null : Sharpens an image with a convolved Gausian operator. A good example
[...] -unsharp 0.25x0.25+8+0.065 ...
default: Lanczos : Resizing algorithm, Triangle is a smoother lighter option
[...] -filter Triangle
default: null : The “-scale” resize operator is a simplified, faster form of the resize command. Useful for fast exact scaling of pixels.
default: null : Apply image rotation (using shear operations) to the image.
default: false : Refresh will delete the local cached copy of the file requested and will generate the image again. Also it will send headers with the command done on the image + info returned by the command identity from IM.
default: false : Using facedetect repository to detect faces and passe the coordinates to ImageMagick to crop.
default: false : When using the Face crop option and when the image contain more than one face, you can specify which one you want get cropped
default: false : Apply blur effect on faces in a given image
Restricted domains disabled by default. This means that you can fetch a resource from any URL. To enable the domain restriction, change in config/parameters.yml
After enabling, you need to put the white listed domains
whitelist_domains: - www.domain-1.org - www.domain-2.org
docker exec -it flyimg vendor/bin/phpunit tests/
Storage files based on Flysystem which is
a filesystem abstraction allows you to easily swap out a local filesystem for a remote one. Technical debt is reduced as is the chance of vendor lock-in.
Default storage is Local, but you can use other Adapters like AWS S3, Azure, FTP, Dropbox, …
Currently, only the local and S3 are implemented as Storage Provider in Flyimg application, but you can add your specific one easily in
in parameters.yml change the
storage_system option from local to s3, and fill in the aws_s3 options :
storage_system: s3 aws_s3: access_id: "s3-access-id" secret_key: "s3-secret-id" region: "s3-region" bucket_name: "s3-bucket-name"
Crop http://localhost:8080/upload/w_200,h_200,c_1,/Rovinj-Croatia.jpg Requests [total, rate] 500, 50.10 Duration [total, attack, wait] 9.987040447s, 9.979999952s, 7.040495ms Latencies [mean, 50, 95, 99, max] 30.374428ms, 7.118491ms, 198.48037ms, 403.203168ms, 667.636703ms Bytes In [total, mean] 86208, 172.42 Bytes Out [total, mean] 0, 0.00 Success [ratio] 100.00% Status Codes [code:count] 200:500 Resize http://localhost:8080/upload/w_200,h_200,rz_1/Rovinj-Croatia.jpg Requests [total, rate] 500, 50.10 Duration [total, attack, wait] 9.986398956s, 9.979999972s, 6.398984ms Latencies [mean, 50, 95, 99, max] 14.058886ms, 7.27949ms, 26.480589ms, 218.968846ms, 289.695028ms Bytes In [total, mean] 101675, 203.35 Bytes Out [total, mean] 0, 0.00 Success [ratio] 100.00% Status Codes [code:count] 200:500 Rotate http://localhost:8080/upload/r_-45,w_400,h_400/Rovinj-Croatia.jpg Requests [total, rate] 500, 50.10 Duration [total, attack, wait] 10.851828209s, 9.97999994s, 871.828269ms Latencies [mean, 50, 95, 99, max] 2.286214264s, 2.140216211s, 4.513043865s, 7.226125489s, 7.251871479s Bytes In [total, mean] 987720, 1975.44 Bytes Out [total, mean] 0, 0.00 Success [ratio] 100.00% Status Codes [code:count] 200:500
Thank you to all our backers! [Become a backer]
Thank you to all our sponsors! (please ask your company to also support this open source project by becoming a sponsor)
Enjoy your Flyimaging!