Official releases

Install slopscale from the signed apt repository on Debian and Ubuntu, or from a standalone Linux binary with your own user and systemd service.

Official releases for slopscale are available as binaries for various platforms and DEB packages for Debian and Ubuntu. Both are available on the GitHub releases page.

Using packages for Debian/Ubuntu (recommended)

It is recommended to use our DEB packages to install slopscale on a Debian based system as those packages configure a local user to run slopscale, provide a default configuration and ship with a systemd service file. Supported distributions are Ubuntu 22.04 or newer, Debian 12 or newer.

1. Add the slopscale apt repository. Every release carries a signed apt index next to its packages, and the source below follows the latest release, so apt upgrade brings each new version:

   sudo curl -fsSLo /usr/share/keyrings/slopscale-archive-keyring.gpg \
     https://github.com/aislopware/slopscale/releases/latest/download/slopscale-archive-keyring.gpg
   echo "deb [signed-by=/usr/share/keyrings/slopscale-archive-keyring.gpg] https://github.com/aislopware/slopscale/releases/latest/download ./" |
     sudo tee /etc/apt/sources.list.d/slopscale.list

   The index is signed by the key with fingerprint 4794 9BAF CFFE 9FC0 38C9 1CA4 7CCC 320C F713 D772, which is also in the repository as packaging/apt/slopscale-archive-keyring.gpg.

2. Install slopscale:

   sudo apt update
   sudo apt install slopscale

   The repository lists only the latest release. To install another version, download its .deb from the releases page and install it with sudo apt install ./slopscale_X.Y.Z_linux_amd64.deb.

3. Configure slopscale by editing the configuration file. An up-to date example configuration file is also available in /usr/share/doc/slopscale/examples/config-example.yaml:

   sudo nano /etc/slopscale/config.yaml

4. Restart slopscale to pick up configuration changes:

   sudo systemctl restart slopscale

5. Verify that slopscale is running as intended:

   sudo systemctl status slopscale

Continue on the getting started page to register your first machine.

Using standalone binaries (advanced)

This section describes the installation of slopscale according to the Requirements and assumptions. Slopscale is run by a dedicated local user and the service itself is managed by systemd.

1. Download the latest slopscale binary from GitHub’s release page:

   sudo wget --output-document=/usr/bin/slopscale \
   https://github.com/aislopware/slopscale/releases/download/v<SLOPSCALE VERSION>/slopscale_<SLOPSCALE VERSION>_linux_<ARCH>

2. Make slopscale executable:

   sudo chmod +x /usr/bin/slopscale

3. Add a dedicated local user to run slopscale:

   sudo useradd \
    --create-home \
    --home-dir /var/lib/slopscale/ \
    --system \
    --user-group \
    --shell /usr/sbin/nologin \
    slopscale

4. Download the example configuration for your chosen version and save it as: /etc/slopscale/config.yaml. Adjust the configuration to suit your local environment. See Configuration for details.

   sudo mkdir -p /etc/slopscale
   sudo nano /etc/slopscale/config.yaml

5. Copy slopscale’s systemd service file to /etc/systemd/system/slopscale.service and adjust it to suit your local setup. The following parameters likely need to be modified: ExecStart, WorkingDirectory, ReadWritePaths.

6. In /etc/slopscale/config.yaml, override the default slopscale unix socket with a path that is writable by the slopscale user or group:

   unix_socket: /var/run/slopscale/slopscale.sock

7. Reload systemd to load the new configuration file:

   systemctl daemon-reload

8. Enable and start the new slopscale service:

   systemctl enable --now slopscale

9. Verify that slopscale is running as intended:

   systemctl status slopscale

Continue on the getting started page to register your first machine.