X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=d69796aa3494cc924d7b50cc3df5a7d432810357;hb=e3b68ddc427a62fb77acd709b2dbdc8681c49158;hp=65ef9ab92fc21fe5fc1d088df9ecaf3249c9bdf4;hpb=5f71d1ea01c54a79fb8f459f8acbe92b0ea99c61;p=github%2Fbastienwirtz%2Fhomer.git diff --git a/README.md b/README.md index 65ef9ab..d69796a 100644 --- a/README.md +++ b/README.md @@ -1,71 +1,143 @@ -# Homer -[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) -[![Contribution Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com) -[![Gitter](https://badges.gitter.im/homer-dashboard/community.svg)](https://gitter.im/homer-dashboard/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) -[![Dowload](https://img.shields.io/badge/Dowload-homer.zip-orange)](https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip) -[![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/awesome-selfhosted/awesome-selfhosted) - -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) -![screenshot](https://raw.github.com/bastienwirtz/homer/master/screenshot.png) +
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) -- [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**. +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. -For more information about the `config.yml` file see [configuration](docs/configuration.md) the section. +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 ```sh -docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/local/assets/:/www/assets b4bz/homer:latest +docker run -d \ + -p 8080:8080 \ + -v :/www/assets \ + --restart=always \ + 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 +The container will run using a user uid and gid 1000. Add `--user