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 b102c9b2b3 Regroup all editable files in one place		2020-06-28 11:05:40 -07:00
.github	Fix Github action trigger syntax	2020-06-19 08:22:34 -07:00
docs	Regroup all editable files in one place	2020-06-28 11:05:40 -07:00
hooks	Build multi-arch container with manifest	2020-05-08 21:59:39 +10:00
public	Regroup all editable files in one place	2020-06-28 11:05:40 -07:00
src	Regroup all editable files in one place	2020-06-28 11:05:40 -07: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	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	Regroup all editable files in one place	2020-06-28 11:05:40 -07:00
Dockerfile.arm32v7	Regroup all editable files in one place	2020-06-28 11:05:40 -07:00
Dockerfile.arm64v8	Regroup all editable files in one place	2020-06-28 11:05:40 -07:00
entrypoint.sh	Regroup all editable files in one place	2020-06-28 11:05:40 -07:00
LICENSE	Initial commit	2018-06-13 21:57:54 -07:00
package.json	Release on tag event.	2020-06-19 07:56:17 -07:00
README.md	Regroup all editable files in one place	2020-06-28 11:05:40 -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.

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

Using docker

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

Default assets will be automatically installed in the /www/assets directory. Use UID and/or GID env var to change the assets owner (docker run -e "UID=1000" -e "GID=1000" [...]).

Using the release tarball (prebuilt, ready to use)

Download and extract the latest 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 webserver.

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.

Roadmap

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

README.md