README.Docker.md

winvoice-gui

docker

A Dockerfile is provided to run the application in an isolated environment. A database is not included in the image, but is required to start the server.

Build

Run the following command:

docker build [--build-arg <arg>=<value> ...] [--tag <tag>] .

For example:

docker build --build-arg GID=100 --tag winvoice-gui:latest .

Arguments

Name	Default	Description
DEFAULT_SERVER_ADDR	""	The default winvoice-server address to connect to
GID	10001	The ID of the created group.
UID	${GID}	The ID of the created user.

Usage

[!WARN]

winvoice-gui is built with Next.js, which uses HTTP. It is recommended to:

1. never use docker run --publish with winvoice-gui images, and
2. use a reverse proxy to enable HTTPS.

The docker compose integration provides an example of such an HTTPS proxy.

See also: vercel/next.js#10935

After building, run:

docker run --expose 3000 --rm <image-name>

docker compose

A compose file is provided to run the application. A postgres image is included in the configuration.

Note

See also the docs for:

• nginx-proxy
• winvoice-server

Important

The compose file requires COMPOSE_EXPERIMENTAL_GIT_REMOTE=1 in the environment. It is possible to remove this requirement by manually merging winvoice-server's compose file.

Build

Run the following command:

docker compose up

Secrets

Name	Path	Description
proxy-ssl	config/proxy/ssl/	See here
proxy-ssl-cadir	config/proxy/ssl-cadir/	Trust authorities to use within the container. Structured like /etc/ssl/certs/ in alpine.