4 Commits

Author SHA1 Message Date
323db065ad Add information about required capabilites for docker 2022-11-15 19:25:16 +01:00
ca9507e26f Add documentation about environment-vars 2022-11-15 19:14:19 +01:00
5860e53690 Merge branch 'release-0.1' into dev 2022-11-15 18:47:43 +01:00
111d316802 Add missing \ 2022-11-15 18:47:21 +01:00
2 changed files with 17 additions and 5 deletions

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.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>
### 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>
@@ -53,7 +63,9 @@ services:
routingTableWGTranslator:
image: ruakij/RoutingTableWGTranslator
restart: unless-stopped
network_mode: "host"
network_mode: host
cap_add:
- NET_ADMIN
environment:
- INTERFACE="<wgInterfaceName or empty for wg0>"
```
@@ -61,7 +73,7 @@ services:
<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`

2
build/docker-multiarch.sh Normal file → Executable file
View File

@@ -5,5 +5,5 @@ EXTRA_ARGS="$@"
docker buildx build \
--platform $PLATFORM \
--tag $TAG \
$EXTRA_ARGS
$EXTRA_ARGS \
.