setup.sh

#!/bin/bash

# This script sets up a Freifunk Ulm server consisting of the following blocks:

# 1. mesh (fastd, batman, alfred)
# 2. gateway (iptables, radvd, tayga, openvpn, dns, dhcp, batman gateway mode)
# 3. webserver (lighttpd for status page, map pages)
# 4. icvpn (bird, tinc)
# 5. map (ffmap, meshviewer)
# 6. stats (munin client)
# 7. unattended upgrades of debian packages (keeps your server save!)

# DO NOT CALL THE SCRIPTS IN STANDALONE MODE as this will NOT WORK!

#
# Please note:
# Toggling the setup_xxxx variables below back to 0 later does not _uninstall_ the software, but _skips_
# the _re-installation_ of this block. No further data updates will be performed by freifunk/update.sh for this block.
#
# BUT: Remaining server processes have to be manually stopped as needed. They are not killed by a 0 setting. 
# If you are not sure, which processes to stop - reboot the server, which cleans up the mess.
#
 

####################
# General settings #
####################

# The server's internet-connected network interface. "eth0" should be a save choice in most cases.
wan_iface="eth0"

# The community identifier for internal purposes
community_id="ulm"
# The community identifier which shows up on websites, lists, meshviewer... 
community_name="Ulm"

# This server's name. Please stick to the vpnXX scheme. E.g. vpn10, vpn11, ...
ff_servername="vpnXX"

# The internal IPv6 prefix as defined in the Freifunk community wiki.
ff_prefix="fdef:17a0:fff1:300::"

####################
# 1. Mesh settings #
####################

# Run setup? 
# Mandatory.
setup_mesh=1

# IP v4 for mesh interface.
# This is gateway specific. Get your IP by writing to the mailing list!
# Format: xxx.xxx.xxx.xxx
# Important: This IP may not be inside 10.33.0.1-10.33.15.254 (= the NAT64 /20 range)
mesh_ipv4_addr=""

# Secret key for fastd (will be generated if not provided).
# Please keep in mind that the _public_ part of this key pair must be known to other gateways and routers to establish a connection
fastd_secret=""

# B.A.T.M.A.N version
batman_version=2019.2

#######################
# 2. Gateway settings #
#######################

# Run setup?
# Optional
setup_gateway=1

# Range for DHCP
# This is gateway specific. Get your DHCP range by writing to the mailing list!
# Enter space separated IP range: xxx.xxx.xxx.xxx xxx.xxx.xxx.xxx
dhcp_ipv4_range=""

# VPN Provider
# expects zipped config files for vpn tunnel in scripts base directory
# possible values: mullvad, airvpn, freifunkrheinland
vpn_provider="mullvad"


#########################
# 3. webserver settings #
#########################

# A webserver is needed to display map and statistical information (e.g. map, munin stats). 
# Furthermore it is mandatory if users should be able to click on their router's "neighbourhood link" and 
# jump to the gateway they are connected with.

# If you run this part, be sure to have DNS resolution set up - otherwise certificate checkout at letsencrypt will fail!

# Run setup? 
# Optional
setup_webserver=1


#####################
# 4. ICVPN settings #
#####################

# InterCity VPN interconnects all Freifunk subnets by using "Big Internet Technology" (AS, BGP, et. al.)

# Run setup? 
# Optional
setup_icvpn=0

# ICVPN hostname (should be something like ulmXX e.g. ulm10)
# Please prefer corresponding hostname numbering: vpn10 - ulm10
icvpn_hostname="ulmXX"

# ICVPN addresses
# InterCity-VPN-Addresses for Ulm do start with 10.207... and fec0::a:cf:... respectively
# as defined in https://github.com/freifunk/icvpn-meta/blob/master/ulm
# Go there first and create a pull request for the new addresses!
# To find valid adresses run https://github.com/freifunk/icvpn-scripts/blob/master/findfree
icvpn_ipv4_addr=""
icvpn_ipv6_addr=""

# By running this script a public key will be created automatically in /etc/tinc/icvpn/hosts/$icvpn_hostname
# Create a pull request on https://github.com/freifunk/icvpn/tree/master/hosts to upload it.
# If you skip this, other ICVPN servers can not connect to your tinc daemon.

# Autonomous System Number (AS) 
# as defined in https://github.com/freifunk/icvpn-meta/blob/master/ulm
# this is community specific
as_number="64860"

###################
# 5. map settings #
###################

# Sets up map features on the gateway.

# Run setup? 
# Optional
setup_map=0


#####################
# 6. stats settings #
#####################

# Collect data for fancy graphs like network throughput, memory usage, uptime, etc.

# Run setup? 
# Optional
setup_stats=0

# munin host
munin_host=map.freifunk-ulm.de

# munin type 
# possible values: client, server
# Stick to client until you are told otherwise.

munin_type=client


#########################
# 7. unattended upgrade #
#########################

# Sets up unattended security upgrades performed by apt

# Run setup? 
# Optional
setup_unattended=1




