X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=5ea80fb84575b865f964fe2fa69be5fe58c8fd98;hb=refs%2Fpull%2F377%2Fhead;hp=b965f9b58374b083393115e04ea286c1ba90eb48;hpb=264410127684dd006bb5fab6b58d39141f9b3661;p=github%2Fbastienwirtz%2Fhomer.git diff --git a/README.md b/README.md index b965f9b..5ea80fb 100644 --- a/README.md +++ b/README.md @@ -1,67 +1,68 @@

- Homer's donut + Homer's donut
Homer

- A dead simple static HOMepage for your servER to keep your services on hand, from a simple `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 +

- License: Apache 2 + License: Apache 2 Gitter chat + alt="Gitter chat" + src="https://badges.gitter.im/homer-dashboard/community.svg"> Download homer static build - Awesome + alt="Download homer static build" + src="https://img.shields.io/badge/Download-homer.zip-orange"> + Awesome

- +

## 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) -- [Developement](docs/developement.md) - +- [Development](docs/development.md) +- [Troubleshooting](docs/troubleshooting.md) ## Features + - [yaml](http://yaml.org/) file configuration - Installable (pwa) - Search -- Grouping +- 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**. @@ -70,10 +71,14 @@ See [documentation](docs/configuration.md) for information about the configurati ### Using docker -To launch container : +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" [...]`). @@ -81,7 +86,7 @@ Default assets will be automatically installed in the `/www/assets` directory. U ### 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) : +Set the port and volume (equivalent to `-p` and `-v` arguments): ```yaml volumes: @@ -90,25 +95,25 @@ ports: - 8080:8080 ``` -To launch container : +To launch container: ```sh 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` : +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`: ```yaml environment: -- UID=1000 -- GID=1000 + - 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](https://github.com/bastienwirtz/homer/releases), rename the `assets/config.yml.dist` file to `assets/config.yml`, and put it behind a webserver. - +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 web server. + ```sh wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip unzip homer.zip @@ -130,9 +135,3 @@ 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)