From b5bf977402c4bedd7c2ca771592635ac8dd07dca Mon Sep 17 00:00:00 2001 From: Bastien Wirtz Date: Wed, 29 Jun 2022 23:02:10 +0200 Subject: Adding permissions configuration information. --- README.md | 21 +++++++-------------- 1 file changed, 7 insertions(+), 14 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 5a08483..ea93f4f 100644 --- a/README.md +++ b/README.md @@ -65,9 +65,9 @@ ## 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 @@ -79,7 +79,9 @@ docker run -d \ b4bz/homer:latest ``` -Environment variables: +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. + +**Environment variables:** * **`INIT_ASSETS`** (default: `1`) Install example configuration file & assets (favicons, ...) to help you get started. @@ -87,18 +89,9 @@ Install example configuration file & assets (favicons, ...) to help you get star * **`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`). +#### With docker-compose -### Using docker-compose - -The `docker-compose.yml` file must be edited to match your needs. -You probably want to set the port mapping and volume binding (equivalent to `-p` and `-v` arguments): - -```yaml -volumes: - - /your/local/assets/:/www/assets -ports: - - 8080:8080 -``` +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: -- cgit v1.2.3