diff --git a/README.md b/README.md index 82506ba..2fb5a7d 100644 --- a/README.md +++ b/README.md @@ -144,19 +144,19 @@ These settings are optional, and are already defaulted to general network common * `bind_forward_address`: The overridden DNS server IP address to forward all requests for your own domain to. Defaults to the value of `internal_gateway`, which is proper in most if not all cases. Your BIND zone is automatically converted from your `tinc_peer_name` (i.e. `lkwco_mane_lixo` becomes `lkwco.mane.lixo`). * `tld`: The network-wide TLD to use. Defaults to `lixo`. -# Setup +# Setup, Installation, and Updating -#### Prerequisites: +#### Prerequisites/Setup: 1. `eth0` is the **LAN** or **WAN** interface supporting external routing, DNS, etc., and is the **bridged** interface to a router that will statically route the entire desired network subnet (i.e. x.x.0.0/21) through it. You may also have an `eth1` (and so on, so forth) that you statically configure for your entire, wide subnet (i.e. x.x.0.0/21) if you want to use two physical adapters. If you do have more than one interface, make sure that `internal_gateway` is set to the router IP address that can route your personal Lixonet subnets, and not your WAN gateway (unless they're the same). 2. `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. 3. IPv4 forwarding is on: `sysctl -w net.ipv4.ip_forward=1` +4. Clone this repository: `git clone ` +5. `mkdir /etc/lixonet/(mesh)/` +6. Fill out `/etc/lixonet/(mesh)lixonet.conf` (see: **Configuration options**) +7. Supply `/etc/lixonet/(mesh)/tinc.key` -#### Install: +#### Install/Update: -1. Clone this repository: `git clone ` -2. `mkdir /etc/lixonet/(mesh)/` -3. Fill out `/etc/lixonet/(mesh)lixonet.conf` (see: **Configuration options**) -4. Supply `/etc/lixonet/(mesh)/tinc.key` 5. On the cloned repository, run `docker build -t lixonet-ee .` 6. Run `docker run -it -v /etc/bird:/etc/bird/ -v /etc/tinc:/etc/tinc -v /etc/bind:/etc/bind -v /etc/lixonet:/etc/lixonet -v /var/run/docker.sock:/var/run/docker.sock lixonet-ee` \ No newline at end of file