Homarr

A homepage for your server.
Demo ↗️ • Install ➡️

📃 Table of Contents

• 📃 Table of Contents
• 🚀 Getting Started
  • ℹ️ About
  • ⚡ Installation
    • Deploying from Docker Image 🐳
    • Building from Source 🛠️
• 💖 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

⚡ Installation

Deploying from Docker Image 🐳

Supported architectures: x86-64, ARM, ARM64

Requirements:

• Docker

Standard Docker Install

docker run --name homarr -p 7575:80 -d ghcr.io/ajnart/homarr

Docker Compose

---
version: '3'
#--------------------------------------------------------------------------------------------#
#                               Homarr -  A homepage for your server.                        #
#--------------------------------------------------------------------------------------------#
services:
  homarr:
    container_name: homarr
    image: ghcr.io/ajnart/homarr
    restart: unless-stopped
    ports:
      - '7575:80'

Building from Source 🛠️

Requirements:

• Git
• NodeJS (Latest or LTS)
• Yarn
• Some web server

Installing

• Clone the GitHub repo: git clone https://github.com/ajnart/homarr.git & cd homarr
• Install all dependencies: yarn install
• Build the source: yarn export
• Start a web server (Any web server will work):
  • Examples:
    • NodeJS serve: npm i -g serve or yarn global add serve & serve ./out
    • python http.server: python -m http.server 7474 --directory out

⤴️ Back to Top

💖 Contributing

You can contribute by Starting a discussion, Submitting Bugs, Requesting Features, or Making a pull request!

All contributions are highly appreciated.

⤴️ Back to Top