webp_server_go/README.md

THIS PROJECT IS UNDER DEVELOPMENT, DON'T USE IT ON PRODUCTION ENVIRONMENT.

After the n0vad3v/webp_server, I decide to rewrite the whole program with Go, as there will be no more npm installs or docker-composes.

This is a Server based on Golang, which allows you to serve WebP images on the fly. It will convert jpg,jpeg,png files by default, this can be customized by editing the config.json..

e.g When you visit https://a.com/1.jpg，it will serve as image/webp without changing the URL.

For Safari and Opera users, the original image will be used.

Compare to n0vad3v/webp_server

Size

• webp_server with node_modules: 43M
• webp-server(go) single binary: 15M

Performance

It's basically between ExpressJS and Fiber, much faster than the http package of course.

Convenience

• webp_server: Clone the repo -> npm install -> run with pm2
• webp-server(go): Download a single binary -> Run

Usage

Regarding the IMG_PATH section in config.json. If you are serving images at https://example.com/pics/tsuki.jpg and your files are at /var/www/image/pics/tsuki.jpg, then IMG_PATH shall be /var/www/image.

1. Download the webp-server from release page.
2. Create a config.json like this to face your need, default convert quality is 80%.
3. Run the binary like this: ./webp-server --config /path/to/config.json, use screen or tmux to hold it currently.(Will add systemd later)
4. Let Nginx to proxy_pass http://localhost:3333/;

TODO

• This version doesn't support header-based-output, which means Safari users will not see the converted webp images, this should be fixed in later releases.
• Multi platform support.
• A better way to supervise the program.
• Get rid of render-blocking effect on first render.

Build

Install golang, enable go module, clone the repo, and then...

go build webp-server.go

Due to the limitations of webp module, you can't cross compile this tool.