Skip to content

Commit

Permalink
Update readme and library for version 0.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
droscy committed May 20, 2023
1 parent f686fec commit e70aebf
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 5 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ for `esp-idf` only but it seems to work on `Arduino` too.

## Usage

Add the following configuration to your `yaml` file:
Add the following configuration to your ESPHome `yaml` file:

```yaml
# Define wireguard external source
Expand All @@ -55,9 +55,9 @@ time:
# Setup WireGuard
wireguard:
address: x.y.z.w
private_key: !secret wg_privkey
private_key: private_key=
peer_endpoint: wg.server.example
peer_public_key: !secret wg_peer_pubkey
peer_public_key: public_key=

# optional netmask (this is the default if omitted)
netmask: 255.255.255.255
Expand All @@ -66,10 +66,19 @@ wireguard:
peer_port: 51820

# optional pre-shared key
peer_preshared_key: !secret wg_peer_shrdkey
peer_preshared_key: shared_key=

# optional keepalive in seconds (disabled by default)
peer_persistent_keepalive: 25

# optional list of allowed ip/mask (the default is to allow any host if omitted)
peer_allowed_ips:
- x.y.z.0/24
- l.m.n.o/32 # the /32 can be omitted for single host
- [...]

# reboot the board if remote peer in unreachable (default to 15min, set to 0s to disable)
reboot_timeout: 15min
```
### Sensors
Expand Down
2 changes: 1 addition & 1 deletion library.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "esp_wireguard",
"version": "0.2.0-aip3b",
"version": "0.2.0",
"description": "WireGuard implementation for ESPHome",
"keywords":[
"communication",
Expand Down

0 comments on commit e70aebf

Please sign in to comment.