---
title: "Official releases"
description: "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](https://github.com/aislopware/slopscale/releases).

## 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:

    ```shell
    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`.

1. Install slopscale:

    ```shell
    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](https://github.com/aislopware/slopscale/releases) and install it with
    `sudo apt install ./slopscale_X.Y.Z_linux_amd64.deb`.

1. [Configure slopscale by editing the configuration file](/slopscale/ref/configuration). An up-to date example
   configuration file is also available in `/usr/share/doc/slopscale/examples/config-example.yaml`:

    ```shell
    sudo nano /etc/slopscale/config.yaml
    ```

1. Restart slopscale to pick up configuration changes:

    ```shell
    sudo systemctl restart slopscale
    ```

1. Verify that slopscale is running as intended:

    ```shell
    sudo systemctl status slopscale
    ```

Continue on the [getting started page](/slopscale/usage/getting-started) to register your first machine.

## Using standalone binaries (advanced)

:::warning[Advanced]

This installation method is considered advanced as one needs to take care of the local user and the systemd
service themselves. If possible, use the [DEB packages](#using-packages-for-debianubuntu-recommended) instead.
:::

This section describes the installation of slopscale according to the [Requirements and
assumptions](/setup/requirements#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](https://github.com/aislopware/slopscale/releases):

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

1. Make `slopscale` executable:

    ```shell
    sudo chmod +x /usr/bin/slopscale
    ```

1. Add a dedicated local user to run slopscale:

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

1. 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](/slopscale/ref/configuration) for details.

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

1. Copy [slopscale's systemd service file](https://github.com/aislopware/slopscale/blob/main/packaging/systemd/slopscale.service)
   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`.

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

    ```yaml title="config.yaml"
    unix_socket: /var/run/slopscale/slopscale.sock
    ```

1. Reload systemd to load the new configuration file:

    ```shell
    systemctl daemon-reload
    ```

1. Enable and start the new slopscale service:

    ```shell
    systemctl enable --now slopscale
    ```

1. Verify that slopscale is running as intended:

    ```shell
    systemctl status slopscale
    ```

Continue on the [getting started page](/slopscale/usage/getting-started) to register your first machine.