holm/homer
1
0
Fork 0
forked from extern/homer
Code Issues Pull Requests Packages Projects Releases Wiki Activity
A very simple static homepage for your server.
457 Commits 3 Branches 42 Tags 12 MiB
Vue 86.3%
SCSS 8.2%
JavaScript 2.6%
Shell 0.9%
Dockerfile 0.8%
Other 1.2%
95249e1125
Go to file
Pierre 95249e1125 doc(auth): add auth proxy documentation
2022-05-30 17:04:41 +02:00
.github Upgrade dependancies 2021-12-12 09:45:54 +01:00
docs doc(auth): add auth proxy documentation 2022-05-30 17:04:41 +02:00
hooks Adding support for release build. 2020-07-12 20:12:53 -07:00
public FA note chages for new users (#404) 2022-03-19 19:34:16 -04:00
src feat(auth): do not handle redirection in getConfig 2022-05-30 17:04:21 +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 Apply lastest update to arm dockerfile 2022-04-30 15:58:04 +02:00
Dockerfile.arm32v7 Apply lastest update to arm dockerfile 2022-04-30 15:58:04 +02:00
Dockerfile.arm64v8 Apply lastest update to arm dockerfile 2022-04-30 15:58:04 +02:00
entrypoint.sh Simplify the container starting process to allow it to run with a 2022-04-30 15:39:36 +02: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 Update fontawesome from 5.15.4 to 6.1.1, fixes #432 2022-04-26 18:19:36 -04:00
README.md Update README.md 2022-05-03 13:00:49 -04:00
vue.config.js feat(pwa): enhance connectivity checks 2022-05-09 23:47:05 +02:00
yarn.lock Bump async from 2.6.3 to 2.6.4 (#433) 2022-04-26 18:22:37 -04:00

README.md

Homer's donut
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

License: Apache 2 Gitter chat Download homer static build Awesome

Table of Contents

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.