Top Related Projects
A highly customizable homepage (or startpage / application dashboard) with Docker and service API integrations.
Flame is self-hosted startpage for your server. Easily manage your apps and bookmarks with built-in editors.
🚀 A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!
HTPC/Homelab Services Organizer - Written in PHP
a startpage for your server and / or new tab page
Quick Overview
Homer is a simple static homepage for your server, designed to be lightweight and customizable. It allows you to create a clean, modern dashboard for organizing and accessing your web services and applications. Homer is particularly useful for self-hosted environments and home servers.
Pros
- Easy to set up and configure using a single YAML file
- Highly customizable with themes, icons, and custom CSS
- Lightweight and fast-loading, with no database required
- Supports both light and dark modes
Cons
- Limited dynamic functionality as it's a static site generator
- Requires manual updates to add or modify services
- May not be suitable for complex dashboards with advanced features
- Limited built-in authentication options
Getting Started
- Download the latest release from the GitHub repository.
- Create a
config.yml
file in theassets
folder with your configuration. - Customize the
config.yml
file to add your services and preferences. - Deploy the files to your web server or use Docker for easy deployment.
Example config.yml
:
---
title: "My Homepage"
subtitle: "Homer"
logo: "logo.png"
header: true
footer: '<p>Created with <a href="https://github.com/bastienwirtz/homer">Homer</a></p>'
services:
- name: "My Services"
icon: "fas fa-cloud"
items:
- name: "Nextcloud"
logo: "assets/tools/nextcloud.png"
subtitle: "File Hosting"
tag: "app"
url: "https://nextcloud.example.com/"
- name: "Plex"
logo: "assets/tools/plex.png"
subtitle: "Media Server"
tag: "app"
url: "https://plex.example.com/"
To run Homer using Docker:
docker run -d \
-p 8080:8080 \
-v /your/local/assets/:/www/assets \
--restart=always \
b4bz/homer:latest
Visit http://localhost:8080
to view your Homer dashboard.
Competitor Comparisons
A highly customizable homepage (or startpage / application dashboard) with Docker and service API integrations.
Pros of Homepage
- More dynamic and feature-rich dashboard with live status updates
- Supports widgets for various services (e.g., weather, system stats)
- Offers a wider range of customization options for layout and appearance
Cons of Homepage
- Steeper learning curve due to more complex configuration
- Requires more system resources to run compared to Homer
- May be overkill for users seeking a simple, static dashboard
Code Comparison
Homer configuration (YAML):
services:
- name: "Example"
icon: "fas fa-cloud"
url: "https://example.com"
Homepage configuration (YAML):
services:
- Example:
icon: cloud
href: https://example.com
widget:
type: ping
url: https://example.com
Homer focuses on simplicity, using a straightforward YAML structure for defining services. Homepage offers more advanced features, including widget support for live status checks, but requires a more complex configuration.
Both projects aim to provide self-hosted dashboard solutions, but cater to different user needs. Homer is ideal for those seeking a lightweight, easy-to-configure option, while Homepage is better suited for users who want a more feature-rich and dynamic dashboard experience.
Flame is self-hosted startpage for your server. Easily manage your apps and bookmarks with built-in editors.
Pros of Flame
- More modern and visually appealing UI with a sleek, card-based design
- Built-in weather widget and customizable backgrounds
- Supports Docker healthchecks for service status monitoring
Cons of Flame
- Less customizable layout compared to Homer's flexible grid system
- Fewer theming options and less control over color schemes
- Requires more system resources due to its React-based frontend
Code Comparison
Homer (YAML configuration):
services:
- name: "Example"
icon: "fas fa-cloud"
url: "https://example.com"
target: "_blank"
Flame (JSON configuration):
{
"name": "Example",
"icon": "fab fa-github",
"url": "https://example.com",
"newTab": true
}
Both Homer and Flame are self-hosted dashboard solutions for organizing and accessing web services. Homer offers more flexibility in layout and theming, while Flame provides a more modern look with additional features like weather information. Homer uses a YAML-based configuration, whereas Flame uses JSON. Ultimately, the choice between the two depends on personal preferences for design, customization, and specific feature requirements.
🚀 A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!
Pros of Dashy
- More customization options and themes
- Built-in authentication and multi-user support
- Wider range of widgets and integrations
Cons of Dashy
- Steeper learning curve due to more complex configuration
- Heavier resource usage, potentially slower on low-end devices
Code Comparison
Homer configuration (YAML):
services:
- name: "Example"
icon: "fas fa-cloud"
url: "https://example.com"
Dashy configuration (YAML):
sections:
- name: "Example Section"
items:
- title: "Example"
icon: "fas fa-cloud"
url: "https://example.com"
Both Homer and Dashy are self-hosted dashboard solutions for organizing and accessing web services. Homer focuses on simplicity and ease of use, while Dashy offers more advanced features and customization options.
Homer's straightforward configuration makes it ideal for users who want a quick setup with minimal complexity. It's lightweight and performs well on various devices.
Dashy, on the other hand, provides a feature-rich experience with extensive customization options, themes, and widgets. It supports authentication and multi-user setups, making it suitable for more complex environments or shared use cases.
The code comparison shows that Dashy's configuration is slightly more verbose, reflecting its additional capabilities. While this allows for more granular control, it may require more time to set up and maintain compared to Homer's simpler structure.
HTPC/Homelab Services Organizer - Written in PHP
Pros of Organizr
- More feature-rich with user management, SSO, and API integrations
- Customizable themes and layouts for a personalized dashboard experience
- Active development with frequent updates and community support
Cons of Organizr
- Steeper learning curve due to more complex setup and configuration
- Requires PHP and a web server, potentially increasing resource usage
- May be overkill for users seeking a simple, lightweight dashboard solution
Code Comparison
Homer:
services:
- name: "My Service"
logo: "assets/tools/sample.png"
url: "https://example.com"
target: "_blank"
Organizr:
$config['tabs'][] = array(
'name' => 'My Service',
'url' => 'https://example.com',
'image' => 'plugins/images/tabs/sample.png',
'target' => '_blank'
);
Summary
Homer offers a simpler, static dashboard with easy configuration using YAML, while Organizr provides a more dynamic and feature-rich solution with PHP-based customization. Homer is ideal for users wanting a lightweight, easy-to-deploy dashboard, whereas Organizr caters to those seeking advanced features and integrations at the cost of increased complexity.
a startpage for your server and / or new tab page
Pros of SUI
- More minimalist and lightweight design
- Supports custom CSS for easier theming
- Includes a built-in search functionality
Cons of SUI
- Less actively maintained (last update in 2021)
- Fewer customization options out-of-the-box
- Limited documentation and community support
Code Comparison
SUI configuration (apps.json):
{
"apps": [
{
"name": "App Name",
"url": "https://example.com",
"icon": "fas fa-example"
}
]
}
Homer configuration (config.yml):
services:
- name: "App Name"
logo: "assets/tools/example.png"
url: "https://example.com"
target: "_blank"
Both Homer and SUI are self-hosted dashboard solutions for organizing and accessing web applications. Homer offers more features and customization options, with active development and community support. It uses YAML for configuration, which some users may find more readable. SUI, on the other hand, provides a simpler setup with JSON configuration and a more minimalist design. While SUI includes a built-in search feature, Homer relies on third-party integrations for search functionality. Ultimately, the choice between the two depends on the user's specific needs and preferences for design and customization.
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
Homer
A dead simple static HOMepage for your servER to keep your services on hand, from a simple yaml
configuration file.
Demo ⢠Chat ⢠Getting started
Table of Contents
- Features
- Getting started
- Kubernetes Installation
- Configuration
- Theming
- Custom services
- Tips & tricks
- Development
- Troubleshooting
Features
- yaml file configuration
- Installable (pwa)
- Search
- Grouping
- Theme customization
- Offline health check
- keyboard shortcuts:
/
Start searching.Escape
Stop searching.Enter
Open the first matching result (respects the bookmark's_target
property).Alt
/Option
+Enter
Open the first matching result in a new tab.
Getting started
Homer is a full static html/js dashboard, based on a simple yaml configuration file. See documentation for information about the configuration (assets/config.yml
) options.
It's meant to be served by an HTTP server, it will not work if you open the index.html directly over file:// protocol.
Using docker
docker run -d \
-p 8080:8080 \
-v </your/local/assets/>:/www/assets \
--restart=always \
b4bz/homer:latest
The container will run using a user uid and gid 1000. Add --user <your-UID>:<your-GID>
to the docker command to adjust it. Make sure this match the ownership of your assets directory.
Environment variables:
-
INIT_ASSETS
(default:1
) Install example configuration file & assets (favicons, ...) to help you get started. -
SUBFOLDER
(default:null
) If you would like to host Homer in a subfolder, (ex: http://my-domain/**homer**), set this to the subfolder path (ex/homer
). -
PORT
(default:8080
) If you would like to change internal port of Homer from default8080
to your port choice. -
IPV6_DISABLE
(default: 0) Set to1
to disable listening on IPv6.
With docker-compose
A docker-compose.yml
file is available as an example. It must be edited to match your needs. You probably want to adjust the port mapping and volume binding (equivalent to -p
and -v
arguments).
Then launch the container:
cd /path/to/docker-compose.yml/
docker-compose up -d
Using the release tarball (prebuilt, ready to use)
Download and extract the latest release (homer.zip
) from the release page, rename the assets/config.yml.dist
file to assets/config.yml
, and put it behind a web server.
wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip
unzip homer.zip
cd homer
cp assets/config.yml.dist assets/config.yml
npx serve # or python -m http.server 8010 or apache, nginx ...
Build manually
pnpm install
pnpm build
Then your dashboard is ready to use in the /dist
directory.
Top Related Projects
A highly customizable homepage (or startpage / application dashboard) with Docker and service API integrations.
Flame is self-hosted startpage for your server. Easily manage your apps and bookmarks with built-in editors.
🚀 A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!
HTPC/Homelab Services Organizer - Written in PHP
a startpage for your server and / or new tab page
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot