2023-11-05 18:34:04 +08:00
2021-02-01 17:00:37 +08:00
2022-08-13 10:52:58 +08:00
2023-07-11 19:08:32 +02:00
2024-10-22 20:19:14 +08:00
2024-10-22 20:19:14 +08:00
2020-02-29 18:38:56 +08:00

自定义webp-server-go

  1. 如果文件非图片类型, 302重定向到源文件

  2. 改进对比逻辑, 不仅仅依靠etag 主要修改: 增加了文件大小和最后修改时间的检查。 保留了原有的 ETag 对比逻辑。 使用多重条件判断文件是否需要更新。 主要好处:

    提高了文件变更检测的准确性:

    不仅依赖 ETag还考虑了文件大小和修改时间。 能够捕获一些 ETag 未能反映的变化。 保持了效率:

    优先使用缓存的 ETag减少不必要的网络请求。 只有在确实需要时才进行文件下载。 增强了适应性:

    即使某些信息(如 ETag不可用也能依靠其他指标进行判断。 改进了日志记录:

    提供更详细的信息,说明为什么文件需要更新。 总的来说,这些修改在保持原有功能的基础上,提高了文件更新检测的准确性和鲁棒性,同时保持了系统的效率。

  3. 低于100KB的文件不处理

  4. 优化日志可读性

  5. 内存优化:

    • 控制并发
    • 流式处理大文件
    • 使用流式JSON编码器
    • 内存使用监控
  6. 根目录设置打招呼

  7. 移除IMG_PATH的配置方式, 只保留IMG_MAP.

  8. 当前缀与IMG_MAP不匹配时, 直接返回错误

CI build docker image Release WebP Server Go Binaries codecov Docker Pulls

Documentation | Website | Blog

This is a Server based on Golang, which allows you to serve WebP images on the fly.

Currently supported image format: JPEG, PNG, BMP, GIF, SVG, HEIC, NEF, WEBP

e.g When you visit https://your.website/pics/tsuki.jpgit will serve as image/webp/image/avif format without changing the URL.

GIF image will not be converted to AVIF format because the converted AVIF image is not animated.

Usage with Docker(recommended)

We strongly recommend using Docker to run WebP Server Go because running it directly with the binary may encounter issues with glibc and some dependency libraries, which can be quite tricky to resolve.

Make sure you've got Docker and docker-compose installed, create a directory and create docker-compose.yml file inside it like this:


services:
  webp:
    image: woodchen/webp-server-go
    restart: always
    volumes:
      - ./path/to/pics:/opt/pics
      - ./exhaust:/opt/exhaust
      - ./metadata:/opt/metadata
    ports:
      -  127.0.0.1:3333:3333

Suppose your website and image has the following pattern.

Image Path Website Path
/var/www/img.webp.sh/path/tsuki.jpg https://img.webp.sh/path/tsuki.jpg

Then

  • ./path/to/pics should be changed to /var/www/img.webp.sh
  • ./exhaust is cache folder for output images, by default it will be in exhaust directory alongside with docker-compose.yml file, if you'd like to keep cached images in another folder, you can change ./exhaust to /some/other/path/to/exhaust
  • ./metadata is cache folder for images' metadata, by default it will be in metadata directory alongside with docker-compose.yml file

Start the container using:

docker-compose up -d

Now the server should be running on 127.0.0.1:3333, visiting http://127.0.0.1:3333/path/tsuki.jpg will see the optimized version of /var/www/img.webp.sh/path/tsuki.jpg, you can now add reverse proxy to make it public, for example, let Nginx to proxy_pass http://127.0.0.1:3333/;, and your WebP Server is on-the-fly!

Custom config

If you'd like to use a customized config.json, you can follow the steps in Configuration | WebP Server Documentation to genereate one, and mount it into the container's /etc/config.json, example docker-compose.yml as follows:

version: '3'

services:
  webp:
    image: webpsh/webp-server-go
    # image: ghcr.io/webp-sh/webp_server_go
    restart: always
    volumes:
      - ./path/to/pics:/opt/pics
      - ./path/to/exhaust:/opt/exhaust
      - ./path/to/metadata:/opt/metadata
      - ./config.json:/etc/config.json
    ports:
      -  127.0.0.1:3333:3333

You can refer to Configuration | WebP Server Documentation for more info, such as custom config, AVIF support etc.

Advanced Usage

If you'd like to use with binary, please consult to Use with Binary(Advanced) | WebP Server Documentation

spoiler alert: you may encounter issues with glibc and some dependency libraries.

For supervisor or detailed Nginx configuration, please read our documentation at https://docs.webp.sh/

WebP Cloud Services

We are currently building a new service called WebP Cloud Services, it now has three parts:

  • Public Service
    • GitHub Avatar/Gravater reverse proxy with WebP optimization, for example, change https://www.gravatar.com/avatar/09eba3a443a7ea91cf818f6b27607d66 to https://gravatar.webp.se/avatar/09eba3a443a7ea91cf818f6b27607d66 for rendering will get a smaller version of gravater, making your website faster
    • Totally free service and currently has a large number of users, this includes, but is not limited to CNX Software, Indienova
  • WebP Cloud
  • Fly
    • We call this service Fly, with the aim of providing a public and free service that users can experience without registering on WebP Cloud. As this is a public service, some limitations compared to WebP Cloud are imposed:

      • Fly supports a maximum original image size of 8MB, while WebP Cloud supports up to 80MB.
      • Fly cache time is 1 day, while WebP Cloud has unlimited time (can be manually cleared at any time).
      • It does not support parameters like blur, sharpen for image processing.
      • And thats it.

For detailed information, please visit WebP Cloud Services Website or WebP Cloud Services Docs.

Support us

If you find this project useful, please consider supporting us by becoming a sponsor, pay via Stripe, or try out our WebP Cloud!

USD(Card, Apple Pay and Google Pay) EUR(Card, Apple Pay and Google Pay) CNY(Card, Apple Pay, Google Pay and Alipay)
USD EUR CNY

License

WebP Server is under the GPLv3. See the LICENSE file for details.

Description
重构二开版Go version of WebP Server. A tool that will serve your JPG/PNG/BMP/SVGs as WebP/AVIF format with compression, on-the-fly.
Readme GPL-3.0 32 MiB
Languages
Go 95.8%
Dockerfile 2.1%
Makefile 1.5%
Shell 0.6%