Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/x25/ngx_pngquant
PNG compression module for Nginx
https://github.com/x25/ngx_pngquant
Last synced: 17 days ago
JSON representation
PNG compression module for Nginx
- Host: GitHub
- URL: https://github.com/x25/ngx_pngquant
- Owner: x25
- License: mit
- Created: 2015-01-04T15:24:20.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2015-05-01T09:51:13.000Z (over 9 years ago)
- Last Synced: 2024-10-11T01:14:40.604Z (about 1 month ago)
- Language: C
- Size: 262 KB
- Stars: 19
- Watchers: 3
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Module ngx_pngquant
============
The ``ngx_pngquant`` module is a filter for lossy compression of PNG images.
## Configuration
```nginx
server {
set $store_path /tmp/pngquant;
root /var/www;
location ~ \.png$ {
root $store_path;
try_files $uri @pngquant;
}
location @pngquant {
pngquant on;
pngquant_buffer_size 1M;
pngquant_colors 256;
pngquant_dither on;
pngquant_speed 1;
pngquant_store $store_path$uri;
pngquant_store_access user:rw group:rw all:r;
}
}
```
## How to build
Install module dependencies:
**Ubuntu or Debian**
```sh
sudo apt-get install build-essential libgd-dev
```
**RedHat, CentOS, or Fedora**
```sh
sudo yum install gcc-c++ gd-devel pcre-devel make
```
Download ``ngx_pngquant`` and install ``libimagequant`` submodule:
```sh
cd
git clone https://github.com/x25/ngx_pngquant
cd ngx_pngquant
git submodule update --init
```
Download and build **nginx**/**openresty**/**tengine** with support for ``ngx_pngquant``:
```sh
cd
# check http://nginx.org/en/download.html for the latest version
wget http://nginx.org/download/nginx-1.6.2.tar.gz
tar -xvzf nginx-1.6.2.tar.gz
cd nginx-1.6.2/
./configure --prefix=/tmp/nginx --add-module=$HOME/ngx_pngquant
make
sudo make install
```
If you want to have debug logs available:
```sh
./configure --prefix=/tmp/nginx --add-module=$HOME/ngx_pngquant --with-debug
```
Start nginx with pngquant module:
```sh
/tmp/nginx/sbin/nginx -c /path/to/nginx.conf
```
## Directives
Syntax:pngquant on | off;
Default:pngquant off;
Context:location
Turns on/off module processing in a surrounding location.
---
Syntax:pngquant_buffer_size size;
Default:pngquant_buffer_size 1M;
Context:http, server, location
Sets the maximum size of the buffer used for reading images. When the size is exceeded the server returns error **415 (Unsupported Media Type)**.
---
Syntax:pngquant_colors colors;
Default:pngquant_colors 256;
Context:http, server, location
Sets the maximum number of palette entries in images.
---
Syntax:pngquant_dither on | off;
Default:pngquant_dither on;
Context:http, server, location
If dither is set, the image will be dithered to approximate colors better, at the expense of some obvious "speckling."
---
Syntax:pngquant_speed speed;
Default:pngquant_speed 0;
Context:http, server, location
Speed is from 1 (highest quality) to 10 (fastest). Speed 0 selects library-specific default (recommended).
---
Syntax:pngquant_store string;
Default:none
Context:http, server, location
Enables saving of processed images to a disk. The file name can be set explicitly using the string with variables:
```
pngquant_store /data/www$uri;
```
An example of caching:
```nginx
server {
root /var/www;
location ~ \.png$ {
root /tmp/pngquant;
try_files $uri @pngquant;
}
location @pngquant {
pngquant on;
pngquant_store /tmp/pngquant$uri;
}
}
```
---
Syntax:pngquant_temp_path path [level1] [level2] [level3];
Default:pngquant_temp_path /tmp 1 2;
Context:http
Sets temporary area where files are stored before they are moved to ``pngquant_store`` area.
---
Syntax:pngquant_store_access users:permissions ...;
Default:pngquant_store_access user:rw;
Context:http, server, location
Sets access permissions for newly created files and directories, e.g.:
```
pngquant_store_access user:rw group:rw all:r;
```
If any ``group`` or ``all`` access permissions are specified then user permissions may be omitted:
```
pngquant_store_access group:rw all:r;
```
## Status
This module is experimental and it's compatible with following web servers:
- nginx 1.6.x (tested with 1.6.2).
- nginx 1.7.x (tested with 1.7.9).
- openresty 1.7.x (tested with 1.7.7.1).
- tengine 2.1.x (tested with 2.1.0).