Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
UplandJacob authored Aug 22, 2024
1 parent 593f381 commit 1e9b7d2
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions twingate/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,45 @@
# Twingate

![Addon Stage][stage-badge]
![Supports aarch64 Architecture][aarch64-badge]
![Supports amd64 Architecture][amd64-badge]
![NO Supports armhf Architecture][armhf-badge]
![Supports armv7 Architecture][armv7-badge]
![Supports i386 Architecture][i386-badge]


[![Install on my Home Assistant][install-badge]][install-url]


## About
Deploy a twingate connector from Home Assistant.

## Install
[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](repository_url)
[![Add repository on my Home Assistant][repository-badge]][repository-url]

or go to the **Add-on Store -> repositories** and add: https://github.com/UplandJacob/Upland-HA-Addons

[![Install on my Home Assistant][install-badge]][install-url]

## Setup
1. Go to [twingate.com](https://www.twingate.com) and create an account and network.
2. Create a remote network and resource.
3. Create a connector, choose 'docker', generate tokens and input the extra options however you want.
4. in the 'Configuration' tab of this addon, copy in the information from the Twingate website.




[aarch64-badge]: https://img.shields.io/badge/aarch64-yes-green.svg?style=for-the-badge
[amd64-badge]: https://img.shields.io/badge/amd64-yes-green.svg?style=for-the-badge
[armhf-badge]: https://img.shields.io/badge/armhf-yes-green.svg?style=for-the-badge
[armv7-badge]: https://img.shields.io/badge/armv7-yes-green.svg?style=for-the-badge
[i386-badge]: https://img.shields.io/badge/i386-yes-green.svg?style=for-the-badge
[stage-badge]: https://img.shields.io/badge/Addon%20stage-stable-green.svg?style=for-the-badge
[install-badge]: https://img.shields.io/badge/Install%20on%20my-Home%20Assistant-41BDF5?logo=home-assistant&style=for-the-badge

[repository-badge]: https://img.shields.io/badge/Add%20repository%20to%20my-Home%20Assistant-41BDF5?logo=home-assistant&style=for-the-badge

[install-url]: https://my.home-assistant.io/redirect/supervisor_addon?addon=
[repository-url]: https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https://github.com/UplandJacob/Upland-HA-Addons

0 comments on commit 1e9b7d2

Please sign in to comment.