Update docs.md
This commit is contained in:
parent
3ec38140be
commit
3ee3e36ca8
19
docs.md
19
docs.md
@ -1,8 +1,9 @@
|
||||
# Table of content
|
||||
# Documentation
|
||||
## Table of content
|
||||
- [Requirements](#requirements)
|
||||
- [Home Assistant general](#home-assistant-general)
|
||||
- Port
|
||||
- HTTP or HTTPS
|
||||
- [Port](#port)
|
||||
- [HTTP or HTTPS](#http-or-https)
|
||||
- SSL Certificates
|
||||
- Android
|
||||
- Authentication
|
||||
@ -10,8 +11,8 @@
|
||||
- Lovelace UI
|
||||
- Log Viewer
|
||||
|
||||
# Requirements
|
||||
## Home Assistant general
|
||||
## Requirements
|
||||
### Home Assistant general
|
||||
To check if you are using right configuration for app, try to access your Home Assistant web interface with the same protocol (http:// or https://), the same domain or IP and port. If it is not loading – the app will not work as well.
|
||||
|
||||
To connect to your Home Assistant instance with HA Client you need `http` and `websocket_api` components to be enabled as well as [remote access](https://www.home-assistant.io/docs/configuration/remote/) configured. If you are using `frontend` component (Home Assistant web interface actually) `websocket_api` is enabled by default and `http` component is already configured on your server, but still you need to double check.
|
||||
@ -26,3 +27,11 @@ http:
|
||||
|
||||
websocket_api:
|
||||
```
|
||||
## Port
|
||||
By default your Home Assistant is using port number `8123`. But to access your instance from outside of your home network, probably you configured some port forwarding rules on you router. If you forward some other port from outside to `8123` port on Home Assistant IP, you need to use that port instead.
|
||||
|
||||
If you are accessing your web interface without port, then you need to try port `80` or `443` in app.
|
||||
## HTTP or HTTPS
|
||||
It is not required to use secure connection. Just remember: if you are accessing your web interface with http, you need to switch “Use ssl” off in app settings as well.
|
||||
|
||||
But if you are using ssl (accessing web interface with https://) – your certificate should be valid (not self-signed).
|
||||
|
Reference in New Issue
Block a user