Linux Install

Linux Install

This page assumes a Linux host with Docker and Docker Compose already installed.

Create folders

sudo mkdir -p /opt/guidevault/config
sudo mkdir -p /opt/guidevault/data
sudo mkdir -p /srv/guidevault/library/manuals
sudo mkdir -p /srv/guidevault/library/strategy-guides
sudo mkdir -p /srv/guidevault/library/magazines
sudo mkdir -p /srv/guidevault/library/metadata

Give your user ownership while setting up files:

sudo chown -R "$USER:$USER" /opt/guidevault /srv/guidevault

Create compose file

Create the compose folder:

mkdir -p ~/guidevault
cd ~/guidevault

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:
      - /opt/guidevault/config:/config
      - /opt/guidevault/data:/data
      - /srv/guidevault/library/manuals:/library/manuals
      - /srv/guidevault/library/strategy-guides:/library/strategy-guides
      - /srv/guidevault/library/magazines:/library/magazines
      - /srv/guidevault/library/metadata:/library/metadata

Start GuideVault

docker compose pull
docker compose up -d

Open:

http://SERVER-IP:5478

Common Linux checks

Check the container:

docker ps --filter name=guidevault

Check logs:

docker compose logs -f guidevault

Check that Docker can see the library folders:

docker exec -it guidevault ls -la /library