Unraid

Envoryx was built with Unraid in mind, and there it comes as a regular Docker template. You don’t need Community Applications for it.

Installing the template

First, make sure there’s a development share - that’s where your projects will live. Create it if you don’t have one yet.

Then copy the template onto the flash drive, once, from the Unraid terminal or over SSH:

wget -O /boot/config/plugins/dockerMan/templates-user/my-Envoryx.xml \
  https://raw.githubusercontent.com/envoryx/envoryx/main/deploy/unraid/envoryx.xml

Now go to Docker → Add Container, pick Envoryx under User templates and click Apply. Ports, /config, /projects, the Docker socket and PUID/PGID are already filled in. Open http://<unraid-ip>:8787 and create your admin account - that’s it.

If you’d rather not copy files around, you can add https://github.com/envoryx/envoryx under Docker → Add Container → Template repositories instead. Unraid then reads the template straight from the repository.

Download the template only once

When you click Apply, Unraid saves your container settings - network type, backup share, ports - in my-Envoryx.xml. Download the file again and those settings are gone. There should also be exactly one file for Envoryx in templates-user: a second copy under another name sorts first, and from then on every Edit and Update starts from the repository defaults. This shows you what’s there:

ls /boot/config/plugins/dockerMan/templates-user/ | grep -i envoryx

If you see anything besides my-Envoryx.xml, delete the extra file, open the container’s edit page once, check the values and click Apply.

Updates

Docker → Check for Updates → Apply pulls the new image and keeps your settings. You don’t need a new template for that. The only time you touch it is when a release adds a variable or a path to the template - then add it on the container’s edit page by hand.

Setting it up by hand

You can also skip the template and fill in Docker → Add Container yourself:

Setting	Value
Repository	ghcr.io/envoryx/envoryx:latest
Network type	bridge
Port	8787 → 8787
Port	80 → 80 and 443 → 443 (proxy; optional, other host ports work)
Port	2222 → 2222 (SSH for IDEs; optional)
Path /config	/mnt/cache/appdata/envoryx
Path /projects	/mnt/user/development
Path /backups	optional, e.g. /mnt/user/backups/envoryx
Path /var/run/docker.sock	/var/run/docker.sock
Variable PUID	99
Variable PGID	100

The project ports (20000-20999 by default) are published by the project containers themselves, so there’s nothing else to map.

A few Unraid specifics

Where /config should live. /config holds a SQLite database. /mnt/user/appdata/envoryx works, but it goes through FUSE, and Envoryx will show you a warning about it. The pool path (/mnt/cache/appdata/envoryx, or whatever your pool is called) is the safer choice. On Unraid 6.12 and later you can also turn on Exclusive access for the appdata share.

Who owns the files. Everything created inside your projects belongs to PUID:PGID, which on Unraid is nobody:users (99:100). That’s what keeps the files editable over SMB.

A busy Docker tab. Every project brings several containers called envoryx-<project>-…. Envoryx takes care of them, so it’s best to leave them alone. If they clutter the list, the FolderView3 plugin can collect them: create a folder with the regex ^envoryx-, or enter a folder name under Settings → General → Unraid Docker page in Envoryx and create a folder with exactly that name in FolderView3.

The stop timeout. Unraid has one Docker stop timeout for all containers (Settings → Docker, 10 seconds by default). If a backup or an image pull that’s still running should get the chance to finish when Envoryx stops, raise that timeout together with the template’s Shutdown grace.

Domains and HTTPS. To reach your projects as https://shop.test, map the proxy ports 80/443 (bridge network) or give the container its own IP on br0. Domains and HTTPS walks you through it.