Lemmy (LOCAL HOST)

The lemmy instructions are simple and straight forward. When changing the fields asked of you in the instructions, it’s helpful to search and replace the required fields. In nano when editing a file, press CTRL + \ and follow the instructions at the bottom of the window. This will find and replace text.

The Lemmy instructions show text for editing with {{ Example }}. To avoid confusion, those curly braces must be removed and replaced with the expected data.

• If you used NPM’s login page to test Cloudflare Tunnels, you will need to login to NPM and change the Port Forward from 81 to 10633
  • Click Hosts -> Proxy Hosts -> Click the 3-Dots for your DOMAINNAME.COM proxy rule -> Edit & Save

1. Follow Lemmy Install Instructions
   • IGNORE steps Reverse Proxy/Webserver & Let’s Encrypt since we have addressed those steps earlier with NPM and Cloudflare Tunnels/Security.
2. Through a Web Browser, type in your DOMAINNAME.COM and you should see an admin creation page. Complete that and the initial instance setup afterwards.
3. Test federation, replace capitals with the required information

   • curl -H 'Accept: application/activity+json' https://DOMAINNAME.COM/u/LEMMY_USERNAME

     • If you see .json information, Lemmy is federated
     • If you see .html information, lemmy is NOT federated

Updating Lemmy Docker Container

See here for more information.

1. docker compose down
2. docker compose pull
3. docker compose up -d

PieFed (LOCAL HOST)

The PieFed installation instructions will provide more detailed information about each step. This guide does NOT cover any email setup for PieFed.

• If you used NPM’s login page to test Cloudflare Tunnels, you will need to login to NPM and change the Port Forward from 81 to 8030

  • Click Hosts -> Proxy Hosts -> Click the 3-Dots for your DOMAINNAME.COM proxy rule -> Edit & Save

• PieFed Install Instructions

1. Download & Prepare files
   1. git clone https://codeberg.org/rimu/pyfedi.git
   2. cd pyfedi
   3. cp env.docker.sample .env.docker
2. Edit & Save files
   1. nano .env.docker
      1. Change value for SECRET_KEY with random numbers and letters
      2. Change value for SERVER_NAME with your DOMAINNAME.COM
   2. nano compose.yaml
      • Note ports 8030:5000. You can change the external container port: 8030: if you are using a custom port. Do NOT touch the internal container port :5000.
        • ports:
        • - '8030:5000'
3. Build
   1. export DOCKER_BUILDKIT=1
   2. sudo docker compose up --build
      • Wait until text stops scrolling
4. Access your DOMAINNAME.COM from a Web Browser
   1. You may see a message that says database system is ready to accept connections in your terminal window after PieFed is done installing and loading. This means you are ready to attempt a connection through your Web Browser now.
      • If you see constant permission errors, Open and SSH login to the Raspberry Pi in a new terminal window and do the following to allow PieFed to access the required folders:
        1. cd ~/pyfedi
        2. chown -R USERNAME:USERNAME ./pgdata
           • You can leave this window open, it can be used for the step 5.
   2. You may see an “Internal Server Error” after your first connection attempt. This is normal. You will see movement in your terminal window on each attempt to connect to PieFed. Now you can proceed to initialize the database.
5. Initialize Database
   1. Open and SSH login to the Raspberry Pi in a new terminal window
      1. sudo docker exec -it piefed_app1 sh
      2. export FLASK_APP=pyfedi.py
      3. flask init-db
         • Enter username/email/password. Email is optional.
      4. Access PieFed from your Web Browser again. PieFed should now display. You can log in as admin with the same username and password.
      5. exit
      6. You can close this terminal window now
6. Return to the terminal with the running docker build and press CTRL + C to stop PieFed.
7. Run PieFed in the background
   • docker-compose up -d
8. Setup Cron (Automated) Tasks
   • This will set up automated tasks for daily maintenance, weekly maintenance and email notifications.
   • Change USERNAME to your username.
   1. Setup automated tasks
      1. sudo nano /etc/cron.d/piefed
         1. Paste and Save

• /etc/cron.d/piefed file

5 2 * * * USERNAME docker exec piefed_app1 bash -c "cd /app && ./daily.sh"  
5 4 * * 1 USERNAME docker exec piefed_app1 bash -c "cd /app && ./remove_orphan_files.sh"  
1 */6 * * * USERNAME docker exec piefed_app1 bash -c "cd /app && ./email_notifs.sh"