Docker #
We’ve build docker images on
hub.docker.com and
ghcr.io. If you want to run webp-server
insider docker container without using docker-compose.yml
and without limiting the resources it will use, you can run the command below:
DockerHub
docker run -d -p 3333:3333 -v /path/to/pics:/opt/pics --name webp-server webpsh/webp-server-go
ghcr.io
docker run -d -p 3333:3333 -v /path/to/pics:/opt/pics --name ghcr.io/webp-sh/webp_server_go
The path path/to/pics
is your images serving in local. The path /opt/pics
is currently unable modify because it’s defined in the config.json
while building the docker image.
The cache folder EXHAUST_PATH
’s default is defined in /opt/exhaust
, you can also mount the local directory for the cache folder by using -v /path/to/exhaust:/opt/exhaust
option.
docker-compose.yml
example file:
version: '3'
services:
webp:
image: webpsh/webp-server-go
# image: ghcr.io/webp-sh/webp_server_go
restart: always
environment:
- MALLOC_ARENA_MAX=1
# - LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libjemalloc.so.2
# - LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libtcmalloc_minimal.so.4.5.6
volumes:
- ./path/to/pics:/opt/pics
- ./path/to/exhaust:/opt/exhaust
ports:
- 127.0.0.1:3333:3333
deploy:
resources:
limits:
memory: 400M
memswap_limit: 400M
version: '3'
services:
webp:
image: webpsh/webp-server-go
# image: ghcr.io/webp-sh/webp_server_go
restart: always
environment:
- MALLOC_ARENA_MAX=1
# - LD_PRELOAD=/usr/lib/aarch64-linux-gnu/libjemalloc.so.2
# - LD_PRELOAD=/usr/lib/aarch64-linux-gnu/libtcmalloc_minimal.so.4.5.6
volumes:
- ./path/to/pics:/opt/pics
- ./path/to/exhaust:/opt/exhaust
ports:
- 127.0.0.1:3333:3333
deploy:
resources:
limits:
memory: 400M
memswap_limit: 400M
memory
andmemswap_limit
will limit the RAM used by container will not exceed 400M and will use no swap, more info can be seen on https://docs.docker.com/config/containers/resource_constraints/#--memory-swap-details.Using
LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libjemalloc.so.2
will usejemalloc
for malloc, can reduce RAM usage, related discussion: https://github.com/webp-sh/webp_server_go/issues/198Using
- LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libtcmalloc_minimal.so.4.5.6
will usetcmalloc
for malloc.
Use with docker-compose --compatibility up -d
to start the service.
Custom config #
If you’d like to use a customized config.json
, you can follow the steps in
Basic Usage 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
environment:
- MALLOC_ARENA_MAX=1
# - LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libjemalloc.so.2
# - LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libtcmalloc_minimal.so.4.5.6
volumes:
- ./path/to/pics:/opt/pics
- ./path/to/exhaust:/opt/exhaust
- ./config.json:/etc/config.json
ports:
- 127.0.0.1:3333:3333
deploy:
resources:
limits:
memory: 400M
memswap_limit: 400M