In the realm of homelabs, managing and monitoring services can be a daunting task. With a myriad of services running, from home automation to media servers, keeping track of everything can be overwhelming. This is where Homepage-lite steps in, offering a sleek, lightweight, and powerful solution to streamline your homelab management.
What is Homepage-lite?
Homepage-lite is a modern, Go-powered dashboard designed to help you manage and monitor your homelab services and bookmarks with ease. Built with real-time updates and a responsive UI, it ensures that you always have the latest information at your fingertips. Created by jkerdreux-imt, this tool has quickly gained traction among homelab enthusiasts for its simplicity and effectiveness.
Why It's Trending
- Lightweight: A single 9MB binary with a low memory footprint of ~25MB RAM.
- Real-time Updates: Utilizes Server-Sent Events for instant status checks and metric updates.
- Modern UI: Responsive design with multiple themes and mobile optimization.
- Extensive Features: From service monitoring to bookmark management, it covers all your needs.
Key Features
Service Monitoring
- Real-time Status Checks: Automatically refreshes every 30 seconds to keep you informed.
- Visual Indicators: Clear UP/DOWN status indicators for each service.
- Icon Support: Choose from Iconify icons or upload custom PNG icons.
Bookmark Management
- Organized Groups: Categorize your bookmarks for easy access.
- Custom Abbreviations: Quickly navigate using custom abbreviations.
- Flexible Layout: Choose between sidebar or bottom layout.
System Metrics
- CPU Load: Monitor CPU usage in real-time.
- Memory Usage: Track memory consumption.
- Disk Usage: Keep an eye on disk space.
Modern UI
- Responsive Design: Optimized for mobile and desktop use.
- Multiple Themes: Choose from Default, Catppuccin Latte, Tokyo Night, Nord, Dracula, and Gruvbox.
- Custom Backgrounds: Set custom background images for each theme.
- Search Functionality: Quickly find services and bookmarks with keyboard navigation.
Use Cases
Homelab Management
Whether you're running a home automation system like Home Assistant or a media server like Plex, Homepage-lite provides a centralized interface to monitor their status. This ensures you can quickly identify and resolve any issues without needing to log into each service individually.
System Monitoring
With real-time updates on CPU, memory, and disk usage, you can keep your homelab running smoothly. This is particularly useful for diagnosing performance issues or planning upgrades.
Bookmark Organization
Organize your frequently used links into groups for quick access. Use custom abbreviations to navigate even faster, making your homelab management more efficient.
Mobile Optimization
Whether you're on the go or just prefer using your mobile device, Homepage-lite's responsive design ensures you can manage your homelab from anywhere. The mobile-friendly footer and flexible layout options make it a breeze to use on smaller screens.
Step-by-Step Installation & Setup Guide
Pre-built Binaries
Pre-built binaries are available for Linux (x86/ARM64), Windows, and macOS from the GitHub releases page.
-
Clone the Repository
git clone ssh://git@git.home/jkx/homepage-lite.git cd homepage-lite -
Build and Run
make build ./homepage-lite -
Install
make install sudo vim /opt/homepage-lite/config.yaml # Edit configuration as needed sudo systemctl start homepage-lite sudo systemctl enable homepage-lite
Docker Setup
Homepage-lite is also available as a Docker image on GitHub Container Registry.
-
Ensure You Have a
config.yamlFile -
Create a
docker-compose.ymlFileservices: homepage-lite: image: ghcr.io/jkerdreux-imt/homepage-lite:latest ports: - "8888:8888" volumes: - /path/to/your/config/folder/:/app/config/ restart: unless-stopped -
Run the Container
docker-compose up -d
The application will be available at http://localhost:8888.
REAL Code Examples from the Repository
Configuration Example
Here's an example of the config.yaml file structure:
services:
- group: Home
items:
- name: Home Assistant
url: https://homeassistant.local:8123
description: Home automation
icon: home-assistant.png
- name: Dockge
url: http://192.168.1.10:5001/
description: Dockge
icon: mdi-docker
bookmarks:
- group: Developer
items:
- name: GitHub
url: https://github.com
abbr: GH
settings:
theme: default
title: My Homelab
port: 8888
Service Monitoring
This section defines the services you want to monitor. Each service has a name, URL, description, and an icon.
services:
- group: Home
items:
- name: Home Assistant
url: https://homeassistant.local:8123
description: Home automation
icon: home-assistant.png
Bookmark Management
Organize your bookmarks into groups for easy access. You can also use custom abbreviations for quicker navigation.
bookmarks:
- group: Developer
items:
- name: GitHub
url: https://github.com
abbr: GH
System Metrics
Monitor your system's CPU, memory, and disk usage with real-time updates.
settings:
theme: default
title: My Homelab
port: 8888
Themes
Choose from multiple built-in themes with custom background images. Themes can be changed via the footer selector and are persisted in localStorage.
settings:
theme: Catppuccin Latte
Advanced Configuration
You can customize the layout, set custom background images, and more.
settings:
theme: Nord
title: My Homelab
port: 8888
layout: sidebar
Advanced Usage & Best Practices
Pro Tips
- Custom Icons: Use custom icons for your services to make them easily recognizable.
- Regular Updates: Keep your configuration file updated to reflect changes in your homelab setup.
- Theme Customization: Experiment with different themes to find the one that best suits your preferences.
- Mobile Optimization: Ensure your layout is mobile-friendly for on-the-go management.
Optimization Strategies
- Service Grouping: Group related services together for better organization.
- Regular Monitoring: Set up regular monitoring intervals to catch issues early.
- Backup Configuration: Regularly back up your configuration file to avoid data loss.
Comparison with Alternatives
| Feature/Tool | Homepage-lite | Grafana | Netdata |
|---|---|---|---|
| Lightweight | Yes | No | No |
| Real-time Updates | Yes | Yes | Yes |
| Bookmark Management | Yes | No | No |
| System Metrics | Yes | Yes | Yes |
| Modern UI | Yes | Yes | Yes |
| Easy Setup | Yes | Complex | Complex |
Why Choose Homepage-lite?
- Lightweight: Ideal for resource-constrained environments.
- Easy Setup: Simple installation and configuration process.
- Comprehensive Features: Combines service monitoring, bookmark management, and system metrics in one dashboard.
- Modern UI: Responsive design with multiple themes and mobile optimization.
FAQ
How do I install Homepage-lite?
You can install Homepage-lite using pre-built binaries or Docker. Detailed instructions are available in the GitHub repository.
Can I use custom icons for my services?
Yes, you can use custom PNG icons or choose from Iconify icons.
How often does the dashboard refresh?
The dashboard automatically refreshes every 30 seconds.
Is Homepage-lite mobile-friendly?
Yes, it has a responsive design optimized for mobile use.
Can I change the theme?
Yes, you can choose from multiple built-in themes and even set custom background images.
How do I update my configuration?
Edit the config.yaml file and the changes will be detected automatically, triggering a page reload.
Is there a Docker image available?
Yes, you can find the Docker image on the GitHub Container Registry.
Conclusion
Homepage-lite is a revolutionary tool for homelab enthusiasts, offering a lightweight, modern, and feature-rich dashboard for managing and monitoring your homelab services. With its real-time updates, extensive features, and easy setup, it's a must-have for anyone looking to streamline their homelab management. Don't miss out on this powerful tool. Check out the GitHub repository and start enhancing your homelab today!
