aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorBastien Wirtz <bastien.wirtz@gmail.com>2020-06-23 22:56:33 -0700
committerBastien Wirtz <bastien.wirtz@gmail.com>2020-06-23 23:04:27 -0700
commita7ba289efa228613b18abc853c22fb3b5d99b9a7 (patch)
tree9ea0a10266d7bf00f235d95c6cae7b70cd31428d /README.md
parent796a16c8da1e40aef418559ade2252a5275708c8 (diff)
downloadhomer-a7ba289efa228613b18abc853c22fb3b5d99b9a7.tar.gz
homer-a7ba289efa228613b18abc853c22fb3b5d99b9a7.tar.zst
homer-a7ba289efa228613b18abc853c22fb3b5d99b9a7.zip
Regroup all editable files in one place
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 4 insertions, 12 deletions
diff --git a/README.md b/README.md
index 65ef9ab..f65b417 100644
--- a/README.md
+++ b/README.md
@@ -38,31 +38,23 @@ ervices on hand, from a simple `yaml` configuration file.
38 38
39Homer 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**. 39Homer 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
41For more information about the `config.yml` file see [configuration](docs/configuration.md) the section. 41See [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
46docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/local/assets/:/www/assets b4bz/homer:latest 46docker run -p 8080:8080 -v /your/local/assets/:/www/assets b4bz/homer:latest
47``` 47```
48 48
49As a bind mount is used here, docker will not copy the initial content of the `assets` directory to the mounted directory.
50You can initialise your assets directory with the content provided in this repository
51```sh
52cp -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
57### Using the release tarball (prebuilt, ready to use) 49### Using the release tarball (prebuilt, ready to use)
58 50
59Download 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. 51Download 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 52
61```sh 53```sh
62wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip 54wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip
63unzip homer.zip 55unzip homer.zip
64cd homer 56cd homer
65cp config.yml.dist config.yml 57cp assets/config.yml.dist assets/config.yml
66npx serve # or python -m http.server 8010 or apache, nginx ... 58npx serve # or python -m http.server 8010 or apache, nginx ...
67``` 59```
68 60