Skip to main content

(Not recommended): From source

caution

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.

  1. Clone the Repository using git clone https://github.com/ajnart/homarr.git
  2. Enter the created directory using cd homarr
  3. Install all dependencies using yarn install
  4. Copy the example.env file to .env
  5. Build the source using yarn build
  6. Run yarn db:migrate and wait that it completes
  7. Start the NextJS web server using yarn start
  8. Alternatively, use yarn dev to run a live development server.