holm/homer

A very simple static homepage for your server.

Go to file

Bastien Wirtz 1ed0a2f387 Merge pull request #213 from simonporte/main Fix transparency level behind links		2021-09-13 12:45:58 -07:00
.github	Fix documentation link.	2020-12-07 22:57:44 -08:00
docs	typo	2021-08-26 21:54:59 -04:00
hooks	Adding support for release build.	2020-07-12 20:12:53 -07:00
public	Avoid full reload when swithcing page.	2021-03-06 22:50:58 -08:00
src	Merge pull request #213 from simonporte/main	2021-09-13 12:45:58 -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	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	Fix documentation link.	2020-12-07 22:57:44 -08:00
docker-compose.yml	Minor edits on readme and documentation	2020-11-14 13:25:01 +01:00
Dockerfile	Added su-exec to ARM dockerfiles and removed USER line	2020-07-09 18:47:33 +01:00
Dockerfile.arm32v7	Uniformise dockerfile	2020-07-15 14:23:29 -07:00
Dockerfile.arm64v8	Uniformise dockerfile	2020-07-15 14:23:29 -07:00
entrypoint.sh	Added su-exec to ARM dockerfiles and removed USER line	2020-07-09 18:47:33 +01:00
LICENSE	Replace licence placeholder. Fix #142	2020-12-23 10:55:05 -08:00
package.json	Version bump	2021-07-14 16:48:55 +02:00
README.md	regroup service documentation	2021-07-14 15:48:57 +02:00
vue.config.js	Add crossorigin use-credentials attribute to manifest tag	2021-04-25 14:38:41 -07:00
yarn.lock	Lint & updates	2021-07-14 12:05:53 +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 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

To launch container:

docker run -d \
  -p 8080:8080 \
  -v </your/local/assets/>:/www/assets \
  --restart=always \
  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 docker-compose

The docker-compose.yml file must be edited to match your needs. Set the port and volume (equivalent to -p and -v arguments):

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

To launch container:

cd /path/to/docker-compose.yml
docker-compose up -d

Default assets will be automatically installed in the /www/assets directory. Use UID and/or GID env var to change the assets owner, also in docker-compose.yml:

environment:
  - UID=1000
  - GID=1000

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