Disable service worker navigation fallback (Fix #486)

[github/bastienwirtz/homer.git] / docs / troubleshooting.md

diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
index 649e5a61fc959d437e0a47ccd1c14dc159798b8c..33b8fb7b9d196fa8febb52895ba17a1545ccb166 100644 (file)
--- a/docs/troubleshooting.md
+++ b/docs/troubleshooting.md
@@ -1,8 +1,32 @@
 # Troubleshooting
 
+## My docker container refuse to start / is stuck at restarting.
+
+You might be facing a permission issue. First of all, check your container logs (adjust the container name if necessary): 
+
+```sh
+$ docker logs homer
+[...]
+Assets directory not writable. Check assets directory permissions & docker user or skip default assets install by setting the INIT_ASSETS env var to 0
+```
+
+In 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.
+
+You can either: 
+- Update your assets directory permissions (ex: `chown -R 1000:1000 /your/assets/folder/`, `chmod -R u+rw /your/assets/folder/`)
+- Change the docker user by using the `--user` arguments with docker cli or `user: 1000:1000` with docker compose.
+
+⚠️ Notes: 
+
+- **Do not** use env var to set the GID / UID of the user running container. Use the Docker `user` option.
+- **Do not** use 0:0 as a user value, it would be a security risk, and it's not guaranty to work.
+
+Check this [thread](https://github.com/bastienwirtz/homer/issues/459) for more information about debugging
+permission issues.
+
 ## My custom service card doesn't work, nothing appears or offline status is displayed (pi-hole, sonarr, ping, ...)
 
-You might by facing a [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) (Cross Origin Request Sharing) issue.
+You might be facing a [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) (Cross Origin Request Sharing) issue.
 It happens when the targeted service is hosted on a different domain or port.
 Web browsers will not allow to fetch information from a different site without explicit permissions (the targeted service
 must include a special `Access-Control-Allow-Origin: *` HTTP headers).
@@ -17,3 +41,9 @@ To resolve this, you can either:
 * Host all your target service under the same domain & port.
 * Modify the target server configuration so that the response of the server included following header- `Access-Control-Allow-Origin: *` (<https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#simple_requests>). It might be an option in the targeted service, otherwise depending on how the service is hosted, the proxy or web server can seamlessly add it.
 * Use a cors proxy server like [`cors-container`](https://github.com/imjacobclark/cors-container), [`cors-anywhere`](https://github.com/Rob--W/cors-anywhere) or many others.
+
+## I am using an authentication proxy and homer says I am offline
+
+This should be a configuration issue.
+* Make sure the option `connectivityCheck` is set to `true` in configuration.
+* Check your proxy configuration, the expected behavior is to redirect user using a 302 to the login page when user is not authenticated.