Install Enveliq with Docker Compose on Linux

For a Linux computer or server (Ubuntu, Debian, Fedora and others), or a virtual machine. This guide starts from nothing: you do not need to have used Linux or Docker before.

You need: a Linux computer with internet, about 2 GB of free memory, and about 20 minutes. You need to be able to type commands on it, either by sitting at it or from another computer using SSH.

What is a "terminal"?

A terminal is a window where you type commands. Everything in this guide that is in a grey box is a command: type it (or copy and paste it) and press Enter.

If you are sitting at the Linux computer: open the Terminal program.
If it is a server in a cupboard: from another computer, open a terminal (Windows: Windows Terminal or PowerShell; Mac: Terminal) and type ssh YOUR-USERNAME@THE-SERVER'S-NUMBER, for example ssh [email protected]. Enter your password when asked. The letters you type for a password do not show: that is normal.

To paste in a terminal, use Ctrl + Shift + V (Linux, Windows Terminal) or Command + V (Mac).

Step 1. Install Docker

If you already have Docker (docker --version prints a version number), skip to step 2.

Install it with Docker's own installer script:
```
curl -fsSL https://get.docker.com | sudo sh
```
(This is Docker's official script. If you would rather follow Docker's step-by-step page for your Linux, it is at https://docs.docker.com/engine/install/.)
Let your user run Docker without typing sudo every time:
```
sudo usermod -aG docker $USER
```
Log out and back in (or close the terminal and open a new one, or reconnect with SSH). This step matters.
Check: type this. It should print a version number for both:
```
docker --version
docker compose version
```

Step 2. Download the install file

mkdir -p ~/enveliq
cd ~/enveliq
curl -fsSL -o docker-compose.yml https://raw.githubusercontent.com/jlnau/enveliq/main/install/docker-compose.yml

Check: ls lists docker-compose.yml.

Step 3. Change the three lines

Open Choose your settings, decide your answers, and come back.
Open the file in a simple editor called nano:
```
nano docker-compose.yml
```
Use the arrow keys to move to each line marked <-- CHANGE THIS and change it. Keep the quote marks.
Save and leave: press Ctrl + O, then Enter, then Ctrl + X.

Step 4. Start Enveliq

docker compose up -d

The first time it downloads Enveliq, which can take a few minutes.

Check: run docker compose ps. Both enveliq and enveliq-render say Up (the first may say (healthy) after a minute).

Step 5. Open Enveliq

If you chose address A and you are sitting at this computer, open http://localhost:8765 in its browser.
If you chose address B, open the address you chose on any device on your home network.
If this is a server and you chose A, you can still reach it from your own computer. In a terminal on your own computer type this (change the user name and number to match yours), leave it open, and then open http://localhost:8765 in your browser:
```
ssh -L 8765:localhost:8765 [email protected]
```
For C (Tailscale) or D (a web address), follow How should I open Enveliq?.

You should see a Set up Enveliq page. Carry on with First-time setup.

Keep it running

Docker starts Enveliq again by itself after a restart (the file says restart: unless-stopped). Nothing else to do.

If something goes wrong

See Troubleshooting.

First-time setup, then connect your email.

Suggest a change to this page

Install Enveliq

After you install

Set things up

Privacy and security

Reference