holm/homer

A very simple static homepage for your server.

Go to file

Nuno Goncalves 71d929a55a Fix wrong config.yml path Path to config.yml when checking for existing configuration was wrong and it will never be found		2022-06-29 10:58:05 +01:00
.github	fix repository name	2022-06-12 21:46:11 +02:00
docs	Merge pull request #448 from bemble/main	2022-06-04 09:07:15 +02:00
public	Add support for search keywords to solve issue #372	2022-05-12 17:30:24 -05:00
src	Lint run	2022-06-05 21:50:28 +02:00
.browserslistrc	Build system integration using vue-cli.	2020-05-25 15:07:03 -07:00
.dockerignore	Regroup all editable files in one place	2020-06-28 11:05:40 -07:00
.eslintrc.js	Build system integration using vue-cli.	2020-05-25 15:07:03 -07:00
.gitignore	Explicitly define start_url	2020-06-29 20:03:52 +02:00
babel.config.js	Build system integration using vue-cli.	2020-05-25 15:07:03 -07:00
CODE_OF_CONDUCT.md	Adding contribution guidelines	2020-03-22 17:44:02 -07:00
CONTRIBUTING.md	Extendable base service for easier development.	2021-10-06 22:55:09 +02:00
docker-compose.yml	Simplify the container starting process to allow it to run with a	2022-04-30 15:39:36 +02:00
Dockerfile	Updates	2022-05-29 09:46:05 +02:00
entrypoint.sh	Fix wrong config.yml path	2022-06-29 10:58:05 +01:00
LICENSE	Replace licence placeholder. Fix #142	2020-12-23 10:55:05 -08:00
lighttpd.conf	Simplify the container starting process to allow it to run with a	2022-04-30 15:39:36 +02:00
package.json	Updates	2022-05-29 09:46:05 +02:00
README.md	Update README.md	2022-05-03 13:00:49 -04:00
vue.config.js	Lint run	2022-06-05 21:50:28 +02:00
yarn.lock	Bump eventsource from 1.1.0 to 1.1.1	2022-06-01 17:08:51 +00:00

README.md

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

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, generated from the source in /src using webpack. It's meant to be served by an HTTP server, it will not work if you open dist/index.html directly over file:// protocol.

See documentation for information about the configuration (assets/config.yml) options.

Using docker

docker run -d \
  -p 8080:8080 \
  -v </your/local/assets/>:/www/assets \
  --restart=always \
  b4bz/homer:latest

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).

Using docker-compose

The docker-compose.yml file must be edited to match your needs. You probably want to set the port mapping and volume binding (equivalent to -p and -v arguments):

volumes:
  - /your/local/assets/:/www/assets
ports:
  - 8080:8080

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

# Using yarn (recommended)
yarn install
yarn build

# **OR** Using npm
npm install
npm run build

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