commit 2527a963170db1df49ab1ea5db244b609ef7eac0
parent c0999d7b52d2c44c4dce70f65fff912fdf501a37
Author: Stefan Koch <programming@stefan-koch.name>
Date: Tue, 8 Dec 2020 21:04:05 +0100
add new tap creation script to README
Diffstat:
2 files changed, 9 insertions(+), 22 deletions(-)
diff --git a/README.md b/README.md
@@ -24,29 +24,16 @@ pip install -e .
Before you can start using the server you need to setup a TAP device to which
VDE networking can connect. This is needed so that the started VMs can
join the network. To be able to create a TAP device that is connected to your
-real network, you might also have to setup a software bridge. Below are all
-the steps, `$YOUR_USER` must be set to the user as which VDE and the
-aetherscale server should run.
+real network, you might also have to setup a software bridge. aetherscale
+includes a script to help you with this. Since I could only test on my PC
+it might require some adjustment on other PCs. It takes all required info
+as parameters.
-```
-# Create a bridge connected to the real ethernet device (eth0)
-ip link add br0 type bridge
-ip link set br0 up
-
-ip link set eth0 up
-ip link set eth0 master br0
-
-# Re-assign IP from eth0 to br0
-ip addr flush dev eth0
-
-# Assign IP to br0
-ip addr add 192.168.0.10/24 brd + dev br0
-ip route add default via 192.168.0.1 dev br0
+```bash
+bin/setup-tap-vde.sh -u USER -i IP_ADDRESS -g GATEWAY -e PHYSICAL_DEVICE
-# Setup a TAP device to which VDE can connect
-ip tuntap add dev tap-vde mode tap user $YOUR_USER
-ip link set dev tap-vde up
-ip link set tap-vde master br0
+# For example
+bin/setup-tap-vde.sh -u username -i 192.168.0.10/24 -g 192.168.0.1 -e eth0
```
## Usage
diff --git a/bin/setup-tap-vde.sh b/bin/setup-tap-vde.sh
@@ -1,7 +1,7 @@
#!/usr/bin/env bash
usage() {
- echo "Usage: $0 -u USER -i IP_ADDRESS -g GATEWAY -e eth_device_DEVICE"
+ echo "Usage: $0 -u USER -i IP_ADDRESS -g GATEWAY -e PHYSICAL_DEVICE"
}
while getopts ":hu:i:g:e:" opt; do
