homer README

The project's README from github.com/bastienwirtz/homer. As one markdown file: README.md.

Homer's donut
Homer

A dead simple static HOMepage for your servER to keep your services on hand, from a simple yaml configuration file.

Buy Me A Coffee

License: Apache 2 Download homer static build speed-blazing Awesome

Demo • Docker Hub • Get started

Highlights

Table of Contents

Get 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

The configuration directory is bind mounted to make your dashboard easy to maintain.

Start the container with docker run

# Make sure your local config directory exists
docker run -d \
  --name homer \
  -p 8080:8080 \
  --mount type=bind,source="/path/to/config/dir",target=/www/assets \
  --restart=unless-stopped \
  b4bz/homer:latest

[!NOTE]
The container will run using a user uid and gid 1000 by default, add --user <your-UID>:<your-GID> to the docker command to adjust it if necessary. Make sure this match the permissions of your assets directory.

or docker-compose

services:
  homer:
    image: b4bz/homer
    container_name: homer
    volumes:
      - /path/to/config/dir:/www/assets # Make sure your local config directory exists
    ports:
      - 8080:8080
    user: 1000:1000 # default
    environment:
      - INIT_ASSETS=1 # default, requires the config directory to be writable for the container user (see user option)
    restart: unless-stopped

Environment variables:

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 -d homer
cd homer
cp assets/config.yml.dist assets/config.yml
pnpx http-server # or python -m http.server 8010 or any web server.

Build manually

pnpm install
pnpm build

Then your dashboard is ready to use in the /dist directory.

homer (bastienwirtz/homer)

static-site
Searching Database…

11.7K ·GitHub
Homer
What is this?Homer is a dead simple static dashboard for your server that lists all your services on one homepage, configured through a single YAML file.
Is this an app I run, or just a static page?It is a static HTML/JS site generated from a Vue app; you serve the built files with any HTTP server (not opening index.html directly).
How do I get it running?Run it with 'docker run' or docker-compose using the official image, or download the prebuilt release tarball (homer.zip), rename config.yml.dist to config.yml, and serve it with a web server.
Do I need anything besides a YAML config and a web server?No backend or database is needed — just a working HTTP server to serve the static files and a config.yml describing your services.
Any install pitfalls?It won't work if you open index.html directly via the file:// protocol — it must be served over HTTP.
Does it run on something like a Raspberry Pi too?Yes, being a lightweight static Docker app it runs fine on small devices like a Raspberry Pi, and there's also a Kubernetes installation path.
Can I install Homer as an app on my phone or desktop?Yes, it is installable as a PWA (Progressive Web App), so you can add it to your home screen or desktop like a native app.
What is a 'smart card' in Homer?Smart cards are dashboard tiles that can show live status or extra info for certain services, beyond just a link and icon.
Can I organize many services into groups or pages?Yes, Homer supports multi-page setups and item grouping so you can organize a large number of services clearly.
Does it support keyboard shortcuts?Yes: '/' starts searching, 'Escape' stops it, 'Enter' opens the first match, and 'Alt+Enter' opens it in a new tab.
What are similar projects?dashy, Piped, glance, homepage, chatwoot, habitica, hoppscotch, MyIP
Which topics is it in?toolbox, static-site, vuejs, self-hosting, pwa, yaml, raspberry-pi, vue, dashboard, hacktoberfest, web-app, apache-2.0
Creator
bastienwirtz
Size
5.4 MB
Stars
11.7K
Updated
CommitAug 30Releasev26.08.3Aug 30
Age
8y
Commits · 90 Days