Homarr
Getting startedInstallation

From source

Installing from source is a bad idea in many ways:

  • No isolation between applications
  • Dependency conflicts on your root operating system
  • Cumbersome update process
  • Permission management
  • Handling of conflicts

Therefore, we highly discourage you from using this as a normal user. This method is only useful, when you want to develop on Homarr or extend it with your own functionality.

Prerequisites

  • Node.js 24.18.0 for the application runtime
  • Bun 1.4.2 (the version pinned in mise.toml)
  • Redis

Steps

  1. Clone the Repository using git clone https://github.com/homarr-labs/homarr.git

  2. Enter the created directory using cd homarr

  3. Install all dependencies using bun install

  4. Copy .env.example to .env and set DB_URL to an absolute writable path, such as DB_URL='/home/username/homarr/db.sqlite'. Migration and application commands run from different workspace directories, so a relative path can point them at different databases.

  5. Run openssl rand -hex 32 twice and set AUTH_SECRET and SECRET_ENCRYPTION_KEY to the two different generated values. Keep both values secret and preserve SECRET_ENCRYPTION_KEY with your backups.

  6. Run bun run db:migration:sqlite:run and wait that it completes
  7. Build the source using bun run build
  8. Start a redis server using redis-server
  9. Run the server using bun run start
  10. Open http://localhost:3000 in your browser
Edit this page

Helm

Previous Page

After the installation

Complete onboarding and configure your first board.

On this page

PrerequisitesSteps