Running locally

In this guide we will show you how to run Runtipi locally on your machine. This is useful if you want to contribute to the project or if you want to test new apps you added to the appstore.

Prerequisites

Docker desktop version 28 or later. Instructions: Install Docker Engine
Docker Compose plugin (docker compose)
Node.js 22+
Bun 1.3+

Prepare

Once you have forked the repository and cloned it on your local machine you can start to prepare the environment.

Install dependencies

runtipi uses bun workspaces for dependency management.

Install the project dependencies bun install

Edit the environment variables

You need to copy .env.example to .env

Run runtipi

Start the development stack with bun run start:dev from the repository root
Visit http://localhost:3000 in your browser