Enveliq
All guides

Install Enveliq

After you install

Set things up

Privacy and security

Reference

Install Enveliq on TrueNAS SCALE

TrueNAS SCALE 24.10 and newer can run a Docker Compose file as a custom app.

You need: TrueNAS SCALE with Apps set up (a pool chosen for apps), and about 2 GB of free memory.

Step 1. Decide your settings

Open Choose your settings, decide your answers, and come back. On TrueNAS you open Enveliq from other devices, so you will most likely choose address B (home Wi-Fi) or C (Tailscale). Have your setup code ready.

Step 2. Prepare the install file

  1. Open https://github.com/jlnau/enveliq/blob/main/install/docker-compose.yml on your computer and press Copy raw file.
  2. Paste it into a plain text editor (Notepad, TextEdit in plain text mode, or any code editor) so you can edit it comfortably. TrueNAS is strict about indentation, so do not change the spaces at the start of lines.
  3. Change the lines marked <-- CHANGE THIS to your answers. On TrueNAS you will normally change the port line to - "8765:8765", as in the "port line" part of the settings page.

Step 3. Install it as a custom app

  1. In TrueNAS open Apps, then Discover Apps.
  2. Click the three dots (⋮) at the top right, then Install via YAML.
  3. Application Name: enveliq (lower case letters and numbers only).
  4. Paste your edited file into Custom Config.
  5. Press Save.

TrueNAS now downloads and starts Enveliq. This can take several minutes.

Check: on Apps, Installed, enveliq shows as Running.

Step 4. Open Enveliq

On any device on your home network go to http://YOUR-TRUENAS-NUMBER:8765, for example http://192.168.1.50:8765. You should see Set up Enveliq. Carry on with First-time setup.

Updating later

In Apps, Installed, open enveliq, press Edit, then Save again. The install file asks Docker for the newest version. Check the version number under the Enveliq logo (top left) afterwards. Your data is kept in the enveliq-data volume. More in Maintenance.

If something goes wrong

Troubleshooting.

Next

First-time setup, then connect your email.

These screens change as the programs are updated. If yours look different from this guide, please open an issue and tell us which version you have.

Suggest a change to this page