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.
193 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%
c701075dfa
Go to file
Florian J. Breunig c701075dfa
Use gender-neutral terminology 
Fix #155
2020-11-02 22:56:39 +01:00
.github chore: applies spell-check against entire repo (aspell) 2020-10-25 21:27:09 -07:00
docs chore: applies spell-check against entire repo (aspell) 2020-10-25 21:27:09 -07:00
hooks Adding support for release build. 2020-07-12 20:12:53 -07:00
public Merge pull request #127 from NotWoods/pwa-icons 2020-10-23 14:46:36 -07:00
src Use gender-neutral terminology 2020-11-02 22:56:39 +01: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 chore: applies spell-check against entire repo (aspell) 2020-10-25 21:27:09 -07:00
docker-compose.yml Added docker-compose.yml 2020-07-24 14:38:42 +02: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 Initial commit 2018-06-13 21:57:54 -07:00
package.json Update deps & fix lint issues 2020-10-23 15:24:16 -07:00
README.md chore: applies spell-check against entire repo (aspell) 2020-10-25 21:27:09 -07:00
vue.config.js Pull all values from manifest 2020-10-23 13:59:55 -07:00
yarn.lock Update deps & fix lint issues 2020-10-23 15:24:16 -07: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 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 -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 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 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)