Skip to main content

🚀 Installation

Homarr can be installed in many ways. For most users, Installation using Docker will be sufficient and the easiest.

🐋 Installation using Docker​

Docker is a free Software that isolates Homarr using containers. Using Docker, you can run Homarr on any supported plattform (including Windows and Raspberry Pi), easily.

Prerequisites​

Installation​

To install Homarr using Docker, simply run the following command.

docker run  \
  --name homarr \
  --restart unless-stopped \
  -p 7575:7575 \
  -v <your-path>/homarr/configs:/app/data/configs \
  -v <your-path>/homarr/icons:/app/public/icons \
  -d ghcr.io/ajnart/homarr:latest
note

Docker will mount the configuration files and icons to your host machine. Please make sure to replace <your-path> from the docker run command with your desired storage location. The path must be absolute.

Updating​

To update Homarr, you must remove your container first. Make sure that you've mounted your data and that you have access to it, so your configuration doesn't get lost.

  1. Run docker rm homarr to remove the container.
  2. Pull the latest Homarr image docker pull ghcr.io/ajnart/homarr:latest.
  3. Re-run the command you used to install Homarr.

This process can get tideous, if you update frequently. Thus, we recommend the installation using docker-compose for more experienced users.

tip

Want to update all your containers automatically? Checkout Watchtower a service which will automatically update your containers on a set interval.

🐋 Installation using Docker Compose or Portainer Stacks​

Prerequisites​

Installing​

To install Homarr using Docker Compose, simply create a file called docker-compose.yml and paste the following code into it.

docker-compose.yml
version: '3'
#---------------------------------------------------------------------#
#     Homarr - A modern and lightweight homepage for your server.     #
#---------------------------------------------------------------------#
services:
  homarr:
    container_name: homarr
    image: ghcr.io/ajnart/homarr:latest
    restart: unless-stopped
    volumes:
      - ./homarr/configs:/app/data/configs
      - ./homarr/icons:/app/public/icons
    ports:
      - '7575:7575'

Then, run docker-compose up -d in the same directory. This will start the Homarr container in the background.

Updating​

To update Homarr using Docker Compose or Portainer Stacks, simply pull the latest image and restart the container.

  1. Run docker pull ghcr.io/ajnart/homarr:latest to pull the latest image.
  2. Re-run docker-compose up -d or re-deploy the stack in Portainer.

🛒 Install from the Unraid Community App Store​

You can install Unraid without docker run and docker-compose, directly from your Unraid Web Dashboard.

Install the Comunity Apps Plugin​

First, you need to install the Community Apps Plugin, if you haven't already done so.

Open Installation Guide

tip

If you're unsure whether you have the plugin installed or not, search for this tab in the navigation:

Install Homarr from the Community Apps​

Next, click on Apps, wait until the page has fully loaded and then search for Homarr in the search box.

Click on Install and adjust the settings to your liking. After you click submit, Unraid will automatically start the installation. You can find Homarr under the tab "Docker" afterwards.

💻 Building from source​

tip

Installing from source is not recommended, if you don't know what you're doing and/or are not planning to make changes to the source code, please install Homarr using Docker.

  • Clone the Repository using git clone https://github.com/ajnart/homarr.git
  • Enter the created directory using cd homarr
  • Install all dependencies using yarn install
  • Build the source using yarn build
  • Start the NextJS web server using yarn start
  • Alternatively, use yarn dev to run a live development server.

Troubleshooting your Installation​

If you are having trouble getting Homarr to install properly on your system, check out our FAQ page. When you are still not able to get Homarr up and running, contact us on our official Discord