From 606a6f70a418dc02fc2cf51f6b240adf5c11cbb1 Mon Sep 17 00:00:00 2001 From: Manevolent Date: Tue, 21 Sep 2021 12:41:01 -0600 Subject: [PATCH] Update README.md --- README.md | 39 ++++++++++++++++++++------------------- 1 file changed, 20 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 9eda744..59b4a6e 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,32 @@ This is the semi-official, testing Lixonet EE repository. Custom configurations should be supplied in a `lixonet.conf` file in the `name=value` format, such as your subnet. Additionally, a tinc keypair is also be required. +# Setup, Installation, and Updating + +#### 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` +8. Supply `/etc/lixonet/id_rsa` and `/etc/lixonet/(yournetwork)/id_rsa` + **Generating keypairs for tinc (`tinc.key`)**: Source: https://www.tinc-vpn.org/documentation/Generating-keypairs.html Run: `tincd -n lixonet -K` +#### Install/Update: + +1. Read and follow the prerequisites above and make sure you are ready to install. +2. Clone or navigate to a cloned repository folder you already have. +3. Run `chmod +x install.sh && ./install.sh` +4. Enjoy! + # Configuration options #### Location @@ -146,22 +166,3 @@ 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, Installation, and Updating - -#### 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/Update: - -You should **no longer** need to run `build.sh` directly. Instead, use a "self-configuring" Docker container to make your life easier. - -1. Clone or navigate to a cloned repository folder you already have. -2. Run `git clean -f -d && git reset --hard && git pull origin master && docker build -t lixonet-ee . && docker run --rm -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`