How to use Enver

The complete guide to the Enver application.

How Enver works

Enver is a control plane for your containers. Your applications run on your own servers; Enver keeps their configuration, tells the servers what to run and shows you what is going on. The building blocks are:

Your containers, volumes and backups never leave your servers. If Enver is unavailable, your environments keep running; you just cannot manage them until it is back.

Quick start

  1. Sign in with Google or GitHub and choose Create account (or Wait for an invite if a colleague is adding you).
  2. Connect a registry under Registries if your images are private. Public Docker Hub images work without one.
  3. Describe your services under Services: image, default tag, ports and variables.
  4. Add an edge server under Edge Servers → New server, open it and follow Install: one command on the server and a token.
  5. Create an environment under Environments, pick the edge server and Docker or Kubernetes, and add services to it.
  6. Start it. The environment detail shows the live status, uptime and logs of every service. The logs refresh every 10 seconds, or at once with the refresh button.

Accounts and team

Accounts

The user who creates an account is its owner and can do everything in it. You can own more accounts (User settings → Accounts → New account) and be a member of others; switch between them with the account switcher in the header. Account names are unique across Enver.

Accounts live on one of our servers. We may move an account to another one, e.g. when a paid plan runs on dedicated servers. While it moves – usually for seconds to minutes – the account is read-only and a bar under the header says so; your environments keep running. The app and your edge servers then find the account on its new server by themselves.

When an account starts paying – any plan, even a single add-on – we move it to a server for paying customers if it isn’t on one already. The owner of a paid account can also choose its server under Account → Settings; the move then works as described above.

Inviting members

Under Account → Users, invite a colleague by e-mail. They receive an e-mail with a link to the invitation, sign in and accept or reject it. They must sign in with the address the invitation was sent to - with a password, or with Google, GitHub or Microsoft. Their invitations are also listed under User settings → Accounts → Invitations. Pending invitations count towards the account’s user limit.

Members

The owner and user admins see who is online, edit permissions (Permissions) and the owner can remove members or Transfer ownership to another member (the previous owner loses owner privileges).

Export and deletion

Under Account → Data and deletion, the owner downloads everything Enver stores for the account as a JSON file (secret values and tokens are left out) and deletes the account. Deleting needs the paid subscriptions ended first; the account then disappears for all members at once and its data is erased within 30 days. Containers and volumes on your edge servers stay as they are. Your own profile is deleted under User settings → General → Delete profile, once you own no account.

Permissions

Members get permissions per account. Higher permissions include the lower ones.

PermissionAllows
Env AdminCreate, edit, start and stop all environments, add and configure their services.
Env Tag SwitchingSwitch tags, restart services and view logs – ideal for developers deploying their branch.
Env ViewerSee environments, their status and variables (without secret values).
Service Admin / ViewerManage or see the service catalog and service groups.
Edge Server Admin / ViewerManage (including tokens and settings) or see edge servers.
Variable Group Admin / ViewerManage or see variable groups.
Registry Admin / Viewer, Registry Tag SearchManage or see registries, search images and tags.
User AdminInvite members and change their permissions; Invites Admin, Permissions Admin and User Viewer grant the parts separately.
Monitoring ViewerSee edge server metrics.
Infrastructure ViewerSee the infrastructure overview: every environment with its edge server, ports and volumes.
DB Backups Admin / Operator / ViewerConfigure and delete backups / create and restore them / see them.
Secrets RevealCopy stored secret values. Every reveal is recorded in the audit log.
Security ViewerSee the edge servers’ security audit: reports, logins and findings, which include the user names of the server’s accounts, and the vulnerabilities of the images the services run, and the account’s security overview with its members’ last activity. Turning the audit on, its retention and muting findings belong to Edge Server Admin.

You can only grant or remove permissions you hold yourself, so nobody can raise their own or anyone else's access above their own. Permissions you don't hold are greyed out in the dialog and stay as they are. The owner holds every permission.

