# reImage

**Repository Path**: topmy/reImage

## Basic Information

- **Project Name**: reImage
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-02-25
- **Last Updated**: 2021-02-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# reImage

## Features
1. No os.exec call of pngquant or mozjpeg. Only bindings to libraries.
2. Using libvips for fast image resizing
3. Docker container uses libvips compiled with mozjpeg instead of libjpeg-turbo. MozJPEG makes tradeoffs that are intended to benefit Web use cases and focuses solely on improving encoding, so it's best used as part of a Web encoding workflow.
4. png images are optimized with libimagequant (backend library of pngquant)


## Install steps
1. Deploy it with Docker
2. Configure frontend
3. Enjoy!

## Deploy
1. Pull docker container:  `docker pull larrabee/reimage:1.2.5`
2. Run it with `docker run -d -p 7075:7075 larrabee/reimage:1.2.5` or use docker-compose config:
```yml
version: '2.2'
services:
  reImage:
    image: larrabee/reimage:1.2.5
    restart: always
    ports:
      - "7075:7075"  
```

## Configure frontend
This is basic Nginx config for online resizing with nginx cache.
```nginx
http {
    proxy_cache_path /var/www/resize_cache levels=1:2 
    keys_zone=resized_img:64m inactive=48h max_size=5G use_temp_path=off;

    server {
        listen       80;
        server_name  example.com;
        root /var/www/example.com/;

        location /img/ {
           location ~* \.(jpg|jpeg|png|ico)(\@[0-9xX]+)$ {
             proxy_pass http://localhost:7075; #Node with running image resizer
             proxy_set_header X-RESIZE-SCHEME "http";
             proxy_set_header X-RESIZE-BASE "example.com";
             #Nginx cache. Optional
             proxy_cache_valid  200 48h;
             proxy_cache_valid  404 400 5m;
             proxy_cache_valid 500 502 503 504 10s;
             add_header X-Cache-Status $upstream_cache_status;
             proxy_cache resized_img;
           }
        }
    }
}
```
Required options: 
1. Replace `localhost:7075` with your hostname and port if you ran resizer in different node. 
2. Set `X-RESIZE-SCHEME "http"` if your image server with original images run over http (by default use https). 
3. Set you image server hostname here: `X-RESIZE-BASE "example.com"` 

Optional: 
1. Set `X-RESIZE-QUALITY` header if you want to override quality settings. Default value: 80, allowed values: 1-100 
2. Set `X-RESIZE-COMPRESSION` header if you want to override compression settings. Default value: 6, allowed values: 0-9 


## Enjoy!
* Upload [test image](samples/jpeg/bird_1920x1279.jpg) to `/img/test.jpg` on your server
* Get original image [`http://example.com/img/test.jpg`](http://example.com/img/test.jpg) (naturally it must be present on your server).
* Get resized to 1280x720 version [`http://example.com/img/test.jpg@1280`](http://example.com/img/test.jpg@1280) (height resolution will be calculate automatically)
* Another way: [`http://example.com/img/test.jpg@x720`](http://example.com/img/test.jpg@x720) (width resolution will be calculate automatically)
* Get resized to 500x500 version (image will be resized and striped to 500x500) [`http://example.com/img/test.jpg@500x500`](http://example.com/img/test.jpg@500x500)  
* Get resized to 500x500 version converted to webp (image will be resized and striped to 500x500 and converted to webp) [`http://example.com/img/test.jpg@500x500?fmt=webp`](http://example.com/img/test.jpg@500x500?fmt=webp). Supported formats: jpeg (or jpg), png, webp, tiff.  
* Get resized to 500x500 version with custom compression (image will be resized and striped to 500x500) [`http://example.com/img/test.jpg@500x500?cmp=9`](http://example.com/img/test.jpg@500x500?cmp=9). Compression value range: from 0 to 9.  
* Get resized to 500x500 version with custom quality (image will be resized and striped to 500x500) [`http://example.com/img/test.jpg@500x500?qlt=100`](http://example.com/img/test.jpg@500x500?qlt=100). Quality value range: from 0 to 100.  
* Get resized to 500x500 version with custom background color [`http://example.com/img/test.jpg@500x500?bgclr=003cfa`](http://example.com/img/test.jpg@500x500?qlt=100). Format: RGB in HEX encoding, like "ffffff" for white. Default: "000000" for none.


## Benchmark
See [benchmark Wiki page](https://github.com/ultimate-guitar/reImage/wiki/Benchmark)

## LICENSE
MIT