holm/homer

A very simple static homepage for your server.

Go to file

Bastien Wirtz aac817970c Merge pull request #85 from bastienwirtz/splitted-documentation Split documentation into separate files		2020-06-13 16:26:40 -07:00
.github	Fix missing directory in artifact creation.	2020-05-31 00:08:18 -07:00
docs	remove duplicated part	2020-06-13 16:24:26 -07:00
hooks	Build multi-arch container with manifest	2020-05-08 21:59:39 +10:00
public	specify all icons path to fix pwa issue,	2020-06-09 22:30:28 -07:00
src	Customizable number of columns	2020-06-09 21:55:29 -07:00
.browserslistrc	Build system integration using vue-cli.	2020-05-25 15:07:03 -07:00
.dockerignore	Add .dockerignore	2020-03-23 16:00:45 +01:00
.eslintrc.js	Build system integration using vue-cli.	2020-05-25 15:07:03 -07:00
.gitignore	Remove config.yml from versionning.	2020-05-27 20:58:20 -07: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	Adding contribution guidelines	2020-03-22 17:44:02 -07:00
Dockerfile	freeze-lockfile option on yarn	2020-06-11 11:42:56 +10:00
Dockerfile.arm32v7	freeze-lockfile option on yarn	2020-06-11 11:42:56 +10:00
Dockerfile.arm64v8	freeze-lockfile option on yarn	2020-06-11 11:42:56 +10:00
LICENSE	Initial commit	2018-06-13 21:57:54 -07:00
package.json	Update dependencies	2020-06-06 16:56:46 -07:00
README.md	Split documentation into separate files	2020-06-11 22:48:22 -07:00
screenshot.png	Adding more documentation	2020-06-06 16:06:56 -07:00
vue.config.js	specify all icons path to fix pwa issue,	2020-06-09 22:30:28 -07:00
yarn.lock	Update dependencies	2020-06-06 16:56:46 -07:00

Homer

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

Features

yaml file configuration
Installable (pwa)
Search
Grouping
Theme customization
Offline heathcheck
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.

For more information about the config.yml file see configuration the section.

Using docker

docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/local/assets/:/www/assets b4bz/homer:latest

As a bind mount is used here, docker will not copy the initial content of the assets directory to the mounted directory. You can initialise your assets directory with the content provided in this repository

cp -r /public/assets/* /your/local/assets/

Alternatively if you just want to provide images/icons without customizing the other files (app manifest & pwa icons), you can mount a custom directory in the www directory and use it in your config.yml for icons path.

Using the release tarball (prebuilt, ready to use)

Download and extract the latest the latest release (homer.zip) from the release page, rename the config.yml.dist file to config.yml, and put it behind a webserver.

wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip
unzip homer.zip
cd homer
cp config.yml.dist 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.

Roadmap

Add new themes.
Add support for custom service card (add custom feature to some service / app link)

README.md