X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;ds=inline;f=README.md;h=944179877705d1d6f026eb02fad74385e9c5f416;hb=077be43473ebdb241c6a70e4d06795ca80a591fb;hp=7d76b0e4b1ae69474c1b3d3e3a15aa2bf47aa643;hpb=b102c9b2b3aaa4d66bda8d932ba2d6bd4575c044;p=github%2Fbastienwirtz%2Fhomer.git
diff --git a/README.md b/README.md
index 7d76b0e..9441798 100644
--- a/README.md
+++ b/README.md
@@ -1,30 +1,58 @@
-# 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)
+
+
+
+ Homer
+
+
+
+ A dead simple static HOMepage for your servER to keep your services on hand, from a simple 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)
## Features
- [yaml](http://yaml.org/) file configuration
- Installable (pwa)
- Search
-- Grouping
+- Grouping
- Theme customization
- Offline heathcheck
- keyboard shortcuts:
@@ -42,16 +70,49 @@ See [documentation](docs/configuration.md) for information about the configurati
### 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" [...]`).
+### 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):
+
+```yaml
+volumes:
+ - /your/local/assets/:/www/assets
+ports:
+ - 8080:8080
+```
+
+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`:
+
+```yaml
+environment:
+ - 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 webserver.
+
```sh
wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip
unzip homer.zip
@@ -73,9 +134,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)