📃 Table of Contents

📃 Table of Contents
🚀 Getting Started
💖 Contributing

🚀 Getting Started

ℹ️ About

Homarr is a simple and lightweight homepage for your server, that helps you easily access all of your services in one place.

⤴️ Back to Top

🐛 Known Issues

Application cards not responsive https://github.com/ajnart/homarr/issues/47
Icon alignment out for specific icons https://github.com/ajnart/homarr/issues/82

⚡ Installation

Deploying from Docker Image 🐳

Supported architectures: x86-64, ARM, ARM64

Requirements:

Docker

Standard Docker Install

docker run --name homarr -p 7575:7575 -v /data/docker/homarr:/app/data/configs -d ghcr.io/ajnart/homarr:latest

Docker Compose

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

Getting EACCESS errors in the logs? Try running sudo chmod 775 /directory-you-mounted-to!

Building from Source 🛠️

Requirements:

Git
NodeJS (Latest or LTS)
Yarn

Installing

Clone the GitHub repo: git clone https://github.com/ajnart/homarr.git & cd homarr
Install all dependencies: yarn install
Build the source: yarn build
Start the NextJS web server: yarn start
Note: If you want to update the code in real time, launch with yarn dev

💖 Contributing

Please read our Contribution Guidelines

All contributions are highly appreciated.