hassio-addons/addon-wireguard
1
0
Fork 0
mirror of https://github.com/hassio-addons/addon-wireguard.git synced 2025-05-05 03:11:22 +00:00
Code Issues Projects Releases Packages Wiki Activity

📚 Small documentation tweaks and updates (#202)

Browse source
This commit is contained in:
Franck Nijhof 2022-06-12 21:12:29 +02:00 • committed by GitHub
parent 48b68b4d38
commit d34a90de23
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

18
wireguard/DOCS.md
View file

@ -24,15 +24,19 @@ for you (if you want).
Follow the following steps for installation & a quick start: Follow the following steps for installation & a quick start:
1. Search for the "WireGuard" add-on in the Supervisor add-on store 1. Click the Home Assistant My button below to open the add-on on your Home
and install it. Assistant instance.
1. Set the `host` configuration option to your Hass.io (external) address,
e.g., `myautomatedhome.duckdns.org`. [![Open this add-on in your Home Assistant instance.][addon-badge]][addon]
1. Click the "Install" button to install the add-on.
1. Set the `host` configuration option to your Home Assistant (external)
address, e.g., `myautomatedhome.duckdns.org`.
1. Change the name of the peer to something useful, e.g., `myphone`. 1. Change the name of the peer to something useful, e.g., `myphone`.
1. Save the configuration. 1. Save the configuration.
1. Start the "WireGuard" add-on 1. Start the "WireGuard" add-on
1. Check the logs of the "WireGuard" add-on to see if everything went well. 1. Check the logs of the "WireGuard" add-on to see if everything went well.
1. Forward port `51820` (UDP!) in your router to your Hass.io IP. 1. Forward port `51820` (UDP!) in your router to your Home Assistant instance.
1. Download/Open the file `/ssl/wireguard/myphone/qrcode.png` stored on your 1. Download/Open the file `/ssl/wireguard/myphone/qrcode.png` stored on your
Home Assistant instance, e.g., using Samba, Visual Studio Code or the Home Assistant instance, e.g., using Samba, Visual Studio Code or the
Configurator add-on. Configurator add-on.
@ -92,7 +96,7 @@ to your WireGuard add-on. The `host` is mainly used to generate client
configurations and SHOULD NOT contain a port. If you want to change the port, configurations and SHOULD NOT contain a port. If you want to change the port,
use the "Network" section of the add-on configuration. use the "Network" section of the add-on configuration.
Example: `myautomatedhome.duckdns.org`, for local testing `hassio.local` Example: `myautomatedhome.duckdns.org`, for local testing `homeassistant.local`
will actually work. will actually work.
DO NOT attempt to use a URL such as a Nabu Casa endpoint, the entry needs to be DO NOT attempt to use a URL such as a Nabu Casa endpoint, the entry needs to be
@ -528,6 +532,8 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. SOFTWARE.
[addon-badge]: https://my.home-assistant.io/badges/supervisor_addon.svg
[addon]: https://my.home-assistant.io/redirect/supervisor_addon/?addon=a0d7b954_wireguard&repository_url=https%3A%2F%2Fgithub.com%2Fhassio-addons%2Frepository
[adguard]: https://github.com/hassio-addons/addon-adguard-home [adguard]: https://github.com/hassio-addons/addon-adguard-home
[contributors]: https://github.com/hassio-addons/addon-wireguard/graphs/contributors [contributors]: https://github.com/hassio-addons/addon-wireguard/graphs/contributors
[discord-ha]: https://discord.gg/c5DvZ4e [discord-ha]: https://discord.gg/c5DvZ4e