# Homer
-A very simple static HOMepage for your servER.
-Add all your useful service, external links, notes... or anything.
+[](https://opensource.org/licenses/Apache-2.0)
+[](http://makeapullrequest.com)
+[](https://gitter.im/homer-dashboard/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+[](https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip)
+[](https://github.com/awesome-selfhosted/awesome-selfhosted)
-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 tunneling, ...)
+A dead simple static **HOM**epage for your serv**ER** to keep your s
+ervices on hand, from a simple `yaml` configuration file.
-
+## [Live demo](https://homer-demo.netlify.app) • [Chat](https://gitter.im/homer-dashboard/community)
+
-**How to build / install it? Where is the webpack config?**
-There is no build system (😱), use it like that! It'meant to be stupid simple & zero maintenance required. just copy the static files somewhere, and visit the `index.html`.
+## Table of Contents
+- [Features](#features)
+- [Getting started](#getting-started)
+- [Configuration](docs/configuration.md)
+- [Tips & tricks](docs/tips-and-tricks.md)
+- [Roadmap](#roadmap)
+- [Developement](docs/developement.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**.
+
+For more information about the `config.yml` file see [configuration](docs/configuration.md) the section.
+
+### Using docker
+
+```sh
+docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/local/assets/:/www/assets b4bz/homer:latest
+```
+
+As a bind mount is used here, docker will not copy the initial content of the `assets` directory to the mounted directory.
+You can initialise your assets directory with the content provided in this repository
+```sh
+cp -r /public/assets/* /your/local/assets/
+```
+
+**Alternatively** if you just want to provide images/icons without customizing the other files (app manifest & pwa icons), you can mount a custom directory in the `www` directory and use it in your `config.yml` for icons path.
+
+### Using the release tarball (prebuilt, ready to use)
+
+Download and extract the latest the latest release (`homer.zip`) from the [release page](https://github.com/bastienwirtz/homer/releases), rename the `config.yml.dist` file to `config.yml`, and put it behind a webserver.
+```sh
+wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip
+unzip homer.zip
+cd homer
+cp config.yml.dist config.yml
+npx serve # or python -m http.server 8010 or apache, nginx ...
+```
+
+### Build manually
+
+```sh
+# 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
-## configuration
-
-Title, icons, links, colors, and services can be configured in the `config.yml` file, using [yaml](http://yaml.org/) format.
-
-
-```yaml
----
-# Homepage configuration
-# See https://fontawesome.com/v4.7.0/icons/ for icons options
-
-title: "Simple homepage"
-subtitle: "Homer"
-logo: "assets/homer.png"
-
-# Optional message
-message:
- 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:
- - name: "ansible"
- icon: "fa-github"
- url: "https://github.com/xxxxx/ansible/"
- - 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 are optional, section separation will not be displayed).
-services:
- - name: "DevOps"
- icon: "fa-code-fork"
- items:
- - name: "Jenkins"
- logo: "/assets/tools/jenkins.png"
- subtitle: "Continuous integration server"
- tag: "CI"
- url: "#"
- - name: "RabbitMQ Management"
- logo: "/assets/tools/rabbitmq.png"
- subtitle: "Manage & monitor RabbitMQ server"
- tag: "haproxy"
- 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: "#"
-
-```
\ No newline at end of file
+- [ ] Add new themes.
+- [ ] Add support for custom service card (add custom feature to some service / app link)
projects / github / bastienwirtz / homer.git / blobdiff