Install on a NAS¶

TrueNAS SCALE¶

Corvus is in the Community train of the TrueNAS app catalog.

1. Apps → Discover Apps, search for Corvus, then Install.

2. Keep the default ports or change them:

   Port	Default	Used for
   Admin Console Port	30553	The console (HTTPS, self-signed certificate at first)
   HTTP Port	30554	Your sites over HTTP and Let's Encrypt HTTP validation
   HTTPS Port	30555	Your sites over HTTPS

   The TrueNAS web interface already uses 80 and 443, which is why the app uses other ports.

3. Choose where Corvus keeps its data (Data Storage). Back up that dataset like any other app data; it holds the database, certificates and the encryption keys.

4. After the app starts, open its logs in the Apps page and find the line with setup_token. To choose the token yourself instead, add CORVUS_SETUP_TOKEN (at least 12 characters) under Additional Environment Variables before installing.
5. Open https://<truenas-ip>:30553, accept the certificate warning, enter the token and create the administrator account. Then continue with your first proxy host.

Reaching your sites from the internet¶

Forward ports 80 → 30554 and 443 → 30555 on your router to the TrueNAS address. Visitors and Let's Encrypt then reach Corvus on the usual ports. Without port 80 forwarded, use the DNS challenge for certificates.

Keep the console port (30553) closed to the internet; see Protect the console.

Updates¶

TrueNAS shows an update for the app when a new Corvus version is in the catalog. Data is migrated automatically on start.

Unraid¶

Corvus is in Community Applications (the Apps tab).

1. Apps, search for Corvus, then Install.

2. Keep the default ports or change them:

   Port	Default	Used for
   Admin console	9443	The console (HTTPS, self-signed certificate at first)
   HTTP	1880	Your sites over HTTP and Let's Encrypt HTTP validation
   HTTPS	18443	Your sites over HTTPS

   Unraid's web interface usually uses 80 and 443, which is why the template uses other ports. To use 80/443 directly, give the container its own IP address (Network Type br0 or a custom network).

3. Data is kept in /mnt/user/appdata/corvus and owned by nobody:users (PUID 99, PGID 100). Back it up like other app data; it holds the database, certificates and the encryption keys.

4. To choose the setup token yourself, fill in Setup Token (at least 12 characters) before the first start. Otherwise open the container's Logs and find the line with setup_token.
5. Click WebUI in the container menu (or open https://<unraid-ip>:9443), accept the certificate warning, enter the token and create the administrator account.

Forward ports 80 → 1880 and 443 → 18443 on your router to reach your sites from the internet. Keep the console port closed to the internet. Updates appear in the Docker tab like for other containers.

Other NAS systems¶

Any NAS that runs Docker Compose (Synology Container Manager, QNAP Container Station, …) can use the normal install. Things to watch for:

• Ports 80/443 already in use by the NAS. Publish Corvus on other ports (e.g. 8080:80 and 8443:443) and forward 80/443 from your router to them, or move the NAS interface to other ports.
• Folder permissions. Set PUID/PGID to the NAS user that owns the data folder (see Configuration).
• The setup token is in the container log, or set CORVUS_SETUP_TOKEN.

Running Corvus on a NAS that isn't covered here? Notes are welcome in issue #94.