aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/troubleshooting.md
diff options
context:
space:
mode:
authorBastien Wirtz <bastien.wirtz@gmail.com>2022-06-29 23:02:10 +0200
committerBastien Wirtz <bastien.wirtz@gmail.com>2022-06-29 23:02:10 +0200
commitb5bf977402c4bedd7c2ca771592635ac8dd07dca (patch)
tree14bb39c61f2066e9eb813197a82a2bcf75e231e4 /docs/troubleshooting.md
parenta01c40d4b34e1c4afea5b8e52f69e9a328b51d33 (diff)
downloadhomer-b5bf977402c4bedd7c2ca771592635ac8dd07dca.tar.gz
homer-b5bf977402c4bedd7c2ca771592635ac8dd07dca.tar.zst
homer-b5bf977402c4bedd7c2ca771592635ac8dd07dca.zip
Adding permissions configuration information.
Diffstat (limited to 'docs/troubleshooting.md')
-rw-r--r--docs/troubleshooting.md26
1 files changed, 25 insertions, 1 deletions
diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
index 10d6c2d..33b8fb7 100644
--- a/docs/troubleshooting.md
+++ b/docs/troubleshooting.md
@@ -1,8 +1,32 @@
1# Troubleshooting 1# Troubleshooting
2 2
3## My docker container refuse to start / is stuck at restarting.
4
5You might be facing a permission issue. First of all, check your container logs (adjust the container name if necessary):
6
7```sh
8$ docker logs homer
9[...]
10Assets directory not writable. Check assets directory permissions & docker user or skip default assets install by setting the INIT_ASSETS env var to 0
11```
12
13In this case you need to make sure your mounted assests directory have the same GID / UID the container user have (default 1000:1000), and that the read and write permission is granted for the user or the group.
14
15You can either:
16- Update your assets directory permissions (ex: `chown -R 1000:1000 /your/assets/folder/`, `chmod -R u+rw /your/assets/folder/`)
17- Change the docker user by using the `--user` arguments with docker cli or `user: 1000:1000` with docker compose.
18
19⚠️ Notes:
20
21- **Do not** use env var to set the GID / UID of the user running container. Use the Docker `user` option.
22- **Do not** use 0:0 as a user value, it would be a security risk, and it's not guaranty to work.
23
24Check this [thread](https://github.com/bastienwirtz/homer/issues/459) for more information about debugging
25permission issues.
26
3## My custom service card doesn't work, nothing appears or offline status is displayed (pi-hole, sonarr, ping, ...) 27## My custom service card doesn't work, nothing appears or offline status is displayed (pi-hole, sonarr, ping, ...)
4 28
5You might by facing a [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) (Cross Origin Request Sharing) issue. 29You might be facing a [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) (Cross Origin Request Sharing) issue.
6It happens when the targeted service is hosted on a different domain or port. 30It happens when the targeted service is hosted on a different domain or port.
7Web browsers will not allow to fetch information from a different site without explicit permissions (the targeted service 31Web browsers will not allow to fetch information from a different site without explicit permissions (the targeted service
8must include a special `Access-Control-Allow-Origin: *` HTTP headers). 32must include a special `Access-Control-Allow-Origin: *` HTTP headers).