diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 16 |
1 files changed, 5 insertions, 11 deletions
@@ -38,31 +38,25 @@ ervices on hand, from a simple `yaml` configuration file. | |||
38 | 38 | ||
39 | 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**. | 39 | 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**. |
40 | 40 | ||
41 | For more information about the `config.yml` file see [configuration](docs/configuration.md) the section. | 41 | See [documentation](docs/configuration.md) for information about the configuration (`assets/config.yml`) options. |
42 | 42 | ||
43 | ### Using docker | 43 | ### Using docker |
44 | 44 | ||
45 | ```sh | 45 | ```sh |
46 | docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/local/assets/:/www/assets b4bz/homer:latest | 46 | docker run -p 8080:8080 -v /your/local/assets/:/www/assets b4bz/homer:latest |
47 | ``` | 47 | ``` |
48 | 48 | ||
49 | As a bind mount is used here, docker will not copy the initial content of the `assets` directory to the mounted directory. | 49 | 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" [...]`). |
50 | You can initialise your assets directory with the content provided in this repository | ||
51 | ```sh | ||
52 | cp -r /public/assets/* /your/local/assets/ | ||
53 | ``` | ||
54 | |||
55 | **Alternatively** if you just want to provide images/icons without customizing the other files (app manifest & pwa icons), you can mount a custom directory in the `www` directory and use it in your `config.yml` for icons path. | ||
56 | 50 | ||
57 | ### Using the release tarball (prebuilt, ready to use) | 51 | ### Using the release tarball (prebuilt, ready to use) |
58 | 52 | ||
59 | Download and extract the latest the latest release (`homer.zip`) from the [release page](https://github.com/bastienwirtz/homer/releases), rename the `config.yml.dist` file to `config.yml`, and put it behind a webserver. | 53 | Download and extract the latest 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. |
60 | 54 | ||
61 | ```sh | 55 | ```sh |
62 | wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip | 56 | wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip |
63 | unzip homer.zip | 57 | unzip homer.zip |
64 | cd homer | 58 | cd homer |
65 | cp config.yml.dist config.yml | 59 | cp assets/config.yml.dist assets/config.yml |
66 | npx serve # or python -m http.server 8010 or apache, nginx ... | 60 | npx serve # or python -m http.server 8010 or apache, nginx ... |
67 | ``` | 61 | ``` |
68 | 62 | ||