# Everything set up ? 
# Set run to 1 for this script to run. :-)
run=0


################################################################
# NO CHANGES BELOW THIS LINE

export PATH=$PATH:/usr/local/sbin:/usr/local/bin

# abort script on first error
set -e
set -u

# config output colors
red=`tput setaf 1`
green=`tput setaf 2`
col_reset=`tput sgr0`

if [ $run -eq 0 ]; then
  echo "Check the variables in this script and then set run to 1!"
  exit 1
fi

ula_addr() {
	local prefix="$1" mac="$2" a

	# translate to local administered mac
	a=${mac%%:*} #cut out first hex
	a=$((0x$a ^ 2)) #invert second least significant bit
	a=`printf '%02x\n' $a` #convert back to hex
	mac="$a:${mac#*:}" #reassemble mac

	mac=${mac//:/} # remove ':'
	mac=${mac:0:6}fffe${mac:6:6} # insert ffee
	mac=`echo $mac | sed 's/..../&:/g'` # insert ':'

	# assemble IPv6 address
	echo "${prefix%%::*}:${mac%?}"
}

get_mac() {
	local mac="$(cat /sys/class/net/$1/address)" a

	# translate to local administered mac
	a=${mac%%:*} #cut out first hex
	a=$((0x$a ^ 2)) #invert second least significant bit
	a=`printf '%02x\n' $a` #convert back to hex
	echo "$a:${mac#*:}" #reassemble mac
}

# Set hostname
echo "(I) ${green}hostname will be set to $ff_servername ${col_reset}"
hostname -b $ff_servername

if ! ip addr list dev $wan_iface &> /dev/null; then
	echo "(E) ${red}Interface $wan_iface does not exist.${col_reset}"
	exit 1
fi

mac_addr="$(get_mac $wan_iface)"
mesh_ipv6_addr="$(ula_addr $ff_prefix $mac_addr)"

if [ -z "$mac_addr" -o -z "$mesh_ipv6_addr" ]; then
	echo "(E) ${red}MAC or IP address no set.${col_reset}"
	exit 1
fi

# disable rpcbind
systemctl stop rpcbind
systemctl disable rpcbind

echo "(I) ${green}Update package database${col_reset}"
apt update

if [ $setup_mesh -eq 1 ]; then ( . ./mesh.sh ) # source script in separate shell
fi
if [ $setup_gateway -eq 1 ]; then ( . ./gateway.sh ) # source script in separate shell
fi
if [ $setup_webserver -eq 1 ]; then ( . ./webserver.sh ) # source script in separate shell
fi
if [ $setup_icvpn -eq 1 ]; then ( . ./icvpn.sh ) # source script in separate shell
fi
if [ $setup_map -eq 1 ]; then ( . ./map.sh ) # source script in separate shell
fi
if [ $setup_stats -eq 1 ]; then ( . ./stats.sh ) # source script in separate shell
fi
if [ $setup_unattended -eq 1 ]; then ( . ./unattended.sh ) # source script in separate shell
fi

{
	echo "(I) ${green}Fill /opt/freifunk/* directory...${col_reset}"
	cp -rf freifunk /opt/

        # transfer several constants to update.sh
	sed -i "s/mac_addr=\".*\"/mac_addr=\"$mac_addr\"/g" /opt/freifunk/update.sh
	sed -i "s/mesh_ipv6_addr=\".*\"/mesh_ipv6_addr=\"$mesh_ipv6_addr\"/g" /opt/freifunk/update.sh
	sed -i "s/ff_prefix=\".*\"/ff_prefix=\"$ff_prefix\"/g" /opt/freifunk/update.sh
	sed -i "s/mesh_ipv4_addr=\".*\"/mesh_ipv4_addr=\"$mesh_ipv4_addr\"/g" /opt/freifunk/update.sh

	sed -i "s/community=\".*\"/community=\"$community_id\"/g" /opt/freifunk/update.sh

        # transfer run state to update.sh
	sed -i "s/run_mesh=.*/run_mesh=$setup_mesh/g" /opt/freifunk/update.sh
	sed -i "s/run_gateway=.*/run_gateway=$setup_gateway/g" /opt/freifunk/update.sh
	sed -i "s/run_webserver=.*/run_webserver=$setup_webserver/g" /opt/freifunk/update.sh
	sed -i "s/run_icvpn=.*/run_icvpn=$setup_icvpn/g" /opt/freifunk/update.sh
	sed -i "s/run_map=.*/run_map=$setup_map/g" /opt/freifunk/update.sh
	sed -i "s/run_stats=.*/run_stats=$setup_stats/g" /opt/freifunk/update.sh

}

if [ -z "$(cat /etc/crontab | grep '/opt/freifunk/update.sh')" ]; then
	echo "(I) ${green}Add update.sh entry to /etc/crontab${col_reset}"
	echo '*/5 * * * * root /opt/freifunk/update.sh > /dev/null 2>&1' >> /etc/crontab
fi

# call update script once to start all remaining services
/opt/freifunk/update.sh

echo "setup done"

exit 0