From 718981b2ca28714b48a56e8024d62166ca4cf768 Mon Sep 17 00:00:00 2001
From: Bento Silveira <bento@ninjazumbi.com>
Date: Sun, 23 Jul 2023 17:38:54 -0300
Subject: [PATCH] Started the documentation

---
 README.md                | 10 ++++++++++
 config/config.properties | 37 -------------------------------------
 configuration.env        |  2 +-
 configure-instance.sh    | 16 ----------------
 4 files changed, 11 insertions(+), 54 deletions(-)
 delete mode 100644 config/config.properties
 delete mode 100755 configure-instance.sh

diff --git a/README.md b/README.md
index d70ef2c..4b47498 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,15 @@
 # Piped-Docker
 
+### Requirements
+
+To Self-host Piped you're going to need the following resources:
+
+- Three DNS entries, one for each of the three modules: Frontend, Backend (API) and Youtube Proxy.
+- An SSL certificate for HTTPS. An exemple is supplied, but you should create your own or get one from Let's Encrypt
+- A container manager - Docker or Podman - with the corresponding \*-composer.
+
+For an instance serving only a private network, you most likely going to use a self-signed certificate, since Let's Encrypt needs access to the server on port 80 to validate that you actually owns it.
+
 ### Creating Self-signed certificate
 
 https://www.digitalocean.com/community/tutorials/openssl-essentials-working-with-ssl-certificates-private-keys-and-csrs#generating-ssl-certificates
diff --git a/config/config.properties b/config/config.properties
deleted file mode 100644
index 776faee..0000000
--- a/config/config.properties
+++ /dev/null
@@ -1,37 +0,0 @@
-# The port to Listen on.
-PORT: 8080
-
-# The number of workers to use for the server
-HTTP_WORKERS: 2
-
-# Public Frontend URL - You should set this on the docker-compose file
-# FRONTEND_URL: https://FRONTEND_HOSTNAME
-
-# Public API URL - You should set this on the docker-compose file
-# API_URL: https://BACKEND_HOSTNAME
-
-# Proxy - You should set this on the docker-compose file
-# PROXY_PART: https://PROXY_HOSTNAME
-
-# Outgoing HTTP Proxy - eg: 127.0.0.1:8118
-#HTTP_PROXY: 127.0.0.1:8118
-
-# Captcha Parameters
-CAPTCHA_BASE_URL: https://api.capmonster.cloud/
-CAPTCHA_API_KEY: INSERT_HERE
-
-# Enable haveibeenpwned compromised password API
-COMPROMISED_PASSWORD_CHECK: true
-
-# Disable Registration
-DISABLE_REGISTRATION: false
-
-# Feed Retention Time in Days
-FEED_RETENTION: 30
-
-# Hibernate properties
-hibernate.connection.url: jdbc:postgresql://postgres:5432/piped
-hibernate.connection.driver_class: org.postgresql.Driver
-hibernate.dialect: org.hibernate.dialect.PostgreSQLDialect
-hibernate.connection.username: piped
-hibernate.connection.password: changeme
diff --git a/configuration.env b/configuration.env
index 01a2919..96bfb38 100644
--- a/configuration.env
+++ b/configuration.env
@@ -10,7 +10,7 @@ PROXY_HOSTNAME=proxy-host.example.com
 # API container settings  #
 ###########################
 
-# Port the server will listen on.
+# Port the API server will listen on.
 PORT=8080
 
 # The number of workers to use for the server
diff --git a/configure-instance.sh b/configure-instance.sh
deleted file mode 100755
index 52e39d0..0000000
--- a/configure-instance.sh
+++ /dev/null
@@ -1,16 +0,0 @@
-#!/bin/sh
-echo "Enter a hostname for the Frontend (eg: piped.kavin.rocks):" && read -r frontend
-echo "Enter a hostname for the Backend (eg: pipedapi.kavin.rocks):" && read -r backend
-echo "Enter a hostname for the Proxy (eg: pipedproxy.kavin.rocks):" && read -r proxy
-echo "Enter the reverse proxy you would like to use (either caddy or nginx):" && read -r reverseproxy
-
-rm -rf config/
-rm -f docker-compose.yml
-
-cp -r template/ config/
-
-sed -i "s/FRONTEND_HOSTNAME/$frontend/g" config/*
-sed -i "s/BACKEND_HOSTNAME/$backend/g" config/*
-sed -i "s/PROXY_HOSTNAME/$proxy/g" config/*
-
-mv config/docker-compose.$reverseproxy.yml docker-compose.yml