Install

Run GuideVault with Docker.

GuideVault is intended to run as a self-hosted web app. The public Docker setup uses port 5478, a persistent data folder, and a library folder that contains your scanned archives.

Quick Docker Compose example

This example keeps generated app data and the default library folder under guidevault-data. You can change the library volume to point at an existing archive path later.

services:
  guidevault:
    image: ghcr.io/shredder5262/guidevault:latest
    container_name: guidevault
    restart: unless-stopped
    ports:
      - "5478:5478"
    environment:
      ASPNETCORE_URLS: "http://+:5478"
      ASPNETCORE_HTTP_PORTS: "5478"
      GUIDEVAULT_DATA: "/data"
      GUIDEVAULT_LIBRARY_PATH: "/library"
    volumes:
      - "./guidevault-data:/data"
      - "./guidevault-data/library:/library"

Create a container folder

Create a folder such as D:\Containers\Guidevault or another location where you keep compose files.

Save the compose file

Save the Docker Compose example as docker-compose.yml in that folder.

Start the container

Run docker compose up -d from the compose folder.

Open GuideVault

Open http://localhost:5478 on the host machine, or http://<server-ip>:5478 from another device on your LAN.

Add library files

Place CBZ/CBR files under the mounted library folder, then scan or refresh the library from GuideVault.

Port note: GuideVault uses 5478 by default so it can avoid common conflicts with other self-hosted readers that use port 5000.