Browse Source

Update README.md

pull/4/head
Per-Arne Andersen 5 years ago
committed by GitHub
parent
commit
923e1f1ea9
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 8
      README.md

8
README.md

@ -12,9 +12,9 @@ The interface runs in docker and requires the host to have installed wireguard,
# Dependencies # Dependencies
* wireguard-dkms or Linux kernel >= 5.6 * wireguard-dkms or Linux kernel >= 5.6
* docker * python 3.6+
# Installation # Installation (Docker)
1. Enable ip forwarding with `sysctl -w net.ipv4.ip_forward=1` 1. Enable ip forwarding with `sysctl -w net.ipv4.ip_forward=1`
1.1. To make the forwarding persistent add `net.ipv4.ip_forward = 1` to `/etc/sysctl.d/99-sysctl.conf` 1.1. To make the forwarding persistent add `net.ipv4.ip_forward = 1` to `/etc/sysctl.d/99-sysctl.conf`
2. It is recommended to have a firewall protecting your services 2. It is recommended to have a firewall protecting your services
@ -52,6 +52,10 @@ perara/wireguard-manager
WEB_CONCURRENCY: 1 WEB_CONCURRENCY: 1
``` ```
# Install (OS)
- [Installation on Debian/Ubuntu](./docs/install_debian.md)
# Environment variables # Environment variables
| Environment | Description | Recommended | | Environment | Description | Recommended |
|------------------|--------------------------------------------------------------------------|-------------| |------------------|--------------------------------------------------------------------------|-------------|

Loading…
Cancel
Save