guysoft / PleromaPi

RaspberryPi / CustomPiOS distro that run Pleroma out of the box

PleromaPi

An out of the box Raspberry Pi Raspbian distro that runs Pleroma using Docker and Nginx-proxy as a reverse proxy, with letsencrypt. It uses the docker-compose yaml for pleroma here.

Where to get it?

You can use the pi-imager commuity raspberrypi imager here, unofficial section.

Or download directly form the official mirror here

How to use it?

1. Unzip the image and install it to an SD card like any other Raspberry Pi image

2. Configure your WiFi by editing pleromapi-wpa-supplicant.txt at the root of the flashed card when using it like a flash drive

3. Configure the Pleroma settings at /boot/docker-compose/pleroma/environments/pleroma/pleroma.env and set:

   # fill in your specific data below
   # otherwise you won't get an https certificate
   ADMIN_EMAIL=[e-mail]
   NOTIFY_EMAIL=[e-mail]
   DOMAIN=pleroma.gnethomelinux.com
   VIRTUAL_HOST=pleroma.gnethomelinux.com
   LETSENCRYPT_HOST=pleroma.gnethomelinux.com
   LETSENCRYPT_EMAIL=[e-mail]
   

4. Boot the Pi from the SD card

5. Hostname is pleromapi (not raspberrypi as usual), username: ubuntu and inital password is: ubuntu. You will be prompted to change it on login.

6. After a few minutes, Pleroma will only work on https://DOMAIN you provided above. Because it blocks non-https communication on the domain. You should be able to access https://pleromapi.local/ or if you are using ipv6 https://pleromapi/ for testing, but it will how up as blank or with an https error. Note you have to use https because of how pleroma works.

7. Create an admin account on Pleroma by running the script on the Pi: /home/pi/scripts/make_admin_user

8. You can change the settings of the Pleroma/nginx-proxy stack in the files located at /boot/docker-compose/pleroma/ and /boot/docker-compose/nginx-proxy/.

Requirements

• A domain pointing to your Pi's IP.
• 2A power supply
• RaspberryPi 2, 3B, 3B+, 4B (not 1 and zero)
• A domain, because you need an https valid certifiacte

Features

• Pleroma Pre-installed using docker
• Nginx-proxy to manage reverse proxy and certificates

Developing

Requirements

1. Docker or Vagrant, docker recommended
2. Docker-compose - recommended if using docker build method, instructions assume you have it
3. Downloaded Ubuntu for RaspeberryPi image image. Official releases use the LTS version.
4. Root privileges for chroot
5. Bash
6. sudo (the script itself calls it, running as root without sudo won't work)

Build PleromaPi

PleromaPi can be built using docker running either on an intel or RaspberryPi (supported ones listed). Build requires about 4.5 GB of free space available. You can build it assuming you already have docker and docker-compose installed issuing the following commands:

git clone https://github.com/guysoft/PleromaPi.git
cd PleromaPi/src/image
wget -c --trust-server-names 'https://cdimage.ubuntu.com/releases/20.04.2/release/ubuntu-20.04.4-preinstalled-server-arm64+raspi.img.xz'
cd ..
sudo docker-compose up -d
sudo docker exec -it pleromapi-build build

Building PleromaPi Variants

PleromaPi supports building variants, which are builds with changes from the main release build. An example and other variants are available in the folder src/variants/example.

To build a variant use:

sudo docker exec -it pleromapi-build build [Variant]

Building Using Vagrant

There is a vagrant machine configuration to let build PleromaPi in case your build environment behaves differently. Unless you do extra configuration, vagrant must run as root to have nfs folder sync working.

To use it:

sudo apt-get install vagrant nfs-kernel-server
sudo vagrant plugin install vagrant-nfs_guest
sudo modprobe nfs
cd PleromaPi/src/vagrant
sudo vagrant up

After provisioning the machine, its also possible to run a nightly build which updates from devel using:

cd PleromaPi/src/vagrant
run_vagrant_build.sh

To build a variant on the machine simply run:

cd PleromaPi/src/vagrant
run_vagrant_build.sh [Variant]

Usage

1. If needed, override existing config settings by creating a new file src/config.local. You can override all settings found in src/config. If you need to override the path to the Raspbian image to use for building PleromaPi, override the path to be used in ZIP_IMG. By default, the most recent file matching *-raspbian.zip found in src/image will be used.
2. Run src/build_dist as root.
3. The final image will be created in src/workspace

Code contribution would be appreciated!