From 25883fbe58686c438057f22148e197dd7fb84e06 Mon Sep 17 00:00:00 2001 From: sump pump Date: Thu, 21 May 2020 04:48:48 +0000 Subject: [PATCH] Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fba7c1e..c552c61 100644 --- a/README.md +++ b/README.md @@ -49,13 +49,14 @@ For options we expose here, for information see: https://bird.network.cz/?get_do # Setup -Prerequisites: +####Prerequisites: 1. `docker` and `docker-compose` (Alpine: community repository; https://docs.genesys.com/Documentation/System/8.5.x/DDG/InstallationofDockeronAlpineLinux), `git`, and `curl` are installed (Alpine: `apk add`). You may also want to make docker run at boot: `rc-update add docker boot`. 2. `eth0` is the **LAN** or **WAN** interface supporting external routing, DNS, etc., and is the **birdged** interface to a router that will statically route the entire desired network subnet (i.e. x.x.0.0/16) through it 4. `tun` and `tap` are in `/etc/modules` to load at boot (https://www.cyberciti.biz/faq/linux-how-to-load-a-kernel-module-automatically-at-boot-time/) and the system has been rebooted afterwards. 5. `sigil` is installed (`curl -L "https://github.com/gliderlabs/sigil/releases/download/v0.5.0/sigil_0.5.0_$(uname -sm|tr ' ' '_').tgz" | tar -zxC /usr/local/bin`) 6. IPv4 forwarding is on: `sysctl -w net.ipv4.ip_forward=1` and `iptables -P FORWARD ACCEPT` are run (and persisted) to allow IP forwarding. -Install: + +####Install: 1. Clone this repository: `git clone` 2. `mkdir /etc/lixonet/` 3. Fill out `/etc/lixonet/lixonet.conf` (see: **Configuration options**)