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
• Node version 22+

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 pnpm as a package manager and monorepo orchestrator. Install it with npm i -g pnpm

Install the project dependencies pnpm i

Edit the environment variables

You need to copy .env.example to .env

Run runtipi

1. Start the app with npm run start:dev from the root folder
2. Visit localhost:3000 in your browser