diff options
author | Tom Pansino <2768420+tpansino@users.noreply.github.com> | 2020-09-01 23:47:59 -0700 |
---|---|---|
committer | Tom Pansino <2768420+tpansino@users.noreply.github.com> | 2020-09-01 23:47:59 -0700 |
commit | fbe9338fd3a78141110530055c9b90a5958f845f (patch) | |
tree | 28903d9875cd07df41dd4c35eb8d7487a6bfbae6 /README.md | |
parent | 7e5ad02248551770613339957640f38d50ce670f (diff) | |
parent | 83665e4f48e8db29d74a2e84b8befb6076c08665 (diff) | |
download | homer-fbe9338fd3a78141110530055c9b90a5958f845f.tar.gz homer-fbe9338fd3a78141110530055c9b90a5958f845f.tar.zst homer-fbe9338fd3a78141110530055c9b90a5958f845f.zip |
Merge remote-tracking branch 'upstream/master' into feature/custom-card-colors
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 29 |
1 files changed, 29 insertions, 0 deletions
@@ -70,12 +70,41 @@ See [documentation](docs/configuration.md) for information about the configurati | |||
70 | 70 | ||
71 | ### Using docker | 71 | ### Using docker |
72 | 72 | ||
73 | To launch container : | ||
74 | |||
73 | ```sh | 75 | ```sh |
74 | docker run -p 8080:8080 -v /your/local/assets/:/www/assets b4bz/homer:latest | 76 | docker run -p 8080:8080 -v /your/local/assets/:/www/assets b4bz/homer:latest |
75 | ``` | 77 | ``` |
76 | 78 | ||
77 | 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" [...]`). | 79 | 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" [...]`). |
78 | 80 | ||
81 | ### Using docker-compose | ||
82 | |||
83 | The `docker-compose.yml` file must be edited to match your needs. | ||
84 | Set the port and volume (equivalent to -p and -v arguments) : | ||
85 | |||
86 | ```yaml | ||
87 | volumes: | ||
88 | - /your/local/assets/:/www/assets | ||
89 | ports: | ||
90 | - 8080:8080 | ||
91 | ``` | ||
92 | |||
93 | To launch container : | ||
94 | |||
95 | ```sh | ||
96 | cd /path/to/docker-compose.yml | ||
97 | docker-compose up -d | ||
98 | ``` | ||
99 | |||
100 | 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` : | ||
101 | |||
102 | ```yaml | ||
103 | environment: | ||
104 | - UID=1000 | ||
105 | - GID=1000 | ||
106 | ``` | ||
107 | |||
79 | ### Using the release tarball (prebuilt, ready to use) | 108 | ### Using the release tarball (prebuilt, ready to use) |
80 | 109 | ||
81 | 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. | 110 | 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. |