folder.host

TrueNAS

Apps (Custom App).

Install

  1. In Apps choose Discover Apps, then Install via YAML (Custom App).
  2. Paste the compose file, mount a dataset with the backup folder and a dataset for /data.
  3. Start the app and open the app page.
# folder.host app on your home storage. Start with one line:
#
#   docker compose up -d
#
# FIRST RUN: the first-setup code.
#   The page http://<device address>:8420 lets you set a password only with the first-setup code:
#   the app prints it to its log at start, as a line
#       код первой настройки страницы: ABCD-2345   (the line is in Russian: "first-setup code")
#   Where to open the log:
#     Synology (Container Manager):  Container -> store -> Details -> "Log" tab
#     QNAP (Container Station):      Containers -> store -> "Logs" tab
#     TrueNAS (Apps):                Apps -> store -> "View Logs" icon
#     Unraid:                        Docker -> store container icon -> Logs
#     UGREEN (UGOS Pro, Docker):     Container -> store -> Log
#     Linux command line:            docker compose logs store | grep "код первой настройки"
#   The code lives until the app restarts; a restart prints a new one.
#   If the password is already set, no code is printed and none is needed.
services:
  store:
    image: ghcr.io/folder-host/store-nas:latest
    restart: unless-stopped
    # If the connection fails, drop network_mode and add
    #   ports: ["7000:7000/udp", "8420:8420/tcp"]
    # (7000/udp talks to other members, 8420/tcp is the app page; do not expose 8420 to the internet)
    network_mode: host
    environment:
      # the device user that owns the folders (find out with `id <user>`)
      PUID: ${PUID:-1000}
      PGID: ${PGID:-1000}
      STORE_UI_PORT: "8420"
      # backup folder inside the app; matches the /backup volume below
      STORE_BACKUP_ROOT: /backup
      # the site: device enrollment and reports
      STORE_SITE_URL: ${STORE_SITE_URL:-https://folder.host}
    volumes:
      - store-data:/data
      # a shared folder for backups; must be writable by PUID:PGID
      - ${BACKUP_DIR:-./backup}:/backup
    healthcheck:
      test: ["CMD", "/opt/store/store-nas", "health"]
      interval: 60s
      timeout: 5s
      start_period: 60s
      retries: 3

volumes:
  store-data:

Setup

  1. Open the app log (Apps → store → “View Logs” icon) and find the line “код первой настройки страницы: ABCD-2345” (first-setup code). The code is printed at every app start while no password is set.
  2. Open the app page http://<device address>:8420, enter the first-setup code and set a recovery password. Write it down: without it data cannot be recovered.
  3. Pick the backup folder and the capacity you give to the network.
  4. Take the connection code (eight characters) from the page and enter it in your account under “Connect a node”.
  5. Wait for the “In the network” status. While the network is forming the node does not accept data.