diff --git a/README.md b/README.md index e28239437..9e9559519 100644 --- a/README.md +++ b/README.md @@ -276,6 +276,8 @@ Open `http://localhost:3000`, or `http://:3000` from another machine. `COOKIE_SECURE=false` is only for trying TREK over plain HTTP: without it the browser drops the session cookie and the login does not stick. Once TREK sits behind HTTPS (see [Reverse Proxy](#reverse-proxy)), remove it. +**TrueNAS SCALE:** Install TREK directly from the Community catalog. See the [TrueNAS SCALE installation guide](https://github.com/liketrek/TREK/wiki/Install-TrueNAS-SCALE). + > [!TIP] > **No server yet?** TREK's own public services run on [**dataforest cloud**](https://cloud.dataforest.net/en?mtm_campaign=trek), our infrastructure sponsor. A small seed is plenty for a TREK instance and is ready within a minute. @@ -348,7 +350,7 @@ TREK then launches fullscreen with its own icon, just like a native app. ## Updating See [Updating](https://github.com/liketrek/TREK/wiki/Updating) — Docker Compose, -Docker run, Helm, Portainer, Unraid and Proxmox, plus the encryption-key note. +Docker run, Helm, Portainer, Unraid, TrueNAS SCALE and Proxmox, plus the encryption-key note.
diff --git a/wiki/Install-TrueNAS-SCALE.md b/wiki/Install-TrueNAS-SCALE.md new file mode 100644 index 000000000..30620d5e6 --- /dev/null +++ b/wiki/Install-TrueNAS-SCALE.md @@ -0,0 +1,24 @@ +# Install: TrueNAS SCALE + +Install TREK from the [TrueNAS Community catalog](https://apps.truenas.com/catalog/trek_community/), without creating a custom app. + +## Install + +1. In TrueNAS, configure an Apps storage pool if you have not already done so, then open **Apps → Discover Apps**. +2. Search for **TREK** in the Community train and select **Install**. If it is not listed, check that the Community train is enabled and the catalog is up to date. +3. Set **Initial Admin Email** and **Initial Admin Password**, and choose your timezone. These credentials create the administrator on first startup; changing the fields later does not change an existing account. +4. Review **Data Storage** and **Uploads Storage**. The defaults use TrueNAS-managed ixVolumes; alternatively, choose existing host paths. For host paths, ensure both locations are writable by the configured user and group (UID/GID `568` by default). +5. Review **WebUI Port** (default `30573`) and the remaining settings, then install the app. Wait for it to start. +6. Open the app's **Web Portal** in TrueNAS, or visit `http://:30573` with the default published port. Sign in with the initial admin credentials. + +## Storage and backups + +Data Storage contains the database, settings and generated encryption key; Uploads Storage contains uploaded files. Back up both locations and preserve them when updating or moving TREK. If you set `ENCRYPTION_KEY` explicitly under **Additional Environment Variables**, keep that key safe and include it in your recovery plan. See [Backups](Backups). + +## HTTPS and configuration + +**Secure Cookies** is disabled by default for direct HTTP access. For production, use HTTPS through a reverse proxy, enable **Secure Cookies**, and add `TRUST_PROXY=1` under **Additional Environment Variables**. The proxy must support WebSocket upgrades on `/ws`. See [Reverse-Proxy](Reverse-Proxy) for setup and [Environment-Variables](Environment-Variables) for other options, including `APP_URL` and `ALLOWED_ORIGINS`. + +## Updating + +When TrueNAS offers an update for TREK, back up your data and uploads, then update the app from **Apps → Installed Applications**. Catalog updates can arrive separately from TREK releases. Database migrations run at startup and are forward-only; reverting to an older version may require restoring the pre-update database. See [Updating](Updating#database-migrations). diff --git a/wiki/Updating.md b/wiki/Updating.md index 6400cba1e..ea185c692 100644 --- a/wiki/Updating.md +++ b/wiki/Updating.md @@ -178,6 +178,10 @@ See [Install-Portainer](Install-Portainer) for the full installation walkthrough In the Unraid Docker tab, click the TREK container and select **Update**. Unraid will pull the latest image and restart with the same volumes. +## TrueNAS SCALE + +Back up your data and uploads, then update TREK from **Apps → Installed Applications** when an update is available. TrueNAS catalog updates may arrive separately from TREK releases. See [Install-TrueNAS-SCALE](Install-TrueNAS-SCALE) and [Database Migrations](#database-migrations) for storage and rollback guidance. + ## Open apps after an update A browser tab or installed app that stays open while you update notices the new version as soon as it reconnects to the restarted server. It shows a small notice with **Reload page**, which loads the new version without waiting for the next start; a page that is closed and opened again switches on its own. The notice stays away while the device is offline and can be closed until the next start. diff --git a/wiki/_Sidebar.md b/wiki/_Sidebar.md index 3707c489f..d9f2f1aa6 100644 --- a/wiki/_Sidebar.md +++ b/wiki/_Sidebar.md @@ -6,6 +6,7 @@ - [[Install: Helm|Install-Helm]] - [[Install: Proxmox VE (LXC)|Install-Proxmox]] - [[Install: Unraid|Install-Unraid]] +- [[Install: TrueNAS SCALE|Install-TrueNAS-SCALE]] - [[Install: Portainer|Install-Portainer]] - [[Reverse Proxy|Reverse-Proxy]] - [[Environment Variables|Environment-Variables]]