aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorBastien Wirtz <bastien.wirtz@gmail.com>2021-09-13 13:09:40 -0700
committerGitHub <noreply@github.com>2021-09-13 13:09:40 -0700
commit92d5b8d424cbd4c227c9c76931930787deec4a2f (patch)
treeaa52c1955c9cf210bd95ad32e20f1b4286f7c0a7 /README.md
parent97f0c43ccc724ec4502e55f73874a89f822f0a81 (diff)
parent55c3ea4d92b0c5628ead4475ae7359bbf2cc59c4 (diff)
downloadhomer-92d5b8d424cbd4c227c9c76931930787deec4a2f.tar.gz
homer-92d5b8d424cbd4c227c9c76931930787deec4a2f.tar.zst
homer-92d5b8d424cbd4c227c9c76931930787deec4a2f.zip
Merge branch 'main' into main
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 6 insertions, 8 deletions
diff --git a/README.md b/README.md
index 33716f6..9441798 100644
--- a/README.md
+++ b/README.md
@@ -43,8 +43,8 @@
43- [Features](#features) 43- [Features](#features)
44- [Getting started](#getting-started) 44- [Getting started](#getting-started)
45- [Configuration](docs/configuration.md) 45- [Configuration](docs/configuration.md)
46- [Custom services](docs/customservices.md)
46- [Tips & tricks](docs/tips-and-tricks.md) 47- [Tips & tricks](docs/tips-and-tricks.md)
47- [Roadmap](#roadmap)
48- [Development](docs/development.md) 48- [Development](docs/development.md)
49 49
50 50
@@ -73,7 +73,11 @@ See [documentation](docs/configuration.md) for information about the configurati
73To launch container: 73To launch container:
74 74
75```sh 75```sh
76docker run -p 8080:8080 -v /your/local/assets/:/www/assets b4bz/homer:latest 76docker run -d \
77 -p 8080:8080 \
78 -v </your/local/assets/>:/www/assets \
79 --restart=always \
80 b4bz/homer:latest
77``` 81```
78 82
79Default 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" [...]`). 83Default 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" [...]`).
@@ -130,9 +134,3 @@ npm run build
130``` 134```
131 135
132Then your dashboard is ready to use in the `/dist` directory. 136Then your dashboard is ready to use in the `/dist` directory.
133
134
135## Roadmap
136
137- [ ] Add new themes.
138- [ ] Add support for custom service card (add custom feature to some service / app link)