Getting Started


Hardware Requirements

Our software uses containerization and has the same hardware requirements as Docker:

Minimum Requirements

  • A 64-bit processor
  • 4GB of RAM
  • 10GB free disk space

Recommended Requirements

  • A modern multi-core processor
  • 8GB of RAM or more
  • 20GB free SSD disk space

Supported Architectures

  • x86_64/amd64
  • arm64

OS Requirements

Ubuntu 18.04 LTS or higher is recommended. However other major Linux distribution are supported but may lead to installation issues. Please file an issue if you encounter one.

If Docker is already installed on your machine, Tipi will use it to run the dashboard. Otherwise, it will install Docker for you.


If you already have docker installed make sure to have the docker compose plugin installed.
Run docker compose version to check if it is installed. Instructions to install it can be found here (opens in a new tab).

Download and install Tipi

Download the latest version of Tipi:

curl -L | bash

If you have some issue with the command above, you can also download the script directly from github:

curl -L | bash

The script will prompt you the ip address of the dashboard once configured.


If you already installed Tipi, you can start it manually by running the runtipi-cli located in the runtipi folder.

cd runtipi
./runtipi-cli start

Tipi is asking for the sudo password in order to give certain file permissions to the user running the dashboard. If for some reason you don't want to give the sudo password, you can run the script with the --no-permissions flag.

./runtipi-cli start --no-permissions

Tipi will run by default on port 80. To select another port you can create a settings.json file in the state folder. See the Custom Settings section for more information.

To stop Tipi, run the stop script.

./runtipi-cli stop

Update Tipi

To update Tipi to the latest version, run the update script.

./runtipi-cli update

Or you can specify a version to update to:

./runtipi-cli update v1.6.0

You can downgrade Tipi to a previous version by running the update script with the version you want to downgrade to. However, this is highly discouraged as it may lead to break your install