Getting Started

This quick start explanation gets Scryer running with persistent configuration, media roots, and a shared staging path for completed local work.

Before starting, decide on three persistent paths:

• A config directory
• One or more final media roots
• A completed-work staging path that Scryer can see at a stable location

Docker Compose

Save as docker-compose.yml, replacing the /path/to/... entries with the appropriate folders:

services:
  scryer:
    image: ghcr.io/scryer-media/scryer:latest
    container_name: scryer
    restart: unless-stopped
    ports:
      - "8080:8080"
    volumes:
      - scryer-config:/config
      - /path/to/movies:/data/movies
      - /path/to/series:/data/series
      - /path/to/anime:/data/anime
      - /path/to/downloads:/downloads

Optional: To run Weaver alongside Scryer, add the following service block to the same docker-compose.yml file, inside the services: key, and include the shared volumes: section at the end.

  weaver:
    image: ghcr.io/scryer-media/weaver:latest
    container_name: weaver
    restart: unless-stopped
    ports:
      - "9090:9090"
    volumes:
      - weaver-config:/config
      - /path/to/downloads:/downloads

volumes:
  scryer-config:
  weaver-config:

Start the stack:

docker compose up -d

Open http://localhost:8080.

After the container starts, confirm that the Scryer UI opens, the setup flow loads, and the mounted paths match the intended paths for Movies, Series, Anime, and completed local work.

First configuration pass

1. Complete setup and create the first admin user.
2. Confirm the library layout matches the paths mounted into the container.
3. Add or scan titles in the relevant facet: Movies, Series, or Anime.
4. Configure only the provider instances Scryer needs in Settings.
5. Review permissions and navigation before adding additional users.

For a first pass, keep the instance conservative: confirm library roots first, then add a small number of titles, then verify scans, imports, and Wanted state before broadening defaults or user access.

Upgrading

To upgrade a Docker install, pull the latest image and restart:

docker compose pull
docker compose up -d

After an upgrade, open the Scryer UI, verify that the System pages load, and spot-check one facet overview plus one Settings page before resuming normal operator work.

macOS with Homebrew

brew install scryer-media/scryer/scryer
brew services start scryer

Open http://localhost:8686.

Homebrew creates a live service config at $(brew --prefix)/etc/scryer/config.env. Edit that file to change the bind address or port, then restart the service:

brew services restart scryer

Homebrew is a good fit for a local workstation or a small single-host install where containerization is not part of the normal operating model.

Windows

Download scryer-windows-x86_64.zip from the latest release, unzip it, and start scryer.exe.

Open http://localhost:8080.

Keep the extracted application and its data directory on persistent storage. The data directory holds the config, database, and logs — do not place it inside a temp folder or the same directory as the binary. Verify the final media roots and completed-work staging path from the UI before adding titles.

Related concepts

• Facet — understand the difference between Movies, Series, and Anime before configuring libraries
• Library — how Scryer owns roots, permissions, and scan behavior inside a facet
• Library scan — run this after confirming media roots are correct
• Import — how Scryer moves completed local items into a managed library location
• Monitoring — controls whether Scryer keeps evaluating a title for new or better files
• Wanted item — what Scryer creates when a monitored title is missing or below cutoff
• Permissions — understand access grants before adding additional users