network-docker

This project aims to provide a basic set of networking tools. Docker is used as much as possible. It's intended as a "set and forget" - a pihole which can be left at a non-technical friend or family member network.

Goals

• Stability
• Remote management
• Run on minimal hardware, such as a RaspberryPi Zero

Initial Setup (with GUI)

1. set up timezone, wifi
2. Set up the Hostname: sudo raspi-config > System Options > Hostname
3. sudo apt update && sudo apt upgrade
4. Install dig for troubleshooting: sudo apt-get install dnsutils

Installing Docker

1. Move to a download folder: cd ~/Downloads
   1. Copy Docker's installation script to this directory: curl -fsSL https://get.docker.com -o get-docker.sh
   2. Run the installation script: sudo sh get-docker.sh

Rootless Docker

1. Add your Users to the docker group: sudo usermod -aG docker pi
2. Restart the sytem
3. Validate: docker version
4. Test: docker run hello-world

Lay the foundation with Git

1. sudo apt install git
2. git config --global user.name "your name"
3. git config --global user.email "[email protected]"
4. cd ~
5. git clone https://github.com/jgwehr/network-docker.git network-docker Stores the local contents in a directory named Docker

Build directories

1. mkdir -p /srv/config/{unbound,fail2ban,pihole/{dnsmasq.d,pihole}}
2. sudo chown -R $USER:$USER /srv
3. Copy Unbound Files: cp staticconfig/unbound/a-records.conf /srv/config/unbound/
4. Copy Unbound Files: cp staticconfig/unbound/unbound.conf /srv/config/unbound/
5. Copy Fail2Ban Files: cp staticconfig/fail2ban/jail.local /srv/config/fail2ban/fail2ban/

Starting Services

Customize .env

• You can safely leave all PORT variables as they are. But it's suggested you change PORT_VPN
• Provide DUCKDNS_SUBDOMAINLIST and DUCKDNS_TOKEN via duckdns.org. This is a free DDNS.
• While your at it, the subdomain you provided for DUCKDNS_SUBDOMAINLIST is also used for WG_SERVERURL. If you're SUBDOMAINTLIST is "foo" then WG_SERVERURL should be "foo.duckdns.org"
• Give a secure password for PIHOLE_PASSWORD
• The rest of the pihole variables are unncessary unless you're using DHCP
• Wireguard: WG_PEERS Provision the number of clients (eg. 3) or specific named clients (eg. myPC,myPhone,myTablet)
• Local network accessed via VPN: WG_ALLOWED_IPS Wireguard allow split tunnelling. Default is to send all traffic through this connection. I recommend changing this to your local network (eg. 192.168.0.0/24) so that only "local" traffic is sent to the vpn.

Create the Docker network

docker network create -d bridge --subnet 172.20.0.0/16 dns-net

Getting Remote Management

Done through Wireguard

Configure Wireguard

1. Wireguard will automatically create configurations when the container starts.
2. You can get the QR codes using docker logs --follow wireguard. Alternatively, these files are located at /srv/config/wireguard/<peer> when using the default .env
3. Get the necessary Wireguard client https://www.wireguard.com/install/
4. Follow Wireguard's instructions. Generally speaking, you'll need a peer/client configuration from this server. Easily done on your phone via QR code. Or, on a computer, by copying a *.conf file from the server to the client.

Harden SSH

via https://linuxhandbook.com/ssh-hardening-tips/

1. Create a new SSH Group for approved users: sudo groupadd -g 1022 ssh_allowed
2. Add your primary SSH User to this group: sudo usermod -a -G ssh_allowed pi
3. Open SSHD Config: sudo nano /etc/ssh/sshd_config
   1. Disable empty passwords: PermitEmptyPasswords no
   2. Change default SSH ports: Port 2345
   3. Prevent root login: PermitRootLogin no
   4. Limit active sessions: MaxSessions 4
   5. Configure idle timeout interval: ClientAliveInterval 300
   6. Configure how many times it sends the alive message before disconnecting: ClientAliveCountMax 2
   7. Configure Allowed Groups: AllowGroups ssh_allowed
   8. Disable X11 Forwarding: X11Forwarding no
4. After the change, you will need to restart the sshd service using sudo systemctl restart ssh or rebooting.

General

credit to https://github.com/willy-wagtail/raspberrypi

SD Card Health

To properly shutdown, run sudo shutdown -h now.

Energy Use

Run the command /usr/bin/tvservice -o to disable HDMI. Also run sudo nano /etc/rc.local and add the command there too in order to disable HDMI on boot.

(To enable again, run /usr/bin/tvservice -p, and remove from /etc/rc.local).

Updating and upgrading rasp pi OS

Run sudo apt update, then sudo apt full-upgrade -y, and finally sudo apt clean to clean up the downloaded package files.