yehor/ha-client-website
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update docs.md

Browse Source
This commit is contained in:
Yegor Vialov 2019-02-08 20:18:32 +02:00 committed by GitHub
parent cab9cfc8df
commit 3aff5da3fd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs.md
View File

@ -6,9 +6,9 @@
- [HTTP or HTTPS](#http-or-https) - [HTTP or HTTPS](#http-or-https)
- [SSL Certificates](#ssl-certificates) - [SSL Certificates](#ssl-certificates)
- [Android](#android) - [Android](#android)
- Authentication - [Authentication](#authentication)
- UI configuration - [UI configuration](#ui_configuration)
- Log Viewer - [Log Viewer](#log-viewer)
## Requirements ## Requirements
### Home Assistant general ### Home Assistant general
@ -26,24 +26,29 @@ http:
websocket_api: websocket_api:
``` ```
[Back to top](#documentation) [Back to top](#documentation)
### Port ### 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. 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. If you are accessing your web interface without port, then you need to try port `80` or `443` in app.
[Back to top](#documentation) [Back to top](#documentation)
### HTTP or HTTPS ### 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. 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). But if you are using ssl (accessing web interface with https://) – your certificate should be valid (not self-signed).
[Back to top](#documentation) [Back to top](#documentation)
### SSL Certificates ### SSL Certificates
The main requirement is that your SSL Certificate should not be self-signed. Most certificates from providers like Let’s Encrypt will work. There is [known issue](https://github.com/estevez-dev/ha_client_pub/issues/24) with RapidSSL certificate, but this problem is common not only for HA Client. The main requirement is that your SSL Certificate should not be self-signed. Most certificates from providers like Let’s Encrypt will work. There is [known issue](https://github.com/estevez-dev/ha_client_pub/issues/24) with RapidSSL certificate, but this problem is common not only for HA Client.
Using of self-signed certificate is not possible for now and this is a restriction of Flutter’s WebSocket implementation. To stay up to date with this issue solving or possible workarounds please [follow this issue in GitHub](https://github.com/estevez-dev/ha_client_pub/issues/3). Using of self-signed certificate is not possible for now and this is a restriction of Flutter’s WebSocket implementation. To stay up to date with this issue solving or possible workarounds please [follow this issue in GitHub](https://github.com/estevez-dev/ha_client_pub/issues/3).
[Back to top](#documentation) [Back to top](#documentation)
### Android ### Android
Minimum supported Android API level is 21. That’s Android 5.0 and higher. Minimum supported Android API level is 21. That’s Android 5.0 and higher.
[Back to top](#documentation) [Back to top](#documentation)
## Authentication ## Authentication
Starting from Home Assistant 0.78.0 `api_password` is a deprecated way to authenticate third party apps and services. You should use long-lived access tokens instead. To make HA Client use access token to authenticate you need: Starting from Home Assistant 0.78.0 `api_password` is a deprecated way to authenticate third party apps and services. You should use long-lived access tokens instead. To make HA Client use access token to authenticate you need:
@ -60,11 +65,13 @@ Starting from Home Assistant 0.78.0 `api_password` is a deprecated way to authen
![image](/assets/images/setting_access_token.png) ![image](/assets/images/setting_access_token.png)
[Back to top](#documentation)
## UI Configuration ## UI Configuration
By default HA Client UI is based on your Lovelace UI config, so it should display the same views as your Home Assistant web UI. It is still possible to switch off Lovelace UI in app settings. In this canse app UI will be based on groups configuration, the same as old Home Assistant UI. By default HA Client UI is based on your Lovelace UI config, so it should display the same views as your Home Assistant web UI. It is still possible to switch off Lovelace UI in app settings. In this canse app UI will be based on groups configuration, the same as old Home Assistant UI.
![image](/assets/images/setting_ui.png) ![image](/assets/images/setting_ui.png)
[Back to top](#documentation)
## Log Viewer ## Log Viewer
There is a built in debug messages viewer in the app. You can access it by *Log* item in main menu. It will be very helpful if you will attach a copy of this log to your issue report. It is easy to do with button in header (![image](/assets/images/log_copy_btn.png)) that will copy all log entries to clipboard. There is a built in debug messages viewer in the app. You can access it by *Log* item in main menu. It will be very helpful if you will attach a copy of this log to your issue report. It is easy to do with button in header (![image](/assets/images/log_copy_btn.png)) that will copy all log entries to clipboard.