mirror of https://github.com/bastienwirtz/homer.git synced 2024-10-05 01:42:01 +02:00

A very simple static homepage for your server.

dashboard hacktoberfest homepage self-hosted toolbox vuejs

Go to file

Bastien Wirtz eb03092286 Fix theming issue & subfolder hosting		2022-07-12 14:07:10 +02:00
.github	Uniform workflow yaml style	2022-07-11 20:58:57 +02:00
docs	Documentation update	2022-07-11 22:07:15 +02:00
public	Simplify index & fix logo path	2022-07-11 21:00:01 +02:00
src	Fix theming issue & subfolder hosting	2022-07-12 14:07:10 +02:00
.dockerignore	Regroup all editable files in one place	2020-06-28 11:05:40 -07:00
.eslintrc.cjs	Fix lint issues	2022-07-03 21:59:57 +02:00
.gitignore	Explicitly define start_url	2020-06-29 20:03:52 +02: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
index.html	Fix theming issue & subfolder hosting	2022-07-12 14:07:10 +02:00
LICENSE	Replace licence placeholder. Fix #142	2020-12-23 10:55:05 -08:00
lighttpd.conf	Missing eof	2022-07-03 22:09:14 +02:00
package.json	Fix search widget	2022-07-11 22:07:48 +02:00
README.md	Adding permissions configuration information.	2022-06-29 23:02:10 +02:00
vite.config.js	Fix theming issue & subfolder hosting	2022-07-12 14:07:10 +02:00
yarn.lock	Fix search widget	2022-07-11 22:07:48 +02: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, 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).

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

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