update README.md
This commit is contained in:
parent
9829eaa874
commit
a4966cb70b
2 changed files with 22 additions and 5 deletions
27
README.md
27
README.md
|
@ -1,5 +1,22 @@
|
|||
### This Add-on is still in developement and not published yet. To install it:
|
||||
- connect to your Home Assistant instance via SSH
|
||||
- create a new folder in /addons, and then clone this repo into that folder.
|
||||
- open the Add-on Store and Check for Updates, then refresh and the Plugin should appear
|
||||
- Rest is self explanatory
|
||||
### FRP for Home Assistant
|
||||
<a href="https://github.com/fatedier/frp">FRP</a> (Fast Reverse Proxy) allows you to quickly setup Remote Access for your Home Assistant instance, if you already have a public VPS with a public IPv4. This is helpful because many home internet connections nowadays, with things like DS-Lite, no longer have their own public IPv4 address, making port forwarding a nightmare.
|
||||
|
||||
To setup a FRP Server, please refer to the original projects documentation. This Readme is just for setting up the Add-on to an existing FRP server
|
||||
|
||||
### Config
|
||||

|
||||
|
||||
- Server Address
|
||||
- your FRP Servers Address
|
||||
- Server Port
|
||||
- your FRP Servers Port (default is ```7000```)
|
||||
- Token
|
||||
- your FRP Servers Token
|
||||
- Not necessary but recommended to setup a token on ur FRP server
|
||||
- Local IP
|
||||
- your Actual local IP address, not just ```localhost``` or ```127.0.0.1```
|
||||
- local Port
|
||||
- your local Home Assistant Lovelace Port (default is ```8123```
|
||||
- remote Port
|
||||
- the port you want Home Assistant to be exposed on on the Remote IP
|
||||
- leave as default ```8123``` if you have no reason to change it
|
BIN
img_1.png
Normal file
BIN
img_1.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 20 KiB |
Loading…
Add table
Reference in a new issue