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 or newer
pnpm at the version pinned in the repository's package.json
Redis

Steps

Clone the Repository using git clone https://github.com/homarr-labs/homarr.git
Enter the created directory using cd homarr
Install all dependencies using pnpm install
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.
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.
Run pnpm run db:migration:sqlite:run and wait that it completes
Build the source using pnpm build
Copy better-sqlite3.node files with mkdir build and cp ./node_modules/better-sqlite3/build/Release/better_sqlite3.node ./build/better_sqlite3.node
Start a redis server using redis-server
Run the server using pnpm start
Open http://localhost:3000 in your browser

Prerequisites

Steps

On this page