Installation

GuideVault is intended to run as a self-hosted web application, commonly through Docker.

Recommended install method

Use Docker Compose unless you have a specific reason not to. Compose makes it easier to keep ports, data folders, and library folders predictable.

Choose your platform

• Docker Compose — the recommended starting point.
• Linux Install — use this if your Docker host is Linux.
• Windows Install — use this if your Docker host is Windows or Docker Desktop.

Default port behavior

GuideVault currently listens inside the container on:

5478

The left side of a Docker port mapping is the host port. The right side is the container port.

ports:
  - "5478:5478"

For a second temporary instance, change only the host-side port:

ports:
  - "5479:5478"

Do not use 5479:5479 unless the image itself is changed to listen internally on port 5479.