Archiving this repo. The initial motivation for this was that I wanted a simple dashboard that's easy to add hosts to monitor. I was planning on extending it, but found that Homarr, does everything I want and is still has a pretty lean dashboard. I will use my time to contribute to homarr if need be.

Hommy

A minimalist dashboard for your homelab.

Introduction

Yes, yet another dashboard. However, this one is built with simplicity and functionality in mind, tailored for personal use. I created Hommy to aggregate my services, providing a way to filter by tags, categories, and perform fuzzy searches. Existing solutions didn't meet these specific needs, so I developed Hommy and decided to share it with the community.

While there are many capable dashboards available, such as those listed on the Awesome Self Hosted GitHub page, Hommy stands out with its minimalist design and limited configuration options.

This dashboard is designed to run on LXC containers or a local machine, as I prefer LXCs over Docker containers.

Example

Installation

To install Hommy, follow these steps:

Prerequisite

1. Python
2. Python-pip
3. Python-venv
4. Git

Steps

1. Clone this repository or download the archive from GitHub:

   git clone https://github.com/avezou/hommy.git

2. Change to the cloned hommy directory.

3. Copy the .env.example file to .env and update the secret key value:

   SECRET_KEY=super_secret_hard_to_guess_or_crack_key_here
   UPLOAD_PATH='static/uploads'
   ALLOWED_EXTENSIONS=set(['png', 'jpg', 'jpeg', 'svg', 'gif'])

4. Make the start.sh script executable:

   chmod +x start.sh

5. Start the application:

   ./start.sh

The application will be available at http://localhost_or_ip:8000.

Running with Systemd

To run Hommy using systemd, create a hommy.service file or copy the provided one to the appropriate location:

• Copy hommy.service to:

  /etc/systemd/system/hommy.service

  or

  /lib/systemd/system/hommy.service

• Modify the paths in the service file to match your Hommy installation:

  [Unit]
  Description=Hommy homelab dashboard
  After=network.target
  
  [Service]
  WorkingDirectory=/path_to_hommy_root_dir
  Environment=FLASK_CONFIG=production
  ExecStart=/path_to_hommy_dir/env/bin/gunicorn -w $(nproc) --threads 2 --max-requests 2 app:app
  Restart=always
  
  [Install]
  WantedBy=multi-user.target

To manage Hommy with systemd, use the following commands:

sudo systemctl start hommy   # to start it
sudo systemctl stop hommy    # to stop it
sudo systemctl enable hommy  # to enable hommy to start on boot

TODO

• Move some of the hardcoded values to environment variables for easier customization.
• Add Docker and Docker Compose installation options.
• Add error pages templates

Contributing

Feel free to fork this repository, build on top of it, or create pull requests.

Credits

Background Photo by Abdullah Ghatasheh: Pexels

SVG icons copied from: https://github.com/simple-icons/simple-icons

License

Hommy is licensed under the MIT License. See the LICENSE file for more details.