This is the documentation of an pre-release opsi version. The documentation for the current version 4.3 can be found here.

Server Installation (Docker)

Read on to learn how to set up an opsi server using Docker. For detailed information on other installation methods, please refer to the chapter Installation and Setup.

opsi as Docker Container

Since 2022, a Docker image has been available, enabling you to establish either an opsi config server or an opsi depot server. This setup utilizes Docker Compose, an orchestration tool that lets you define, interconnect, and execute multiple containers on a Docker host. To use this, you need Docker Compose version 1.17.0 or later and Docker Engine 17.09.0 or newer.

Please note that exclusively WebDAV is used as the protocol for communication with the opsi depot in this setup; there is no Samba support in this variant.

Docker Installation

Install Docker or Docker Desktop on Linux, Windows, or macOS:

On Linux, you can also work directly with the Docker Engine. Simply install the relevant packages for your Linux distribution.

To check that the installation was successful, run the following command in the terminal:

docker run --rm hello-world
By default, the docker command requires root privileges, meaning that working with our helper scripts also requires root privileges. You can either prefix the commands shown in this chapter with sudo, or you can add a user account to the docker group. For more information, see the Docker manual, chapter Linux post-installation steps for Docker Engine.

You should expect to see an output similar to this:

Hello from Docker!
This message shows that your installation appears to be working correctly.
[...]

Quick Start

A helper script is provided for straightforward setup and management of an opsi Docker environment.

Docker experts can ignore the helper script and access all information directly in our GitHub repository at opsi-docker.

Windows

On Windows systems, follow these steps:

  1. Create an opsi-server folder.

  2. Download the script from opsi-server.ps1 and save it in the opsi-server folder.

  3. Open PowerShell with administrator privileges.

  4. Run the following command in the terminal window: PowerShell.exe -ExecutionPolicy Bypass

  5. Navigate to the opsi-server folder using the command cd.

  6. Execute the script by typing .\opsi-server.ps1 start.

Linux and macOS

On Linux and macOS, follow these steps:

To set up under Linux, follow these steps:

  1. Create an opsi-server folder.

  2. Download the script from opsi-server.sh and place it in the opsi-server folder.

  3. Open a terminal with root privileges.

  4. Navigate to the opsi-server folder using cd.

  5. Make the script executable: chmod +x opsi-server.sh

  6. Execute the script with the command ./opsi-server.sh start.

This process will automatically download the required Docker images and start the containers.

  • Use .\opsi-server.ps1 status or ./opsi-server.sh status to check the status of the containers.

  • View the container logs with .\opsi-server.ps1 logs or ./opsi-server.sh logs.

  • Update the containers to the latest versions using .\opsi-server.ps1 upgrade or ./opsi-server.sh upgrade.

There is now a file docker-compose.yml in the opsi-server folder. Open this file with a text editor and look for the environment variable OPSI_ADMIN_PASSWORD. You will need the specified password for logging into the opsi server as the opsiadmin user in subsequent steps.
We strongly recommend changing this password for security reasons.

If you modify the docker-compose.yml file, restart the containers to apply the changes. Do this by entering .\opsi-server.ps1 recreate or ./opsi-server.sh recreate.

For more details on Docker, the helper scripts, and the docker-compose.yml file, refer to the chapter opsi as Docker Container. Following this, you can proceed to download and launch the user interface opsi-configed.