Ruakij/RoutingTableToWg
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'dev' into release-0.1

Browse Source
This commit is contained in:
Ruakij 2022-11-15 19:25:27 +01:00
commit a5f2f5f102
1 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -36,13 +36,23 @@ In case routes clash or cant be added to Wireguard, Warnings will be logged.
## 1.2. Install ## 1.2. Install
### 1.2.1. Environment
Variable|Description|Default
-|-|-
`INTERFACE`* | Wireguard-Interface Name |
`FILTER_PROTOCOL` | Protocol to react on | All
`FILTER_TABLE` | Table to react on | All
*\* Required*
<br> <br>
### 1.2.1. Docker ### 1.2.2. Docker
Depending on the needs, the Container can be run in `network_mode: host` to be able to accessrouting-tables and interfaces of the host. Depending on the needs, the Container can be run in `network_mode: host` to be able to access routing-tables and interfaces of the host.
Additionally the capability `NET_ADMIN` is required for interacting with interfaces.
<details><summary><code>docker-compose.yml</code></summary> <details><summary><code>docker-compose.yml</code></summary>
@ -53,7 +63,9 @@ services:
routingTableWGTranslator: routingTableWGTranslator:
image: ruakij/RoutingTableWGTranslator image: ruakij/RoutingTableWGTranslator
restart: unless-stopped restart: unless-stopped
network_mode: "host" network_mode: host
cap_add:
- NET_ADMIN
environment: environment:
- INTERFACE="<wgInterfaceName or empty for wg0>" - INTERFACE="<wgInterfaceName or empty for wg0>"
``` ```
@ -61,7 +73,7 @@ services:
<br> <br>
### 1.2.2. Without Docker ### 1.2.3. Without Docker
Clone the Repository `git clone <URI>` and build the Program with `go build cmd/app` Clone the Repository `git clone <URI>` and build the Program with `go build cmd/app`