Windows Install

Windows Install

This page assumes Windows with Docker Desktop installed and running.

Create folders

Open PowerShell and create the app folders:

New-Item -ItemType Directory -Force "C:\GuideVault\config"
New-Item -ItemType Directory -Force "C:\GuideVault\data"
New-Item -ItemType Directory -Force "D:\GuideVault\Library\manuals"
New-Item -ItemType Directory -Force "D:\GuideVault\Library\strategy-guides"
New-Item -ItemType Directory -Force "D:\GuideVault\Library\magazines"
New-Item -ItemType Directory -Force "D:\GuideVault\Library\metadata"

Adjust the drive letters if your library is not on D:.

Create compose folder

New-Item -ItemType Directory -Force "C:\GuideVault\compose"
cd "C:\GuideVault\compose"

Create docker-compose.yml:

services:
  guidevault:
    image: ghcr.io/shredder5262/guidevault:latest
    container_name: guidevault
    restart: unless-stopped
    ports:
      - "5478:5478"
    environment:
      ASPNETCORE_URLS: "http://+:5478"
    volumes:
      - C:/GuideVault/config:/config
      - C:/GuideVault/data:/data
      - D:/GuideVault/Library/manuals:/library/manuals
      - D:/GuideVault/Library/strategy-guides:/library/strategy-guides
      - D:/GuideVault/Library/magazines:/library/magazines
      - D:/GuideVault/Library/metadata:/library/metadata

Start GuideVault

docker compose pull
docker compose up -d

Open:

http://localhost:5478

From another machine on your network, use:

http://WINDOWS-PC-IP:5478

Common Windows checks

Check the container:

docker ps --filter name=guidevault

Check logs:

docker compose logs -f guidevault

If Docker cannot see your D: drive folders, check Docker Desktop file sharing and WSL integration settings.