fangxinmiao / webp_server_go Goto Github PK

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..

• currently supported image format: JPEG, PNG, BMP, GIF(static image for now)

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.

Download the webp-server from release page.

Wanna build your own binary? Check out build section

./webp-server -dump-config > config.json

The default config.json may look like this.

{
	"HOST": "127.0.0.1",
	"PORT": "3333",
	"QUALITY": "80",
	"IMG_PATH": "/path/to/pics",
	"EXHAUST_PATH": "/path/to/exhaust",
	"ALLOWED_TYPES": ["jpg","png","jpeg"]
}

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.

EXHAUST_PATH is cache folder for output webp images, with EXHAUST_PATH set to /var/cache/webp in the example above, your webp image will be saved at /var/cache/webp/pics/tsuki.jpg.1582558990.webp.

./webp-server --help
Usage of ./webp-server:
  -child
        is child process
  -config string
        /path/to/config.json. (Default: ./config.json) (default "config.json")
  -dump-config
        Print sample config.json
  -dump-systemd
        Print sample systemd service file.
  -jobs int
        Prefetch thread, default is all. (default 8)
  -prefetch
        Prefetch and convert image to webp
  -prefork
        use prefork

Prefetch will convert all your images to webp. Don't worry, WebP Server will start, you don't have to wait until prefetch completes.

./webp-server -prefetch

If you want to control threads to use while prefetching, add -jobs=4. By default, it will utilize all your CPU cores.

# use 4 cores
./webp-server -prefetch -jobs=4

The standard systemd service file will show on your screen. You many want to use > to redirect to a file.

./webp-server -dump-systemd

Use screen or tmux to avoid being terminated. Let's take screen for example

screen -S webp
./webp-server --config /path/to/config.json

(Use Ctrl-A-D to detach the screen with webp-server running.)

Don't worry, we've got you covered!

Download webp-server to /opt/webps/webp-server, and create a config file to /opt/webps/config.json, then,

./webp-server -dump-systemd > /lib/systemd/system/webp-server.service
systemctl daemon-reload
systemctl enable webp-server.service
systemctl start webp-server.service

We've build docker images on hub.docker.com. If you want to run webp-server insider docker container, you can run the command below,

docker run -d -p 3333:3333 -v /path/to/pics:/opt/pics --name webps webpsh/webps

The path path/to/pics is your images serving in local. The path /opt/pics unable modify because it define in the config.json when building docker image. The cache folder of EXHAUST_PATH default define in /opt/exhaust , you can also mount the local dir for the cache folder by using -v /path/to/exhaust:/opt/exhaust option.

Let Nginx to proxy_pass http://localhost:3333/;, and your webp-server is on-the-fly.

If you use CDN(such as Cloudflare) for your website, we'd recommend you to add a no-cache header like the example below, this will prevent your images from being cached and webp images rendered to Safari users(which will of course cause some troubles).

This is an example for a typical Wordpress installation.

location ^~ /wp-content/uploads/ {
      add_header Cache-Control 'no-store, no-cache, must-revalidate, proxy-revalidate, max-age=0';
      proxy_pass http://127.0.0.1:3333;
}

If you use Caddy, you may refer to 优雅的让 Halo 支持 webp 图片输出.

This tool will check for new release whenever you run it. The updated binary will be save to update dir.

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

make

Due to the limitations of webp module, you can't cross compile this tool. But the binary will work instantly on your platform and arch

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

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

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

• 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.
• Prefetch on server initialization.
• Custom exhaust path.
• Multiple listen address.

• 让站点图片加载速度更快——引入 WebP Server 无缝转换图片为 WebP
• 记 Golang 下遇到的一回「毫无由头」的内存更改
• WebP Server in Rust
• 个人网站无缝切换图片到 webp
• 优雅的让 Halo 支持 webp 图片输出
• 让图片飞起来 oh-my-webp.sh ！

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