Skip to content

Pre-deployment checklist ​

Use this page before running the installer. It helps avoid the common case where containers start successfully but photos cannot be scanned or a phone cannot reach the server.

What you need ​

ItemMinimumRecommended
SystemWindows, macOS, Linux, or a Docker-capable NASA supported 64-bit x86 or ARM system with current Docker
DockerDocker Engine / Desktop and Docker ComposeConfirm with docker compose version first
StorageSpace for original photos, thumbnails, and the databaseReserve headroom and a separate backup destination
NetworkA browser can reach the serverUse the same LAN for phones, or configure HTTPS public access
AICPU is enough for the basic flowLarger libraries or local models benefit from more memory and a GPU; a GPU is not required to install

Check your photo directory ​

  • Use an existing absolute host path, not a temporary drive, disconnected network mapping, or a container path.
  • Ensure Docker can read the directory. Upload, organize, rename, and cleanup features also require appropriate write access.
  • Back up photos before the first import. Test file-changing tools on a small directory first.
  • Initial scanning time depends on photo count, file sizes, disk speed, and enabled AI. It runs in the background and does not mean the web app is unavailable.

Network and ports ​

  • The installer exposes one TrailSnap address; browsers, native apps, and the CLI all use it.
  • The app can scan a connection QR code, discover a service on the same LAN, or accept the address manually. Do not use localhost from another device.
  • If LAN access fails, inspect Docker port mapping, the firewall, and Wi-Fi AP / guest-network isolation.

Choose your starting path ​

  1. Trying TrailSnap: deploy in CPU mode with a small test folder.
  2. Importing a family library: back up the photos and database, then run the first scan during an idle period.
  3. Using mobile or public access: plan a domain and HTTPS first; keep Server, AI, and database ports private.
  4. Using third-party AI or an Agent: read Data, privacy, and backups and grant tokens the minimum scope.

When ready, continue to the installation guide.

Released under the AGPL-3.0 License