1 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**.
3 See [documentation](docs/configuration.md) for information about the configuration (`assets/config.yml`) options.
12 -v </your/local/assets/>:/www/assets \
17 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" [...]`).
19 ## Using docker-compose
21 The `docker-compose.yml` file must be edited to match your needs.
22 Set the port and volume (equivalent to `-p` and `-v` arguments):
26 - /your/local/assets/:/www/assets
34 cd /path/to/docker-compose.yml
38 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`:
46 ## Using the release tarball (prebuilt, ready to use)
48 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.
51 wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip
54 cp assets/config.yml.dist assets/config.yml
55 npx serve # or python -m http.server 8010 or apache, nginx ...
61 # Using yarn (recommended)
70 Then your dashboard is ready to use in the `/dist` directory.