.tar.gz Install (manual)

Installing OliveTin from a .tar.gz file is considered advanced setup, and is provided for users who cannot use the .deb or .rpm packages, or who don’t want to use the Linux container.

Manual setup (.tar.gz)

  1. Copy the OliveTin binary to /usr/local/bin/OliveTin

    1. Make sure it is executable: chmod +x /usr/local/bin/OliveTin

  2. Make a directory for the configuration files: mkdir -p /etc/OliveTin

    1. Copy the config.yaml file to /etc/OliveTin/

  3. Copy the webui directory contents to /var/www/olivetin/ (eg, /var/www/olivetin/index.html)

  4. Copy the OliveTin.service file to /etc/systemd/system/

  5. Files in the var directory are all considered optional.

    1. var/entities/ contains some example entity files used by the default config.yaml. You can copy these to /etc/OliveTin/entities/ if you want to use them.

    2. var/helper-actions/ contains some helpers that are mostly useful for containers. These should be copied to somewhere on your path if you want to use them, such as /usr/local/bin/.

    3. var/initscript/OliveTin is provided for init-based systems. You can copy this to /etc/init.d/OliveTin and make it executable if you want to use it.

    4. var/manpage/OliveTin.1.gz contains the manpage for OliveTin. You can copy this to /usr/share/man/man1/ if you want to use it.

    5. var/marketing contains some marketing materials used by the repository. You can probably ignore these unless you’re writing a blog article or something.

    6. var/openrc/OliveTin is provided for OpenRC-based systems. You can copy this to /etc/init.d/OliveTin and make it executable if you want to use it.

    7. var/tekton is a directory that contains an experimental Tekton base image builder. You don’t need this.

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 are good to go! Here are some helpful next steps;

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 [support] page.