WreckingBANG/how_to_locally_host_piped.md

## how_to_locally_host_piped.md

      
    Raw
  

              how_to_locally_host_piped.md
            
          
    How to locally Host Piped with Subscription Feed.

I did not find any clear Guide on how to do it, so I thought I would just create one.
The Goal:

A completely local Piped Server without Port Forwarding
A working Subscription Feed

The Things you need:

A Machine you want to run your Piped Server on (I will be using Debian 12)
Nginx Proxy Manager (If you don't have it, I can recommend this guide: https://piped.video/watch?v=qlcVx-k-02E)
A Domain (you don't need to own one, you can add a DNS-Entry, but I would recommend one)


Install Docker and Docker Compose:
sudo apt install docker docker-compose -y


Then you need to clone the Piped Docker GitHub Repository and cd into it:
git clone https://github.com/TeamPiped/Piped-Docker && cd Piped-Docker


After that, you need to execute the installation Script:
./configure-instance.sh


Now you will be asked a few Questions:
Enter a hostname for the Frontend (eg: piped.kavin.rocks):
piped.yourdomain.tld

Enter a hostname for the Backend (eg: pipedapi.kavin.rocks):
pipedapi.yourdomain.tld

Enter a hostname for the Proxy (eg: pipedproxy.kavin.rocks):
pipedproxy.yourdomain.tld

Enter the reverse proxy you would like to use (either caddy or nginx):
nginx


After that, go to your already-setup Nginx Proxy Manager (can also be on a different Computer)
In there, you will need to Set up a new Proxy Host:


If you want, you can select your SSL Certificate under the SSL tab.


And on the Advanced Tab, you need to insert this line:
proxy_set_header Host $host;


Now you can save this and head back to your Piped Server.


After all that, it is finally time to start your Server.  Keep in mind that you still need to be in the ~/Piped-Docker Directory.  You can start your instance by executing:
docker-compose up -d


Now you should be able to head to your URL and access Piped.


The Subscription Feed Problem:
You will notice that the Subscription Feed is never  refreshing. That is a limitation that Piped currently has. You would  need to expose the API to the Internet, which you probably don't want.

You could use something like Cloudflare Tunnel, but then it is not truly local anymore.
Thankfully, like in the Issue TeamPiped/Piped#707 described, someone found a good solution to that. It is not perfect, and  you should only use it if you do not subscribe to many people, or you  could get rate-limited.
It is a small script that reads the Subscribed Channels from the Database and curls everyone.

This Script is by: https://github.com/vayan and is from TeamPiped/Piped#707
To use it, do the following steps:


Create a new file:
nano ~/Piped-Docker/refreshsubscriptions.sh


Paste this and change the pipedapi.yourdomain.tld to your actual domain:
#!/bin/bash

subscriptions=$(docker exec -i postgres psql -U piped -d piped -qtAX -c 'select id from public.pubsub;')

while IFS= read -r line; do
        curl -k "https://pipedapi.yourdomain.tld/channel/$line" > /dev/null
        sleep 1; 
done <<< $subscriptions


Open Crontab:
crontab -e


Enter the following line at the bottom; the number at the  front is the hours. In this example, it gets executed every 3 hours. You  can adjust it to your needs.
0 */3 * * * /home/username/Piped-Docker/refreshsubscriptions.sh >/dev/null 2>&1


Now your setup is finished.