niiknow/nginx-image-proxy

nginx 图片代理

高性能、低资源占用微服务

基于nginx image_filter模块实现实时图片裁剪（带重力定位）、调整大小和压缩。一个轻量级Docker容器，可用于构建您自己的类Cloudinary服务。

Nginx模块 - https://github.com/niiknow/docker-nginx-image-proxy/blob/master/build/ngx_http_image_filter_module.c

原始文件 - https://github.com/niiknow/docker-nginx-image-proxy/blob/master/build/src/http/modules/ngx_http_image_filter_module.c

补丁创建：diff -u src/http/modules/ngx_http_image_filter_module.c ngx_http_image_filter_module.c > image_filter.patch

应用补丁：patch src/http/modules/ngx_http_image_filter_module.c image_filter.patch

核心功能与特性

• 图片裁剪偏移量（credit: https://github.com/bobrik/nginx_image_filter%EF%BC%89
• /healthcheck健康检查端点
• 错误处理：403、404、415、500、502、503、504等错误返回空GIF
• 格式转换：支持将图片强制转换为bmp、jpg、png、gif、webp和tiff格式
• 自定义SSL和配置：挂载'/app'卷时可使用自定义SSL和保存的配置；nginx日志可重定向以便备份（如AWS S3同步），只需删除默认的stdout/access.log和stderr/error.log重定向文件
• 支持URL中的国际字符
• 自动跟随源站重定向
• 可覆盖nginx配置：轻松添加安全链接或其他nginx配置
• 水印功能

shell
# 水印文件必须为png格式
image_filter_water_image /path/to/file/watermark.png;

# 可选水印位置
image_filter_water_pos [ top-left | top-right | center | bottom-left | bottom-right (默认值)];

提示：当前水印功能实现较为基础，由于功能限制，水印会在图片调整大小后添加。最适合用于生成缩略图等较小图片，并配合较小的水印图片使用。未来如有时间可能会扩展功能。

• 缩放支持（放大图片）

shell
# 可选最大缩放比例，默认1
# 注意：不要设置过高，否则会占用过多内存
# 例如：一个200KB的JPEG文件（1024x768）加载时占用4MB内存；但放大两倍后，内存占用会跃升至20.1MB
image_filter_scale_max 3;

解决什么问题

当您有大量图片需要动态调整大小和裁剪时，Cloudinary可能成本高昂，而如果您在本微服务前运行自己的CDN，Cloudinary则显得冗余。本服务可作为替代方案。

不支持什么

与其他库不同，本服务不尝试实现所有图片转换和/或缓存功能：

1. 如需更高级功能（如动态GIF、人脸检测、自动图片优化等），建议使用Cloudinary或类似服务。
2. 除磁盘缓存外，暂无其他缓存方案计划。建议在前端部署CDN（如MaxCDN/StackPath/KeyCDN）以提供缓存和便捷的SSL支持。我们推荐StackPath/MaxCDN EdgeRules™。
3. 如需将缩略图缓存到S3，可编写Lambda函数，使用本服务生成缩略图后通过同一函数上传至S3。

构建

为实现轻量级微服务，本容器使用Docker 17.06引入的多阶段构建，因此需要Docker 17.06+版本进行构建。

bash
docker build -t nginx-image-proxy .

运行

bash
docker run -d --restart=always -p 80:80 niiknow/nginx-image-proxy --env SERVER_CONF='https://gist.githubusercontent.com/...'

使用方法

URL格式

示例：[***]

或默认HTTP协议：[***]

选项参数

yaml
参数代码: 名称 - 有效值 - 默认值
  q: 质量 - 1..100 - 96（默认最佳质量，适用于已优化的图片）
  w: 宽度 - 正整数 - null
  h: 高度 - 正整数 - null
  c: 裁剪 - null, 1 - null
  rz: 调整大小 - null, 1 - 1
  g: 重力定位 - NorthWest, North, NorthEast, West, Center, East, SouthWest, South, SouthEast（区分大小写） - NorthWest
  e: 锐化 - 1..100 - 0
  r: 旋转 - 0, 90, 180, 270 - 0
  ofmt: 输出格式 - bmp, jpg, jpeg, png, gif, webp - 无（不强制转换）

选项使用方式

