X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=33716f63607fcc9fa76aac5bb59f24ce34d70a87;hb=f81dc6f4888dbb64c7f86972016c1a7cb750fe99;hp=65ef9ab92fc21fe5fc1d088df9ecaf3249c9bdf4;hpb=5f71d1ea01c54a79fb8f459f8acbe92b0ea99c61;p=github%2Fbastienwirtz%2Fhomer.git
diff --git a/README.md b/README.md
index 65ef9ab..33716f6 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)
- [Tips & tricks](docs/tips-and-tricks.md)
-- [Roadmap](#roadmap)
-- [Developement](docs/developement.md)
+- [Roadmap](#roadmap)
+- [Development](docs/development.md)
## Features
- [yaml](http://yaml.org/) file configuration
- Installable (pwa)
- Search
-- Grouping
+- Grouping
- Theme customization
- Offline heathcheck
- keyboard shortcuts:
@@ -38,31 +66,54 @@ ervices on hand, from a simple `yaml` configuration file.
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**.
-For more information about the `config.yml` file see [configuration](docs/configuration.md) the section.
+See [documentation](docs/configuration.md) for information about the configuration (`assets/config.yml`) options.
### Using docker
+To launch container:
+
```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 -p 8080:8080 -v /your/local/assets/:/www/assets 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
```
-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
+To launch container:
+
```sh
-cp -r /public/assets/* /your/local/assets/
+cd /path/to/docker-compose.yml
+docker-compose up -d
```
-**Alternatively** if you just want to provide images/icons without customizing the other files (app manifest & pwa icons), you can mount a custom directory in the `www` directory and use it in your `config.yml` for icons path.
+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 `config.yml.dist` file to `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
cd homer
-cp config.yml.dist config.yml
+cp assets/config.yml.dist assets/config.yml
npx serve # or python -m http.server 8010 or apache, nginx ...
```