You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+12-9
Original file line number
Diff line number
Diff line change
@@ -31,20 +31,23 @@ Search for "Uptime Kuma" in the HACS store. If you don't see it there, you can [
31
31
After installation, setup the integration via the web UI like any other integration. When prompted, provide the following:
32
32
33
33
### HTTPS Connections:
34
-
- Your UptimeKuma instance url (i.e. https://myuptimekuma.mydomain.com)
35
-
- Port (Generally 443 if running behind reverse proxy)
36
-
- Your uptimekuma credentials
37
-
- NOTE: If you have issues connecting, try creating an uptimekuma API key and using that with NO username for the credentials. If you are still having issues,make sure you can successfully connect to `http(s)://your_uptimekuma.url/metrics`
38
-
- Verify SSL (Generally checked)
34
+
-URL: Your UptimeKuma instance url (i.e. https://myuptimekuma.mydomain.com)
35
+
- Port: (Generally 443 if running behind reverse proxy)
36
+
-User: Your uptimekuma Username
37
+
- Password: API Key (UptimeKuma > Settings > API Keys)
38
+
- Verify SSL: (Generally checked)
39
39
40
40
### HTTP Connections:
41
-
- Your UptimeKuma instance url :http://xxx.xxx.xxx.xxx
41
+
-URL: Your UptimeKuma instance url (i.e.http://xxx.xxx.xxx.xxx)
42
42
- Port : 3001
43
-
- Your uptimekuma credentials:
44
-
- user: (i.e admin)
45
-
- pass : API password from within UptimeKuma
43
+
- User: Your uptimekuma Username
44
+
- Password: API Key (UptimeKuma > Settings > API Keys)
46
45
- Verify SSL: Unchecked
47
46
47
+
### Troubleshooting
48
+
49
+
If you are having issues connecting, make sure you can successfully connect to `http(s)://your_uptimekuma.url/metrics` using a private browser window.
50
+
There have also been reports of non-ssl instances not being entirely reliable. It is recommended to use a valid SSL certificate. This is made easy by projects like [NGINXProxyManager](https://nginxproxymanager.com/), [Traefik](https://doc.traefik.io/traefik/), [Caddy](https://caddyserver.com/), and others.
0 commit comments