选项格式灵活，支持多种方式：

• 类似Cloudinary，使用下划线(_)分隔：OptionKey_OptionValue - 如g_Center, w_100, h_100
• 无分隔符：OptionKeyOptionValue - 如gCenter, w100, h100
• 查询字符串：?g=Center&w=100&h=100

如以上方式不满足需求，可通过Docker环境变量SERVER_CONF传入自定义nginx配置URL。

示例

• 原始图片 - https://octodex.github.com/images/codercat.jpg%EF%BC%88896x896%EF%BC%89

• 动态高度 - [***] !动态高度

• 动态宽度 - [***] !动态宽度

• 固定宽高（适应） - [***] !固定宽高 - 适应

• 调整大小+旋转+锐化 - [***] !调整大小+旋转+锐化

• 带重力定位的裁剪 - [***] !带重力定位的裁剪

• 缩放+水印 - [***] !缩放+水印

相关项目

https://github.com/weserv/images%E6%98%AF%E5%8F%A6%E4%B8%80%E4%B8%AA%E4%BC%98%E7%A7%80%E7%9A%84%E5%9B%BE%E7%89%87%E8%B0%83%E6%95%B4%E9%A1%B9%E7%9B%AE%EF%BC%8C%E5%A6%82%E9%9C%80%E8%A6%81%E6%9B%B4%E5%A4%9A%E5%9B%BE%E7%89%87%E5%A4%84%E7%90%86%E5%8A%9F%E8%83%BD%E5%8F%AF%E5%8F%82%E8%80%83%E3%80%82%E6%9C%AC%E9%A1%B9%E7%9B%AE%EF%BC%88nginx-image-proxy%EF%BC%89%E6%9C%80%E5%88%9D%E6%97%A8%E5%9C%A8%E6%8F%90%E4%BE%9B%E9%AB%98%E6%80%A7%E8%83%BD%E3%80%81%E4%BD%8E%E8%B5%84%E6%BA%90%E5%8D%A0%E7%94%A8%E7%9A%84%E7%A7%81%E6%9C%89%E5%9B%BE%E7%89%87%E5%BE%AE%E6%9C%8D%E5%8A%A1%E3%80%82%E6%88%91%E4%BB%AC%E6%9B%BE%E5%B9%BF%E6%B3%9B%E6%90%9C%E7%B4%A2%E4%BD%86%E6%9C%AA%E6%89%BE%E5%88%B0%E5%90%88%E9%80%82%E6%96%B9%E6%A1%88%EF%BC%8C%E5%BD%93%E6%97%B6images.weserv.nl%E4%BD%BF%E7%94%A8PHP%E5%AE%9E%E7%8E%B0%EF%BC%8C%E6%95%85%E6%9C%AA%E9%87%87%E7%94%A8%E3%80%822018%E5%B9%B47%E6%9C%88%EF%BC%8C%E8%AF%A5%E9%A1%B9%E7%9B%AE%E9%87%8D%E5%86%99%E4%B8%BALua%E5%92%8C%E7%9B%B4%E6%8E%A5C%E7%BB%91%E5%AE%9A%EF%BC%8C%E6%88%90%E4%B8%BA%E6%AC%A1%E4%BC%98%E9%80%89%E6%8B%A9%E5%B9%B6%E6%8C%81%E7%BB%AD%E6%94%B9%E8%BF%9B%EF%BC%8C%E4%BD%9C%E8%80%85%E8%BF%98%E6%8F%90%E4%BE%9B%E5%85%8D%E8%B4%B9%E7%9A%84%E5%85%AC%E5%85%B1%E7%AB%AF%E7%82%B9%EF%BC%8C%E8%AF%81%E6%98%8E%E5%85%B6%E5%9C%A8%E7%94%9F%E4%BA%A7%E7%8E%AF%E5%A2%83%E4%B8%AD%E7%BB%8F%E8%BF%87%E5%85%85%E5%88%86%E6%B5%8B%E8%AF%95%E3%80%82

更新：截至2019年9月，images.weserv.nl再次重写为C++，现已成为更优/最佳选择。本项目已进入维护阶段，仅提供安全支持，无新功能开发，计划维护至2021年12月（自2019年12月起2年）。

许可证

MIT