X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=5a08483aa48840a962bf50a0925e7a10db87964c;hb=refs%2Fpull%2F475%2Fhead;hp=59b358fac5aa666184bcfc59f2c8d99018925b90;hpb=5fe53dce3c1e1d3357f614b0157dc55079dff913;p=github%2Fbastienwirtz%2Fhomer.git diff --git a/README.md b/README.md index 59b358f..5a08483 100644 --- a/README.md +++ b/README.md @@ -1,105 +1,134 @@ -# Homer -A dead simple static **HOM**epage for your serv**ER** to keep your services on hand, from a simple `yaml` configuration file. +
yaml
configuration file.
++ + Demo + ⢠+ Chat + ⢠+ Getting started + +
+ + ++ +
+ +## Table of Contents + +- [Features](#features) +- [Getting started](#getting-started) +- [Configuration](docs/configuration.md) +- [Custom services](docs/customservices.md) +- [Tips & tricks](docs/tips-and-tricks.md) +- [Development](docs/development.md) +- [Troubleshooting](docs/troubleshooting.md) + +## Features + +- [yaml](http://yaml.org/) 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](docs/configuration.md) for information about the configuration (`assets/config.yml`) options. + +### Using docker + +```sh +docker run -d \ + -p 8080:8080 \ + -v :/www/assets \ + --restart=always \ + b4bz/homer:latest +``` -**Check out the live demo [here](https://homer-demo.netlify.com/).** +Environment variables: -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, ...) +* **`INIT_ASSETS`** (default: `1`) +Install example configuration file & assets (favicons, ...) to help you get started. -![screenshot](https://github.com/bastienwirtz/homer/blob/master/screenshot.png) +* **`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`). -**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`. +### Using docker-compose -## configuration +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): -Title, icons, links, colors, and services can be configured in the `config.yml` file, using [yaml](http://yaml.org/) format. +```yaml +volumes: + - /your/local/assets/:/www/assets +ports: + - 8080:8080 +``` +Then launch the container: -```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" - -# Optional message -message: - # url: "https://