RPi Docker Starter

Basic RPi Docker media server template with setup instructions.
Does not include instructions for setting up individual services, once running.

Notes

• Please submit an issue if you find any errors
• Be aware that you may need to use docker compose command instead of docker-compose, based on your version

Steps

RPi Setup

1. Install OS onto a microSD using Raspberry Pi Imager
   You can configure network and SSH access before installation.
2. SSH into the RPi
3. Run sudo raspi-config to finish setting up your device

Docker Setup

1. Update RPi: sudo apt update && sudo apt upgrade
2. Run Docker setup: curl -sSL https://get.docker.com | sh
   Typically not recommended, but Docker is a trusted source.
3. Add user to the Docker group: sudo usermod -aG docker [user]
   Or sudo usermod -aG docker ${USER} to add current user
   You can check it by running groups ${USER}.
   Alternatively, use sudo for every docker command.
4. Restart to apply changes: sudo restart
5. SSH to the RPi again
6. Run a test container: docker run hello-world
   It should tell you whether your setup is running correctly.
7. Optionally enable Docker system service: sudo systemctl enable docker
   This allows containers to start on boot.

Compose Setup

This is an optional step, but recommended.

1. Install pip3:

   sudo apt-get install libffi-dev libssl-dev
   sudo apt install python3-dev
   sudo apt-get install -y python3 python3-pip

   python3 & pip3 are required to setup and run docker-compose.
2. Update pip: pip install --upgrade pip Usually not necessary
3. Install docker-compose: sudo pip3 install docker-compose
   Check status using docker version & docker-compose version.
   ¹See footnote if you get Failed to build bcrypt cryptography.

Directory System

I would recommend something like this:
Note that data is within the docker folder in this repo for simplicity.
Placing it outside of the docker folder as shown below would be strongly recommended.

.
├── srv                             # Or /home/username/
│   ├── docker                      # Docker root
│   │   ├── appdata                 # Container local directory mounts
│   │   │   ├── container_name      # Examples
│   │   │   ├── container_name-db
│   │   │   └── ...
│   │   ├── env
│   │   ├── secrets                 # Docker secrets
│   │   ├── shared                  # Shared certificates
│   │   ├── .env
│   │   └── docker-compose.yml
│   ├── data                        # Media root
│   │   ├── movies
│   │   ├── tv shows
│   │   └── ...
|   └── ...
└── ...

Directory Setup

1. Setup Docker root

   cd /srv
   sudo mkdir docker
   chown ${USER} docker  
   cd docker

2. Then either
   1. Clone this repo:

      git clone --depth=1 --branch main https://github.com/filcuk/rpi-docker-starter.git .

      The . at the end makes current folder the repo root folder, instead of creating a sub-directory.
   2. Or set it up manually:

      mkdir data appdata
      wget 'https://raw.githubusercontent.com/filcuk/rpi-docker-starter/main/.env' -O .env
      wget 'https://raw.githubusercontent.com/filcuk/rpi-docker-starter/main/docker-compose.yml' -O docker-compose.yml

Launch

1. Edit environment vars: nano .env
   You need to set DATADIR, DOCKERDIR, TZ, PUID & PGID.
   Use id to get the user and docker group IDs.
   cat will read the contents of the file.
2. Spin up containers: docker-compose up -d
3. Check status: docker-compose ps
4. Access your services on: 192.168.1.x:[webui-port]
   Note that in docker-compose, the first port is the one facing outwards.
   I.e. for - 8800:8080, you would enter 192.168.1.x:8800.
   yacht (included) lists services with their open ports as links for ease of access.

Post-launch

• See TRaSH Guides on help with setting up Sonarr & Radarr
• I would recommend setting up your own repo from the docker directory and submit changes to it regularly
• You can use docker system prune to clear unused objects and reclaim storage
  See docs.docker.com/compose for more.

Re-downloading repo

1. Discard any changes: git restore .
   You can discard changes for single file: git restore path/to/file.
2. Pull latest: git pull

Troubleshooting

Failed to build bcrypt cryptography

1. Install deb package: sudo apt install docker-compose
   Note that you may not have the latest version this way.
2. Downgrade bcrypt: sudo pip3 install -U "bcrypt<4.0.0"
   Pre-v4 bcrypt should not have this issue.
3. See below

You can find more info about this issue here: github.com/adriankumpf

docker-compose manual setup

1. Remove current binary (if present): sudo apt remove docker-compose or sudo rm /usr/local/bin/docker-compose
2. Find the latest release: github.com/docker
3. Download the binary: sudo curl -L "https://github.com/docker/compose/releases/download/v2.14.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
4. Allow execution: sudo chmod +x /usr/local/bin/docker-compose
5. Remove old link: sudo rm /usr/bin/docker-compose
6. Make new link: sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose

Cannot connect to the Docker daemon...

Cannot connect to the Docker daemon at unix:/var/run/docker.sock. Is the docker daemon running?
Try sudo your command. If that doesn't help, try sudo service docker restart.

Pending kernel upgrade notification

Run sudo apt remove needrestart - it was installed by docker setup script and is not required.
Alternatively, just ignore the message.

Links

Sources

pimylifeup.com
dev.to/elalemanyo
github.com/adriankumpf
github.com/kclyu
raspberrypi.stackexchange.com

Footnotes

1. See this troubleshooting step. ↩