Skip to main content

Quick start: Linux, without Docker

Delegaris also comes as a native Linux package: one download with its own copy of Python inside, installed as a systemd service. It is the same product as the Docker image, with the same features and settings. Choose it when you would rather not run Docker on the server.

Supported systems​

DistributionVersions
Ubuntu22.04 and 24.04
Debian12
Red Hat Enterprise Linux, Rocky Linux, AlmaLinux9
Amazon Linux2023

On x86_64 (Intel and AMD) or arm64 (AWS Graviton and the like). The server needs about 1 GB of memory, 1 GB of disk, and to reach AWS over HTTPS. Nothing else needs installing: Python and every library come in the package.

Install​

Run this as a user who can use sudo:

curl -fsSL https://github.com/Goodhall-Solutions/delegaris/releases/latest/download/install.sh | sudo bash

When it finishes, it prints the address to open and a generated password for the local administrator (user name admin). That password is shown once; it is also kept in the settings file.

To pass options, put them after bash -s --:

curl -fsSL https://github.com/Goodhall-Solutions/delegaris/releases/latest/download/install.sh \
| sudo bash -s -- --public-url https://delegaris.corp.example --listen 127.0.0.1
OptionWhat it does
--public-url URLThe address people will use. Default http://<this server's name>:8080. With a reverse proxy, give the proxy's https:// address.
--listen ADDR0.0.0.0 (every interface, the default) or 127.0.0.1 (this server only, behind a proxy).
--port NThe port to listen on. Default 8080.
--version X.Y.ZInstall a particular release instead of the latest.
--file PATHInstall from a package you downloaded yourself, for a server with no internet access.
--no-startInstall, but leave the service stopped.

The first three only apply to a first install; after that, change them in the settings file.

Reading the installer first

To see what it does before running it, download it and read it: curl -fsSLO https://github.com/Goodhall-Solutions/delegaris/releases/latest/download/install.sh, then sudo bash install.sh. The package itself is checked against a SHA-256 checksum published with each release before anything is installed.

Without internet access on the server​

Download delegaris-linux-x86_64.tar.gz (or -aarch64), its .sha256 file and install.sh from the releases page, copy them to the server, and run:

sudo bash install.sh --file delegaris-linux-x86_64.tar.gz

What the installer does​

WhatWhere
The program, with its own Python/opt/delegaris/releases/<version>, with /opt/delegaris/current pointing at the one in use
Settings/etc/delegaris/delegaris.env, readable by root and the service only
Database, backups/var/lib/delegaris
The servicedelegaris.service (systemd), running as the delegaris user, started at boot
The delegaris command/usr/bin/delegaris (a link to the current release)
The uninstaller/opt/delegaris/uninstall.sh

The service runs as an unprivileged system user with systemd's protections switched on: it can write only to /var/lib/delegaris, cannot gain privileges, and sees a read-only system. On RHEL, Rocky and Alma, the installer labels the bundled programs for SELinux so systemd may start them.

Without systemd​

On a server without systemd (some containers and minimal systems), the installer installs everything else but cannot set Delegaris up as a service. It says so, and prints the command to start it, which reads /etc/delegaris/delegaris.env itself:

sudo -u delegaris /usr/bin/delegaris serve

Start it that way, or from whatever runs services on that server. The systemctl and journalctl commands on this page do not apply there: to restart after changing a setting, stop it and start it again the same way.

The settings file is written once, on the first install, with a random local administrator password and a random ENCRYPTION_KEY (which encrypts the secrets kept in the database). Installing again never overwrites it.

Keep the encryption key

Copy ENCRYPTION_KEY from /etc/delegaris/delegaris.env somewhere safe, with your backups. A database restored onto another server cannot use its stored secrets (account keys, the directory password) without it.

First sign-in​

Open the address the installer printed and sign in as admin with the password it showed. Then work through the Getting Started Checklist: give Delegaris access to AWS, set up sign-in, and add access rules.

If the page does not load from another machine:

  • firewalld (RHEL, Rocky, Alma): sudo firewall-cmd --permanent --add-port=8080/tcp && sudo firewall-cmd --reload
  • ufw (Ubuntu): sudo ufw allow 8080/tcp
  • On EC2: allow the port in the instance's security group.

For anything beyond a first look, put it behind HTTPS: see Behind a reverse proxy (install with --listen 127.0.0.1).

Settings​

Edit /etc/delegaris/delegaris.env, then restart:

sudo nano /etc/delegaris/delegaris.env
sudo systemctl restart delegaris

Every setting is the same as for Docker: see Configuration. Most things (sign-in, notifications, schedules) are easier to set in the web UI under Settings.

On EC2, give the instance an IAM role (iam/hub-role.yaml) and Delegaris uses it directly: there is no container in between, so the hop-limit change Docker needs is not needed here.

The delegaris command​

CommandWhat it does
delegaris versionThe installed version
delegaris statusWhether the service is running
sudo delegaris healthExits 0 if the service answers
delegaris logsFollows the service log (the same as journalctl -u delegaris -f)
sudo delegaris mfa reset NAMETakes away NAME's two-step sign-in, so they set it up again at their next sign-in (for example the local admin)

If you are locked out, see Local administrator; restoring a backup is covered in Backups and health.

Upgrading​

Run the installer again:

curl -fsSL https://github.com/Goodhall-Solutions/delegaris/releases/latest/download/install.sh | sudo bash

It backs the database up to /var/lib/delegaris/backups/before-<version>-<time>.db, puts the new version beside the old one, switches /opt/delegaris/current over and restarts the service. Settings and data are kept. The previous two versions stay in /opt/delegaris/releases; see Upgrading for going back.

Removing it​

See Uninstalling.