Discord: https://discord.gg/wFJEna8AdC Demo: https://demo.homeglow.dev
A Smart, Self-Hosted Dashboard for Your Home
HomeGlow is an open-source, self-hosted dashboard application designed for touch-enabled displays, drawing inspiration from projects like Magic Mirror. It offers a modular, browser-based interface to centralize and display essential home information, integrating with self-hosted services and providing custom modules for family management. Optimized for Linux environments (e.g., Raspberry Pi, Proxmox VMs), HomeGlow is lightweight, highly customizable, and perfect for creating a dynamic home hub.
HomeGlow is built with a focus on modern aesthetics, user experience, and practical utility, incorporating advanced features to prevent screen burn-in and enhance daily interactions.
- Dynamic Theming: Seamlessly toggle between beautiful Light and Dark modes, with your preference intelligently saved in local storage.
- Touch-Friendly Interface: Designed from the ground up for touchscreens, allowing intuitive interaction with all widgets and controls.
- Customizable Widget Layout:
- Drag-and-Drop Positioning: Unlock layout mode to freely arrange widgets on your dashboard
- Flexible Resizing: Click or tap widgets to select, then use +/- buttons on each edge to resize
- Grid-Based System: Responsive 12-column grid that adapts to mobile, tablet, and desktop screens
- Persistent Layouts: Your custom arrangement is automatically saved and restored
- Touch & Mouse Support: Full support for both touch gestures and traditional mouse interactions
- Widget Refresh System: Configure auto-refresh rates for each widget independently (5, 15, 30 minutes, or 1-6 hours)
- Calendar Widget:
- Multi-Source Calendar Support: Connect multiple calendars simultaneously from different sources.
- ICS & CalDAV Integration: Supports both public ICS links (Google Calendar, Apple Calendar, etc.) and private CalDAV servers with authentication.
- Month & Week Views: Seamlessly toggle between a traditional month view and a dynamic week view with intuitive navigation controls.
- Menu Widget: Add multiple menu items per day, allowing for detailed meal planning.
- Chores Widget:
- User-Centric Task Management: Assign and track chores for multiple users, with visual progress indicators.
- Clam Reward System: Users earn "clams" (a customizable reward currency) upon completing all their daily chores.
- Swipe-to-Complete: Mark chores as complete with a simple swipe gesture (on touch-enabled devices).
- Sticky Chores (Until-Completed): Keep chores visible until they are completed, perfect for flexible schedules and ongoing tasks.
- Bonus Chore System: Create special bonus chores with custom clam rewards.
- Photo Widget: Integrates with self-hosted Immich instances to display your personal photo library.
- Weather Widget: Provides current weather conditions and a 3-day forecast for a specified zip code, including interactive temperature and precipitation graphs.
- Custom Widget System: Upload and manage custom HTML widgets through the Admin Panel, with full theme integration and transparency support.
- SQLite Database: Lightweight and efficient database for managing users, chores, and other application data.
- Fastify Backend: A high-performance Node.js framework ensuring a fast and responsive API.
- Widget Gallery: Dynamic loading and management of custom widgets with theme and transparency support.
- Dockerized: Easily deployable using Docker and Docker Compose, simplifying setup and management.
- Portainer Compatible: Full support for deployment via Portainer stacks with Git integration.
- Linux Optimized: Ideal for deployment on Linux servers, including low-power devices like Raspberry Pi.
- Docker and Docker Compose (required for all supported deployment methods)
- OpenWeatherMap API Key: (Optional, for Weather widget): free license
- Calendar Source (Optional, for Calendar widget): ICS link from any calendar service (Google Calendar, Apple Calendar, etc.) or CalDAV server credentials
- Immich Instance (Optional, for Photo widget): A running Immich server with API access
Get HomeGlow running with these simple commands:
# 1. Download docker-compose file
wget https://raw.githubusercontent.com/jherforth/HomeGlow/main/docker-compose.yml
# 2. Create config in .env (change the values as appropriate)
FRONTEND_PORT=3000
# Set the appropriate timezone for your location (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), e.g: America/New_York
TZ=America/New_York
# 3. Start HomeGlow
docker compose up -d
# 4. Access at http://your-server-ip:3000Configure API keys and widgets in the Admin Panel (⚙️ icon).
Updating: docker compose pull && docker compose up -d
git clone https://github.com/jherforth/homeglow.git && cd homeglow
docker compose -f docker-compose.dev.yml up --buildClick the gear icon (⚙️) to access settings:
- APIs: Add OpenWeatherMap API key for weather
- Widgets: Enable/disable widgets, set refresh intervals
- Users: Add family members, manage clam rewards
- Chores: Manage chores, schedules, and history
- Prizes: Create rewards for the clam system
- Calendar: Add ICS/CalDAV sources in the Calendar Widget settings
- Plugins: Upload custom HTML widgets
OpenWeatherMap: Sign up for a free API key at openweathermap.org.
Calendar Integration:
- Google Calendar: Settings → Integrate calendar → Copy "Secret address in iCal format"
- Apple Calendar: Share calendar publicly, copy URL
- CalDAV: Use your server URL with username/password
Create HTML widgets with theme support. See server/widgets/README.md for details.
DISCLAIMER: This project uses AI in its development process. While you are right to generally be skeptical about AI coding security, this project doesn't have any secure endpoints or credentials for AI to mishandle. Because there is no security implicitly or explicitly provided by this project, there cannot be any security failures from AI. When in doubt, don't expose services to the internet.
Reverse Proxy: Use SSL terminators/Cloudflare for HTTPS and custom domains
Backup: Copy ./homeglow/data/ (SQLite database) and ./homeglow/uploads/ (photos)
Database: SQLite with tables for users, chores, calendars, settings, prizes, and menus
Widgets not loading: Check Admin Panel → Plugins and browser console for errors
Calendar issues: Verify calendar sources are enabled, test ICS URLs in browser
Weather not working: Check OpenWeatherMap API key validity and rate limits
Help: GitHub Issues or check container logs for details
We welcome contributions! Here's how to get started:
- Fork the Repository
- Create a Feature Branch:
git checkout -b feature/amazing-feature - Make Your Changes: Follow the existing code style
- Test Thoroughly: Ensure both light/dark themes work
- Submit a Pull Request: Describe your changes clearly
- Follow existing patterns for consistency
- Test on multiple screen sizes (mobile, tablet, desktop)
- Verify theme compatibility (light/dark modes)
- Update documentation for new features
- Add error handling for robust operation
This project is open-source and available under the MIT License.
- Magic Mirror: Inspiration for the dashboard concept
- React Big Calendar: Calendar widget functionality
- Material-UI: Component library and theming
- Fastify: High-performance backend framework
- Docker: Containerization and deployment
HomeGlow - Transform your home with a beautiful, intelligent dashboard that grows with your family's needs.
ENJOY!