OliveTin documentation

Linux package install (.rpm/.deb)

Running OliveTin as a systemd service on a Linux machine means it can use any program installed on your machine (you don’t have to add programs to a container). This is generally easier to use than a container, but containers can work just fine too with a bit more effort.

Choosing the right Linux package

There are .deb, .rpm, and similar packages published for OliveTin on each release page. Pick a package most relevant to the Linux distribution you are using from the downloads page.

If you’re not sure which package to use, see which download do I need?

You can install these packages with your Linux package manager (eg, dpkg -i OliveTin…deb or rpm -U OliveTin…rpm).

Post installation

You will need to write a basic configuration file before OliveTin will startup.

Create the following basic config file at /etc/OliveTin/config.yaml with the following contents;

The most simple config.yaml file.

actions:
  - title: "Hello world!"
    shell: echo 'Hello World!'

Now that you have a configuration file, and OliveTin is installed, start it;

Start the service (only needed once)

user@host: systemctl enable --now OliveTin

If you are running a firewall on your server, like firewalld, you will need to open port 1337;

user@host: firewall-cmd --add-port 1337/tcp --permanent
user@host: firewall-cmd --reload

You should be able to browse to http://yourserver:1337 (or similar) to get to the web interface.

If you see the OliveTin page popup in your browser, you can jump to the configuration section as the next step.

Troubleshooting systemd installations

If you are having problems, you can check if OliveTin is running like this;

user@host: systemctl status OliveTin

If the service has failed, scroll through the logs;

user@host: journalctl -eu OliveTin

If you cannot understand the logs, or otherwise need help, see the Where to find help page.