X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=529ceff638b985ae1aa682e18db88832f0cf08d3;hb=db2814237443bb68c11c728d5206679d3cc38e94;hp=33716f63607fcc9fa76aac5bb59f24ce34d70a87;hpb=86f4680a5bc3b4cdfd865ff90d435fa7ad2d5376;p=github%2Fbastienwirtz%2Fhomer.git diff --git a/README.md b/README.md index 33716f6..529ceff 100644 --- a/README.md +++ b/README.md @@ -1,113 +1,115 @@

- 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"> + speed-blazing + 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) - [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 :` to the docker command to adjust it. Make sure this match the ownership of your assets directory. -### Using docker-compose +**Environment variables:** -The `docker-compose.yml` file must be edited to match your needs. -Set the port and volume (equivalent to `-p` and `-v` arguments): +* **`INIT_ASSETS`** (default: `1`) +Install example configuration file & assets (favicons, ...) to help you get started. -```yaml -volumes: - - /your/local/assets/:/www/assets -ports: - - 8080:8080 -``` +* **`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`). -To launch container: +* **`PORT`** (default: `8080`) +If you would like to change internal port of Homer from default `8080` to your port choice. -```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`: +#### With docker-compose + +A [`docker-compose.yml`](docker-compose.yml) file is available as an example. It must be edited to match your needs. You probably want to adjust the port mapping and volume binding (equivalent to `-p` and `-v` arguments). -```yaml -environment: - - UID=1000 - - GID=1000 +Then launch the container: + +```sh +cd /path/to/docker-compose.yml/ +docker-compose up -d ``` ### Using the release tarball (prebuilt, ready to use) -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. +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 @@ -130,9 +132,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)