diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 21 |
1 files changed, 7 insertions, 14 deletions
@@ -65,9 +65,9 @@ | |||
65 | 65 | ||
66 | ## Getting started | 66 | ## Getting started |
67 | 67 | ||
68 | 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**. | 68 | 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. |
69 | 69 | ||
70 | See [documentation](docs/configuration.md) for information about the configuration (`assets/config.yml`) options. | 70 | It's meant to be served by an HTTP server, **it will not work if you open the index.html directly over file:// protocol**. |
71 | 71 | ||
72 | ### Using docker | 72 | ### Using docker |
73 | 73 | ||
@@ -79,7 +79,9 @@ docker run -d \ | |||
79 | b4bz/homer:latest | 79 | b4bz/homer:latest |
80 | ``` | 80 | ``` |
81 | 81 | ||
82 | Environment variables: | 82 | The container will run using a user uid and gid 1000. Add `--user <your-UID>:<your-GID>` to the docker command to adjust it. Make sure this match the ownership of your assets directory. |
83 | |||
84 | **Environment variables:** | ||
83 | 85 | ||
84 | * **`INIT_ASSETS`** (default: `1`) | 86 | * **`INIT_ASSETS`** (default: `1`) |
85 | Install example configuration file & assets (favicons, ...) to help you get started. | 87 | 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 | |||
87 | * **`SUBFOLDER`** (default: `null`) | 89 | * **`SUBFOLDER`** (default: `null`) |
88 | If you would like to host Homer in a subfolder, (ex: *http://my-domain/**homer***), set this to the subfolder path (ex `/homer`). | 90 | If you would like to host Homer in a subfolder, (ex: *http://my-domain/**homer***), set this to the subfolder path (ex `/homer`). |
89 | 91 | ||
92 | #### With docker-compose | ||
90 | 93 | ||
91 | ### Using docker-compose | 94 | 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). |
92 | |||
93 | The `docker-compose.yml` file must be edited to match your needs. | ||
94 | You probably want to set the port mapping and volume binding (equivalent to `-p` and `-v` arguments): | ||
95 | |||
96 | ```yaml | ||
97 | volumes: | ||
98 | - /your/local/assets/:/www/assets | ||
99 | ports: | ||
100 | - 8080:8080 | ||
101 | ``` | ||
102 | 95 | ||
103 | Then launch the container: | 96 | Then launch the container: |
104 | 97 | ||