X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;ds=inline;f=README.md;h=95faada1b13722bbab244c97de7c2578f1dc0830;hb=49c2023b8e7eea6b28113b43beca29ee865faebc;hp=33716f63607fcc9fa76aac5bb59f24ce34d70a87;hpb=86f4680a5bc3b4cdfd865ff90d435fa7ad2d5376;p=github%2Fbastienwirtz%2Fhomer.git diff --git a/README.md b/README.md index 33716f6..95faada 100644 --- a/README.md +++ b/README.md @@ -1,113 +1,117 @@
yaml
configuration file.
+ A dead simple static HOMepage for your servER to keep your services on hand, from a simple yaml
configuration file.
- - Demo - ⢠- Chat - ⢠- Getting started - + + Demo + ⢠+ Chat + ⢠+ Getting started +
- + + alt="Gitter chat" + src="https://badges.gitter.im/homer-dashboard/community.svg"> - + alt="Download homer static build" + src="https://img.shields.io/badge/Download-homer.zip-orange"> + +
- +
## 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) -- [Roadmap](#roadmap) - [Development](docs/development.md) - +- [Troubleshooting](docs/troubleshooting.md) ## Features + - [yaml](http://yaml.org/) file configuration - Installable (pwa) - Search - Grouping - Theme customization -- Offline heathcheck +- 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**. +Homer is a full static html/js dashboard, based on a simple yaml configuration file. See [documentation](docs/configuration.md) for information about the configuration (`assets/config.yml`) options. -See [documentation](docs/configuration.md) for information about the configuration (`assets/config.yml`) options. +It's meant to be served by an HTTP server, **it will not work if you open the index.html directly over file:// protocol**. ### Using docker -To launch container: - ```sh -docker run -p 8080:8080 -v /your/local/assets/:/www/assets b4bz/homer:latest +docker run -d \ + -p 8080:8080 \ + -v :/www/assets \ + --restart=always \ + 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" [...]`). +The container will run using a user uid and gid 1000. Add `--user