-# Homer
-A dead simple static **HOM**epage for your serv**ER** to keep your services on hand, from a simple `yaml` configuration file.
+<h1 align="center">
+ <img
+ width="180"
+ alt="Homer's donut"
+ src="https://raw.githubusercontent.com//bastienwirtz/homer/main/public/logo.png">
+ <br/>
+ Homer
+</h1>
+
+<h4 align="center">
+ A dead simple static <strong>HOM</strong>epage for your serv<strong>ER</strong> to keep your services on hand, from a simple <code>yaml</code> configuration file.
+</h4>
+
+<p align="center">
+ <strong>
+ <a href="https://homer-demo.netlify.app">Demo</a>
+ •
+ <a href="https://gitter.im/homer-dashboard/community">Chat</a>
+ •
+ <a href="#getting-started">Getting started</a>
+ </strong>
+</p>
+<p align="center">
+ <a href="https://opensource.org/licenses/Apache-2.0"><img
+ alt="License: Apache 2"
+ src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>
+ <a href="https://gitter.im/homer-dashboard/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge"><img
+ alt="Gitter chat"
+ src="https://badges.gitter.im/homer-dashboard/community.svg"></a>
+ <a href="https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip"><img
+ alt="Download homer static build"
+ src="https://img.shields.io/badge/Download-homer.zip-orange"></a>
+ <a href="https://github.com/awesome-selfhosted/awesome-selfhosted"><img
+ alt="Awesome"
+ src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg"></a>
+</p>
+
+<p align="center">
+ <img src="https://raw.github.com/bastienwirtz/homer/main/docs/screenshot.png" width="100%">
+</p>
+
+## Table of Contents
+- [Features](#features)
+- [Getting started](#getting-started)
+- [Configuration](docs/configuration.md)
+- [Tips & tricks](docs/tips-and-tricks.md)
+- [Roadmap](#roadmap)
+- [Development](docs/development.md)
+
+
+## Features
+- [yaml](http://yaml.org/) 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](docs/configuration.md) for information about the configuration (`assets/config.yml`) options.
-**Check out the live demo [here](https://homer-demo.netlify.com/).**
+### Using docker
-If you need authentication support, you're on your own (it can be secured using a web server auth module or exposing it only through a VPN network / SSH tunnel, ...)
+To launch container:
-
+```sh
+docker run -d \
+ -p 8080:8080 \
+ -v </your/local/assets/>:/www/assets \
+ --restart=always \
+ b4bz/homer:latest
+```
-## Roadmap
+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" [...]`).
-- [ ] Colors / theme customization
-- [ ] Enable PWA support (making possible to "install" - add to homescreen - it)
-- [ ] Improve maintenability (external library import & service workers cached file list.)
+### Using docker-compose
-## Installation
+The `docker-compose.yml` file must be edited to match your needs.
+Set the port and volume (equivalent to `-p` and `-v` arguments):
-### Using docker
+```yaml
+volumes:
+ - /your/local/assets/:/www/assets
+ports:
+ - 8080:8080
+```
+
+To launch container:
```sh
-sudo docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/local/assets/:/www/assets b4bz/homer:latest
+cd /path/to/docker-compose.yml
+docker-compose up -d
```
-### Manually
+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`:
-**How to build / install it?** There is no build system (😱), use it like that! It's meant to be stupid simple & zero maintenance required. Just copy the static files somewhere, and visit the `index.html`.
+```yaml
+environment:
+ - UID=1000
+ - GID=1000
+```
+### Using the release tarball (prebuilt, ready to use)
-## Configuration
+Download and extract the latest release (`homer.zip`) from the [release page](https://github.com/bastienwirtz/homer/releases), rename the `assets/config.yml.dist` file to `assets/config.yml`, and put it behind a webserver.
-Title, icons, links, colors, and services can be configured in the `config.yml` file, using [yaml](http://yaml.org/) format.
+```sh
+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
-```yaml
----
-# Homepage configuration
-# See https://fontawesome.com/icons for icons options
-
-title: "Simple homepage"
-subtitle: "Homer"
-logo: "assets/homer.png"
-# Alternatively a fa icon can be provided:
-# icon: "fas fa-skull-crossbones"
-footer: '<p>Created with <span class="has-text-danger">❤️</span> with <a href="https://bulma.io/">bulma</a>, <a href="https://vuejs.org/">vuejs</a> & <a href="https://fontawesome.com/">font awesome</a> // Fork me on <a href="https://github.com/bastienwirtz/homer"><i class="fab fa-github-alt"></i></a></p>' # set false if you want to hide it.header:
-
-# Optional message
-message:
- # url: "https://<my-api-endpoint>" # Can fetch information from an endpoint to override value below.
- style: "is-warning"
- title: "Optional message!"
- content: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque risus mi, tempus quis placerat ut, porta nec nulla. Vestibulum rhoncus ac ex sit amet fringilla. Nullam gravida purus diam, et dictum felis venenatis efficitur. Aenean ac eleifend lacus, in mollis lectus. Donec sodales, arcu et sollicitudin porttitor, tortor urna tempor ligula."
-
-# Optional navbar
-# links: [] # Allows for navbar (dark mode, layout, and search) without any links
-links:
- - name: "ansible"
- icon: "fa-github"
- url: "https://github.com/xxxxx/ansible/"
- target: '_blank' # optionnal html a tag target attribute
- - name: "Wiki"
- icon: "fa-book"
- url: "https://wiki.xxxxxx.com/"
-
-# Services
-# First level array represent a group.
-# Leave only a "items" key if not using group (group name, icon & tagstyle are optional, section separation will not be displayed).
-services:
- - name: "DevOps"
- icon: "fa-code-fork"
- items:
- - name: "Jenkins"
- logo: "/assets/tools/jenkins.png"
- # Alternatively a fa icon can be provided:
- # icon: "fab fa-jenkins"
- subtitle: "Continuous integration server"
- tag: "CI"
- url: "#"
- target: '_blank' # optionnal html a tag target attribute
- - name: "RabbitMQ Management"
- logo: "/assets/tools/rabbitmq.png"
- subtitle: "Manage & monitor RabbitMQ server"
- tag: "haproxy"
- # Optional tagstyle
- tagstyle: "is-success"
- url: "#"
- - name: "Monitoring"
- icon: "fa-heartbeat"
- items:
- - name: "M/Monit"
- logo: "/assets/tools/monit.png"
- subtitle: "Monitor & manage all monit enabled hosts"
- tag: "monit"
- url: "#"
- - name: "Grafana"
- logo: "/assets/tools/grafana.png"
- subtitle: "Metric analytics & dashboards"
- url: "#"
- - name: "Kibana"
- logo: "/assets/tools/elastic.png"
- subtitle: "Explore & visualize logs"
- tag: "elk"
- url: "#"
- - name: "Website monitoring"
- logo: "/assets/tools/pingdom.png"
- subtitle: "Pingdom public reports overview"
- tag: "CI"
- url: "#"
+```sh
+# Using yarn (recommended)
+yarn install
+yarn build
+# **OR** Using npm
+npm install
+npm run build
```
-If you choose to fetch message information from an endpoint, the output format should be:
+Then your dashboard is ready to use in the `/dist` directory.
-```json
-{
- "style": null,
- "title": "Lorem ipsum 42",
- "content": "LA LA LA Lorem ipsum dolor sit amet, ....."
-}
-```
-`null` value or missing keys will be ignored and value from the `config.yml` will be used if available.
-Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar).
+## Roadmap
+
+- [ ] Add new themes.
+- [ ] Add support for custom service card (add custom feature to some service / app link)
projects / github / bastienwirtz / homer.git / blobdiff