Home Discord YouTube Disclaimer

Homarr

Customizable browser's home page to interact with your homeserver's Docker containers (e.g. Sonarr/Radarr)

Please read our disclaimer https://docs.ibracorp.io/#disclaimer.

Feature List

  • Integrates with services you use

  • Search the web directly from your homepage

  • Real-time status indicator for every service

  • Automatically finds icons while you type the name of a service

  • Widgets that can display all types of information, from current downloads to meteo and even the state of Docker containers

  • Easy deployment with Docker

  • Very light-weight and fast

  • Free and Open-Source

  • And more...

Installation

Unraid

  1. Head to the Community Applications store in Unraid

  2. Search for and click to install Homarr

  3. If you are using a custom Docker network, select it in the 'Network Type' field.

  4. Enter the host port you want to map for the WebUI. By default it is 7575. Only change it if this port is already in use.

  5. Click Apply and wait for the container to pull down and start.

  6. In your Docker tab in Unraid, left-click the Homarr container and select 'WebUI'.

Docker Compose

1. Create a new folder as home for Homarr and change into it:

mkdir -p /opt/appdata/homarr && cd /opt/appdata/homarr

2. Create the Docker Compose file:

nano docker-compose.yml

3. Copy the following block into the editor, save and exit the editor:

---
version: '3'
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
      - /var/run/docker.sock:/var/run/docker.sock:ro
    ports:
      - '7575:7575'

4. Start the Docker Container to pull it down and launch it for the first time:

docker compose up -d

5. Open up the web page (replace serverip with the IP address where you installed Homarr)

http://serverip:7575

Other Installation Types

Check the GitHub page (linked under Useful Links) for Docker instructions or building Homarr from Source.

Configuration

You should now be on the dashboard screen for Homarr

  1. Select the Settings icon in the top-right of the screen

2. In the settings panel, you have full control of various features of the app.

Select any of the options that you like. Enabling modules such as Docker will allow you to access a dashboard for monitoring those containers.

You can also save and upload your config for safe keeping or moving to another instance.

You can also enable the Dark Theme here!

Docker Services

If you enabled the Docker service above, you can easily add those services to Homarr.

In the top-right of the window, select the Docker logo.

Here you'll find some functionality like controls for the Docker containers (similar to what Portainer can offer) as well as the option to "Add to Homarr"

Once you choose to add to Homarr a window will appear. See below.

Adding Services to Homarr

Adding services and apps could not be easier. Regardless of using the Docker option above or simply selecting "Add a Service" in the top-right of the screen, you will be presented with a configuration screen.

On this screen, you'll see various options. If using the Docker service to add to Homarr, some fields may be pre-filled depending on the application.

This is extremely useful as some apps being supported natively (such as Sonarr, Radarr & more) will be able to communicate with Homarr directly.

If it is not a supported pre-filled application you can still add it and fill in the information manually.

The next tab over is 'Advanced Options' - this is useful to allow you to configure status codes so that Homarr can correctly report the status of your pages. For example:

Dashboard

Continue to customize your dashboard until you're satisfied and you're done!

Words from the Developer

Thank you so much for taking the time to consider my app! This is my first ever "real" project and the reactions and help I've gotten have made me love open source even more.

Thank you for being a part of this journey. I still have a long way to go until Homarr reaches the potential I believe it can achieve. For that, I will need all the support that I can get so if you have suggestions, knowledge, money, or love that you want to share, feel free to reach out! - ajnart

Special Thanks

  • Homarr developer ajnart for his input and guidance.

  • To our fantastic Discord community and our Admins Sycotix and Hawksy for their input and documentation (as always).

Final Words

We hope you enjoyed this guide. It was conceptualized, written, and implemented by our Admin DiscDuck.

Support Us

Our work sometimes takes months to research and develop. If you want to help support us please consider:

Thank you for being part of our community!

Last updated