X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=ea93f4febf05614e5a54fb575a36535ac730eb62;hb=73d52dbd380471100a6a1eca341b0e98aa5c692e;hp=944179877705d1d6f026eb02fad74385e9c5f416;hpb=1ed0a2f387ebe3f0d0aef590087e351b9534efc0;p=github%2Fbastienwirtz%2Fhomer.git
diff --git a/README.md b/README.md
index 9441798..ea93f4f 100644
--- a/README.md
+++ b/README.md
@@ -1,77 +1,76 @@
- 
+
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
+
- 
+
+ alt="Gitter chat"
+ src="https://badges.gitter.im/homer-dashboard/community.svg">
- 
+ alt="Download homer static build"
+ src="https://img.shields.io/badge/Download-homer.zip-orange">
+
- 
+
## 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)
- [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 -d \
-p 8080:8080 \
@@ -80,38 +79,30 @@ docker run -d \
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:
+#### With docker-compose
-```sh
-cd /path/to/docker-compose.yml
-docker-compose up -d
-```
+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).
-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`:
+Then launch the container:
-```yaml
-environment:
- - UID=1000
- - GID=1000
+```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