X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=529ceff638b985ae1aa682e18db88832f0cf08d3;hb=db2814237443bb68c11c728d5206679d3cc38e94;hp=2dd2b42b50dd6bba697c50b7404ec55b01a4d176;hpb=7129af3bda3a7a7d506bd8c8f122ad8995c2906c;p=github%2Fbastienwirtz%2Fhomer.git
diff --git a/README.md b/README.md
index 2dd2b42..529ceff 100644
--- a/README.md
+++ b/README.md
@@ -30,6 +30,9 @@
+
@@ -56,7 +59,7 @@
- Search
- Grouping
- Theme customization
-- Offline heath check
+- Offline health check
- keyboard shortcuts:
- `/` Start searching.
- `Escape` Stop searching.
@@ -65,14 +68,12 @@
## 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 \
@@ -81,33 +82,29 @@ 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:
+* **`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
-```yaml
-environment:
- - UID=1000
- - GID=1000
+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).
+
+Then launch the container:
+
+```sh
+cd /path/to/docker-compose.yml/
+docker-compose up -d
```
### Using the release tarball (prebuilt, ready to use)