Skip to content
HomeKnowledge BaseStatisticsChangelog GitHub Discord Email
getting-started / Host Helper

No results for ""

Host Helper

Overview

The demyx host command manages the core Demyx infrastructure — Traefik, the main Demyx container, and the code-server service.

Host operations use the release-pinned Demyx helper image for the installed helper version. In Demyx 1.11.0, that means helper-driven compose actions run through demyx/demyx:1.11.0.

Commands

Edit host environment

bash
demyx host edit

Opens the host .env file in nano inside the Demyx container. Key variables to configure:

VariableDescription
DEMYX_DOMAINYour server's primary domain
DEMYX_EMAILEmail for Let's Encrypt
DEMYX_SERVER_IPYour server's public IP
DEMYX_BACKUP_ENABLEEnable auto backups (true/false)
DEMYX_HEALTHCHECKEnable healthchecks (true/false)
DEMYX_SMTPEnable SMTP notifications (true/false)

View host environment

bash
demyx host env

Prints the current host .env without opening an editor.

Start the stack

bash
demyx host up

Starts Demyx, Traefik, and code-server (if previously running).

Open a host shell

bash
demyx shell

Opens a root shell in the main Demyx container. You can also pass a command:

bash
demyx shell demyx info system

Restart the stack

bash
demyx host restart

Force-recreates all host containers. Use after editing host edit.

Upgrade

bash
demyx host upgrade

Upgrades the Demyx host stack. It pulls the release-pinned helper image, updates /usr/local/bin/demyx when needed, pulls relevant service images, recreates core services, refreshes app configs, updates the image cache, and removes dangling images.

Skip the confirmation prompt:

bash
demyx host upgrade -f

Container monitoring with ctop

bash
demyx host ctop

Launches ctop — a real-time container resource monitor — in a temporary Docker container.

Remove the host stack

bash
demyx host down

Stops and removes the main Demyx container. Your app data is preserved in Docker volumes.

Remove all core Demyx services, including code-server and Traefik:

bash
demyx host down all

Checking Warnings

When you run demyx (without arguments), the MOTD shows active warnings:

text
[WARNING] For SSL to work properly, please set a valid domain for DEMYX_DOMAIN: demyx host edit
[WARNING] Auto backups are disabled, set DEMYX_BACKUP_ENABLE to true: demyx host edit

Fix these by running demyx host edit and setting the appropriate values, then demyx host restart.