Per-environment permissions

In an environment, Permissions lets the owner fine-tune access for one member: a whitelist grants Env Admin, Tag Switching or Viewer in this environment only, a blacklist takes it away here only (e.g. a developer can switch tags everywhere except production). Blocking a level also blocks the levels above it.

Container registries

Under Registries, add Docker Hub or a custom registry (its URL, e.g. https://ghcr.io) with a username and an access token. The token is stored encrypted and never shown again; leave it empty when editing to keep it. Enver uses the registry to pull images on your edge servers and to suggest images and tags in forms.

Automatic redeploy from Docker Hub

For a Docker Hub registry, Set up Docker Hub webhook shows a URL to paste into the repository’s webhooks on Docker Hub. After every push, Enver restarts – pulls and recreates – every running service that uses the pushed repository and tag, and the new tag shows up in the tag suggestions at once (without a webhook within a minute). Anyone who knows the URL can trigger those restarts, so keep it secret. If it leaks, issue a new one in the same dialog (Regenerate URL): the old one stops working at once, and you replace it on Docker Hub. The URL points to the Enver hub and stays valid when your account moves to another of our servers; a URL copied before the hub existed points to the server itself, so copy it again.

Services

Under Services → New service, describe an application once for the whole account:

Ports and volumes are a starting point: they are copied into an environment when you add the service there, and later changes to the service don’t affect environments it is already in. Default variables are different: they are inherited, so a changed default applies in every environment that doesn’t override it (see One configuration for many environments). A service can only be deleted once it is removed from all environments.

Variables and secrets

Where values come from

When a service is deployed, its variables are merged in this order, a later one winning:

  1. the service’s default values,
  2. assigned variable groups (the later assignment wins),
  3. values set in the environment itself,
  4. the service’s env file on the edge server, if it has one – Enver never sees these values.

The environment service form lists the Inherited variables with their source, and Override sets an environment value. Variables are always listed alphabetically.

One configuration for many environments

Dev, staging, production and every preview environment mostly need the same variables; only a few, such as the database URL or the log level, differ. Thanks to the order above you configure the common part once and each environment adds only its differences:

  1. Put what a service needs everywhere into its default variables (Services).
  2. Put what several services share – SMTP, a message broker, Sentry, object storage – into a variable group (Variable Groups) and assign it to those services in each environment.
  3. In each environment, Override only the values that differ. Everything else stays inherited, and the form shows where each value comes from.
  4. For the next environment, use Duplicate existing: the copy brings every service with its own values and group assignments, so you only adjust what differs again.

Defaults and groups are not copied into environments, so a change to them applies in every environment that doesn’t override the variable, the next time its service starts or restarts. When test environments should use different shared values than production, keep a group per stage, e.g. smtp-production and smtp-test; Duplicate group creates the second one, secrets included.

Example: an api service with 4 default variables and the group backend-shared with 6 more runs in dev, staging, production and a preview. Each of these environments sets just DATABASE_URL, and dev also LOG_LEVEL=debug; the other 10 values live in one place.

Secrets

A secret value is stored encrypted and never sent back to the browser – the form only shows whether it is set. Members with Secrets Reveal can copy it to the clipboard, and every reveal is recorded in the audit log. A variable the service declares secret is secret in every environment; an environment can make its own value secret, too. A stored secret only becomes public together with a new value.

Secrets that never leave your server

If you’d rather not give Enver some values at all – database passwords, API keys – keep them in an env file on the edge server and let the agent read it there. Enver stores only the file’s name; the values go from the file straight into the container and never pass through Enver, its database or the connection to it.

  1. On the edge server, create the file in /etc/enver/env-files (the installer creates the directory; on an agent installed before this feature, create it with sudo install -d -m 750 -o root -g enver-edge-server /etc/enver/env-files). Let root own it and the agent only read it:
    sudo nano /etc/enver/env-files/my-app.env
    sudo chown root:enver-edge-server /etc/enver/env-files/my-app.env
    sudo chmod 640 /etc/enver/env-files/my-app.env
    The format is the usual .env: NAME=value per line, # comments, quoted values may span several lines. A bare NAME without a value is not taken from the agent’s environment, unlike docker --env-file.
  2. In Enver, open the service in the environment and fill in Env file on the edge server with the file’s name, e.g. my-app.env, or a path below the directory, e.g. production/my-app.env.
  3. Start or restart the service. The agent reads the file at every start and restart, so after editing it, restart the service.

Want to check it for yourself? See Check what the agent sends.

Import, export and references

Service and variable groups

Service groups (Service Groups) bundle services such as “backend” so an environment can start, stop or switch the tag of all of them at once. Variable groups (Variable Groups) hold shared configuration – e.g. SMTP or a message broker – that you assign to services in environments instead of copying the values. Both support public and secret values and .env import and export. Duplicate group on a variable group’s edit page creates a copy under a new name with every saved variable, secrets included – they are copied encrypted, so it needs no permission to reveal them. The copy is not assigned to any service.

Edge servers

Install

Under Edge Servers → New server, name the server, open it and click Install. The dialog shows the commands with your token filled in. On Debian/Ubuntu (amd64 or arm64):

curl -fsSL -o /tmp/enver-edge-server.deb "https://enver-api.apinecka.com/v1/edge-servers/installer" \
  && echo "<SHA-256 from the dialog>  /tmp/enver-edge-server.deb" | sha256sum -c - \
  && sudo dpkg -i /tmp/enver-edge-server.deb && rm /tmp/enver-edge-server.deb

On macOS (with Docker Desktop, OrbStack or Colima):

curl -fsSL -o /tmp/enver-edge-server.tar.gz "https://enver-api.apinecka.com/v1/edge-servers/installer/macos" \
  && echo "<SHA-256 from the dialog>  /tmp/enver-edge-server.tar.gz" | shasum -a 256 -c - \
  && tar -xzf /tmp/enver-edge-server.tar.gz -C /tmp && sudo /tmp/enver-edge-server/install.sh \
  && rm -rf /tmp/enver-edge-server /tmp/enver-edge-server.tar.gz

Then put the connection settings from the dialog into /etc/enver/edge-server.env and restart the agent:

EDGE_SERVER_PORT=10999
EDGE_SERVER_TOKEN=<token from the dialog>
API_URL=https://hub.enver.apinecka.com
sudo systemctl restart enver-edge-server                      # Linux
sudo launchctl kickstart -k system/com.enver.edge-server      # macOS

The server turns Online within seconds. Keep the token secret – anyone with it can connect as your server. API_URL is the Enver hub: on every start the agent asks it which instance your account lives on and connects there. The token has the form <server id>.<secret>; an agent installed earlier keeps working with its old token and API_URL. The agent keeps a connection to Enver open (outgoing only; no inbound port has to be opened to the internet), reports statuses every few seconds and host metrics every minute. When we move your account to another server, the agent asks the hub again and reconnects by itself, with the same token.

Verify the download

The commands in the dialog stop before installing unless the file’s SHA-256 matches the one Enver publishes for it. Every installer is also signed, and the dialog shows how to check the GPG signature; before you trust the key, compare its fingerprint with enver-signing-key.gpg in the public repository:

curl -fsSL "https://enver-api.apinecka.com/v1/edge-servers/installer/signing-key" | gpg --import
curl -fsSL -o /tmp/enver-edge-server.deb "https://enver-api.apinecka.com/v1/edge-servers/installer" \
  && curl -fsSL -o /tmp/enver-edge-server.deb.asc "https://enver-api.apinecka.com/v1/edge-servers/installer.asc"
gpg --verify /tmp/enver-edge-server.deb.asc /tmp/enver-edge-server.deb && sudo dpkg -i /tmp/enver-edge-server.deb

What the agent does and what it needs

Check what the agent sends

You don’t have to take our word for any of the above. The agent can write the TLS session keys of its connections into a file, and Wireshark then decrypts everything it exchanged with Enver. On Linux:

  1. Turn the key log on (a directory only the agent can write to) and restart the agent. Its log then warns that it writes the keys:
    sudo install -d -m 700 -o enver-edge-server /var/lib/enver-keys
    echo 'SSLKEYLOGFILE=/var/lib/enver-keys/edge-server.keys' | sudo tee -a /etc/enver/edge-server.env
    sudo systemctl restart enver-edge-server
  2. Capture the traffic while you do what you want to check, e.g. start a service with an env file. Restart the agent once more after starting the capture, so it also holds the websocket’s handshake:
    sudo tcpdump -i any -w /tmp/enver.pcap 'tcp port 443'
    sudo systemctl restart enver-edge-server   # in another terminal, then start the service in Enver
  3. Stop the capture with Ctrl+C and copy /tmp/enver.pcap and /var/lib/enver-keys/edge-server.keys to the computer with Wireshark.
  4. In Wireshark, set Edit → Preferences → Protocols → TLS → (Pre)-Master-Secret log filename to the keys file and open the capture (or run wireshark -o tls.keylog_file:edge-server.keys enver.pcap). The display filter http || websocket shows the decrypted requests and messages; Follow → TLS Stream shows a whole connection as text. The deployment arrives as a service.action message: it carries envFile with the file’s name and the variables set in Enver, but no value from the file.
  5. To search everything at once without the GUI:
    for s in $(tshark -r enver.pcap -T fields -e tcp.stream | sort -un); do
      tshark -r enver.pcap -o tls.keylog_file:edge-server.keys -q -z follow,tls,ascii,$s
    done > enver-decrypted.txt
    grep -c 'a value from your env file' enver-decrypted.txt
  6. Turn it off again: remove the SSLKEYLOGFILE line from /etc/enver/edge-server.env, restart the agent and delete the keys file and the capture.

The keys file and the capture together reveal everything the agent exchanged, including its token and the secrets set in Enver. Keep them only as long as you need them. On Kubernetes, the agent also sends the env file’s values to your cluster’s API server – that is expected, it is your cluster; capture only the connections to Enver if you want to see just those. On macOS, put the same line into /etc/enver/edge-server.env, use a directory your user can write to and restart with sudo launchctl kickstart -k system/com.enver.edge-server.

Updates

Every few hours the agent asks Enver whether a newer version is published. If so, it downloads it, verifies it, unpacks it next to the running one and restarts into it; your containers keep running meanwhile. The new version has to connect to Enver within 10 minutes and stay connected for half a minute, otherwise the agent goes back to the previous version and doesn’t try that version again on its own. The edge server detail shows the agent’s version and whether an update is available; Update now starts it at once (also for a version that failed before). Automatic updates in the settings turns the periodic updates off; Update now keeps working.

Installations from before self-updating show an unknown version: run the install command once more, from then on the agent updates itself. Installing a package by hand always switches to that package’s version.

Token

The token identifies the server to Enver. If it leaks, click Regenerate token on the edge server detail: the old token stops working at once and the agent disconnects. Put the new token into /etc/enver/edge-server.env and restart the agent. Deleting an edge server disconnects it too.

Logs and uninstall

Security audit

With the security audit turned on for an edge server, Enver regularly asks the agent for the host’s security state. It covers Debian 11–13 and Ubuntu 20.04 and later; other systems, macOS included, answer that they aren’t supported. Without that setting the agent refuses the request.

Access for the security audit

The agent’s user can’t read the system logs by default. Add it to two groups and restart the agent – adm reads /var/log/auth.log, systemd-journal the journal; both only read logs:

sudo usermod -aG adm,systemd-journal enver-edge-server
sudo systemctl restart enver-edge-server

Without them the report is partial and says what the agent couldn’t read. Some cloud images let only root read /etc/ssh/sshd_config.d/50-cloud-init.conf; the report then names the file, and sshd may use other values from it. An agent installed from a package older than the security audit can’t tell new sources apart: install the current package once more, which adds its state directory.

Don’t grant more than these groups: the agent never needs root for the audit, and access through Docker (for example a container with /var/log mounted) would go around the rule that the agent touches only its own containers.

Docker settings

On the edge server detail, Docker & Kubernetes settings apply within a minute without a restart:

Everything in these two directories is open to the containers on the server and to whoever may edit services, so use dedicated directories without system files, other applications' data or secrets. On macOS add /opt/enver to the folders Docker Desktop shares.

Docker publishes the services' ports on every address of the server, past a firewall such as ufw. To publish them on one address only (e.g. a private network), put DOCKER_PORTS_HOST_IP=<address> into /etc/enver/edge-server.env.

Kubernetes

An environment of the Kubernetes type runs its services on a cluster reached through the edge server. Prepare a service account with cluster-admin rights once (Kubernetes cluster setup in the app shows the same):

kubectl create serviceaccount enver-edge-server -n default
kubectl create clusterrole enver-edge-server --verb=get,list,watch,create,update,patch,delete \
  --resource=namespaces,deployments,pods,pods/log,services,secrets,ingresses,networkpolicies,persistentvolumeclaims,poddisruptionbudgets
kubectl create clusterrolebinding enver-edge-server \
  --clusterrole=enver-edge-server --serviceaccount=default:enver-edge-server
kubectl create token enver-edge-server -n default --duration=87600h
kubectl config view --minify -o jsonpath='{.clusters[0].cluster.server}'

Enter the API URL, the token and optionally the cluster’s CA certificate (PEM, or certificate-authority-data from a kubeconfig) in the edge server settings. Without a CA certificate the server's certificate is checked against the system's trusted authorities; Skip TLS verification is meant for test clusters only, since the token then goes to whoever answers at the API URL. Optionally set the ingress class (empty uses the cluster’s default IngressClass) and a cert-manager ClusterIssuer to get TLS certificates for ingress rules.

Every environment gets its own namespace, so environments can’t break each other:

Each service becomes a Deployment with a Service of the same name, so other services reach it at name:port, just like on Docker. Variables are stored in a Secret, and a changed value rolls the pods. Volumes become PersistentVolumeClaims named after the volume (1 GiB, the cluster’s default storage class). CPU and memory requests and limits apply as set.

Replicas are set per environment service. Several replicas are spread across the cluster’s nodes, updated one by one without downtime and protected by a PodDisruptionBudget. A service with volumes is replaced instead, since its claim can be mounted on one node only.

Ingress rules route a host (server name, also *.example.com) and a path prefix to one of the service’s ports. The ingress controller serves them on HTTP 80 and, with TLS, on HTTPS 443. A host and path can be routed by only one service per edge server. For other traffic, such as a database, tick Load balancer on a port: it is then published on its exposed port through a LoadBalancer Service.

When pods don’t come up (image pull, crash loop, no room on the nodes), the service shows the reason as its error.

Environments

Under Environments → New environment, set:

Start blank or Duplicate existing – every service is copied with its tag, settings, variables and groups, and starts stopped. Optionally Shift exposed ports by a number such as 1000 to move every exposed port of the copy (8080 becomes 9080). The form lists the resulting ports, refuses a shift that would hit a port already taken on the edge server or leave the range 1–65535, and offers the smallest round shift that is free. Changing the type or the name later restarts the running services (container names are derived from the environment name).

The environments page lists environments by name. The owner and members with Env Admin can change the order for the whole account: Edit environments shows every card on one page, drag them (or use the arrows) and Save order. New environments are added at the end.

Actions → Delete environment (owner and Env Admin) stops and removes all its containers and deletes the environment with its services and settings; you confirm it by typing the environment's name. Volumes and backups on the edge server stay.

Adding services

Add service picks a service from the catalog and sets for this environment its tag, index (start order), replicas, ingress rules (Kubernetes), ports, volumes, variables and variable groups. Enver warns when an exposed port is already taken on the same edge server. Docker publishes every exposed port on the host, Kubernetes only the load-balancer ports; the other Kubernetes ports stay inside the cluster. Editing a service in an environment also lets you disable it or override its command. Copy to environment… copies a single service, with its settings, into another environment; @ references are pointed at the services of the target environment.

Running services

Monitoring

Monitoring shows for each edge server the CPU, memory, swap and disk usage (with free space) and its uptime over the last 24 hours. Metrics are sent every minute and kept for 7 days.

The agent also reports how full Docker's own disk is – on Docker Desktop that is its virtual disk, not the Mac's. From 90 % the edge server and each of its Docker environments show a warning: once the disk is full, new images can't be pulled and services don't start. Free up space with e.g. docker image prune, or set Image cleanup to every unused image.

Infrastructure overview

Infrastructure is living documentation of your infrastructure. It is built from what Enver actually deploys, so unlike a wiki page or a spreadsheet of servers and ports it is never out of date. Use it to show a new colleague what runs where, to answer ops or an auditor, or to plan the next environment.

It shows the account at a glance: for each edge server the environments running on it, each service with its status, exposed ports and volumes, a table of the server's host ports with the blocks of 1000 already in use, and a table of the host paths that hold data. A port taken twice by Docker environments is marked as a collision, a host path mounted by more than one service as shared. Environments without an edge server are listed separately. It needs the Infrastructure Viewer permission and shows every environment of the account, including ones hidden from the member by a per-environment restriction. Variables are never shown there, so you can grant Infrastructure Viewer to anyone who needs the overview without giving them access to the configuration.

PostgreSQL backups

DB Backups lists every postgres service in your Docker environments. In Backup settings, set the service's backup directory inside the edge server's first backups directory (e.g. the service's name) or as an absolute path inside any of them, turn on the daily automatic backup and how many backups to keep (older ones are deleted after each new backup). You can also Create backup at any time, Restore one (the current data is replaced 1:1) or delete it.

Backups are made with pg_dump inside the container and stored only on the edge server, never at Enver. Keep a copy elsewhere, too – a backup on the same machine does not survive losing its disk.

Notifications

Enver can send a push notification to your browser or phone when a service starts running a new image – a different tag, or a new build pushed under the same tag.

  1. In User settings → Notifications, click Enable on this device (once per browser or phone) and optionally limit the time range in your time zone. Notifications outside it are dropped.
  2. On the environment detail, choose for a service Notify once or Notify on every change.

With the security audit in your plan, Critical security findings on the same page adds a push when an edge server’s audit finds something critical.

Notifications are part of the PRO and Business packages or available as an add-on.

Plans and billing

The account’s plan is under Account → Plan and payments, your own billing (verification, extra accounts, all subscriptions you pay) under User settings → Subscriptions and payments. Prices are in EUR per month; yearly billing is 20 % cheaper.

FREEFREE VerifiedPRO – €10Business – €80
Environments12622
Services510unlimitedunlimited
Edge servers12622
Users1515105
Notifications––✓✓
Security audit–––✓

Add-ons raise single limits: extra environment €4, extra edge server €3, extra user €1, unlimited services €5, notifications €2, security audit €5 and an extra owned account €5 per month. For larger needs, ask for Enterprise in the app.

When you hit a limit, Enver shows what to raise instead of failing. Full terms are in the Terms of Service.

Maintenance and feedback

Planned maintenance is announced under the header at least 2 hours ahead. During it the app shows a maintenance page and reloads itself when it’s over; your environments keep running. Found a bug or have an idea? Use Send feedback in the header – every message goes straight to the Enver team.