Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Configuration block in README.md #57

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,15 +105,36 @@ and link resulting tree to `kernel` symlink:

## Configuration

### Configuration file path

The configuration file must be located in the directory: `/etc/amnezia/amneziawg/`

The configuration file name must comply with the following regular expression: `awg[0-9]+\.conf`

### Configuration file content

> [!IMPORTANT]
> All parameters should be the same between Client and Server, except Jc - it can vary.

#### `[Interface]` block:

- Jc — 1 ≤ Jc ≤ 128; recommended range is from 3 to 10 inclusive
- Jmin — Jmin < Jmax; recommended value is 50
- Jmax — Jmin < Jmax ≤ 1280; recommended value is 1000
- S1 — S1 < 1280; S1 + 56 ≠ S2; recommended range is from 15 to 150 inclusive
- S2 — S2 < 1280; recommended range is from 15 to 150 inclusive
- H1/H2/H3/H4 — must be unique among each other; recommended range is from 5 to 2147483647 inclusive
- Address — The IP address and subnet assigned to the local interface (e.g., 10.0.0.1/24).
- DNS — DNS server(s) to use for name resolution when this interface is active.
- PrivateKey — The private key of the local WireGuard interface (kept secret).

#### `[Peer]` block

- PublicKey — The public key of the remote peer (shared openly).
- PresharedKey — An optional shared key for added encryption security between peers.
- AllowedIPs — The list of IPs/routes allowed through the tunnel (e.g., 0.0.0.0/0 for all traffic).
- Endpoint — The public IP address and port of the remote WireGuard peer.
- PersistentKeepalive — Optional parameter to maintain the connection when behind NAT (value in seconds, e.g., 25).

## Troubleshooting

Expand Down