added documentation

6 files changed, 481 insertions, 0 deletions

diff --git a/docs/apache2.md b/docs/apache2.md
new file mode 100644
index 0000000..28a066e
--- /dev/null
+++ b/docs/apache2.md
@@ -0,0 +1,221 @@
+# Install guide for Apache2 webserver
+Welcome to the new and revamped 4get install manual for apache2. Even if you already have services running on an existing installation of apache2, you should still be able to adapt this guide to your needs.
+
+For starters, login as `root`.
+
+Then, install the following dependencies:
+```sh
+apt update
+apt upgrade
+apt install php-mbstring apache2 certbot php-imagick imagemagick php-curl curl php-apcu git libapache2-mod-php
+```
+
+Enable the required modules:
+```sh
+a2enmod ssl
+a2enmod rewrite
+```
+
+And enable these optional ones, which might be useful to you later on. The `proxy` module is useful for setting up reverse proxies to services like gitea, and `headers` is useful to tweak global header values:
+```sh
+a2enmod proxy
+a2enmod headers
+```
+
+Now, restart apache2:
+```sh
+service apache2 restart
+```
+
+Just for good measure, please check if your webserver is running. Access it through HTTP, not HTTPS. You should see the apache2 default landing page.
+
+## 000-default.conf
+Now, edit the following file: `/etc/apache2/sites-available/000-default.conf`, remove everything and carefully add each rule specified here, while making sure to replace my domains with your own:
+
+1. The `VirtualHost` here instructs apache2 to redirect all **HTTP** traffic that specify an unknown `Host` header be redirected to a specific domain of your choice. Configuring this is not required but highly recommended.
+```xml
+<VirtualHost *:80>
+	# no domain = go to 4get.ca
+	RedirectMatch 301 ^(.*)$ https://4get.ca$1
+</VirtualHost>
+```
+
+2. This instruction tells apache2 to redirect all HTTP traffic on `Host` lolcat.ca to the HTTPS version of the site. You should add a rule like this for all of your services explicitly.
+```xml
+<VirtualHost *:80>
+	ServerName lolcat.ca
+	RedirectMatch 301 ^(.*)$ https://lolcat.ca$1
+</VirtualHost>
+```
+
+3. Subdomains won't be matched by the above rule, so I recommend you also add them to be more explicit:
+```xml
+<VirtualHost *:80>
+	ServerName www.lolcat.ca
+	RedirectMatch 301 ^(.*)$ https://lolcat.ca$1
+</VirtualHost>
+```
+
+... Etc, for every service you own.
+
+4. And finally, append this configuration if you wish to host a tor or i2p access point. This configuration should not be binded to SSL(443) as Let's Encrypt does not let you create certificates for onion sites:
+```xml
+<VirtualHost *:80>
+	# tor site
+	ServerName 4getwebfrq5zr4sxugk6htxvawqehxtdgjrbcn2oslllcol2vepa23yd.onion
+
+	# compress
+	AddOutputFilterByType DEFLATE application/json
+	AddOutputFilterByType DEFLATE application/javascript
+	AddOutputFilterByType DEFLATE application/x-javascript
+	AddOutputFilterByType DEFLATE text/html
+	AddOutputFilterByType DEFLATE text/plain
+	AddOutputFilterByType DEFLATE text/css
+
+	DocumentRoot /var/www/4get
+
+	Options +MultiViews
+	RewriteEngine On
+	RewriteCond %{REQUEST_FILENAME} !-d
+	RewriteCond %{REQUEST_FILENAME} !-f
+	RewriteRule ^([^\.]+)$ $1.php [NC,L]
+
+	# deny access to private resources
+	<Directory /var/www/4get/data/>
+		Order Deny,allow
+		Deny from all
+	</Directory>
+</VirtualHost>
+```
+To make the above snippet work, please refer to our <a href="https://git.lolcat.ca/lolcat/4get/src/branch/master/docs/tor.md">tor site guide</a>.
+
+## default-ssl.conf
+Now, edit the file `/etc/apache2/sites-available/default-ssl.conf`, remove everything and, again, add each rule while modifying the relevant fields:
+
+This ruleset will redirect all clients that specify an unknown `Host` to the domain of our choice. I recommend you uncomment the `ErrorLog` directive while setting things up in case a problem occurs with PHP. Don't worry about the invalid SSL paths, we will generate our certificates later; Just make sure you specify the right domains in there:
+```xml
+<VirtualHost *:443>
+	RedirectMatch 301 ^(.*)$ https://4get.ca$1
+	ServerAdmin will@lolcat.ca
+
+	#ErrorLog ${APACHE_LOG_DIR}/error.log
+
+	SSLEngine on
+
+	<FilesMatch "\.(?:cgi|shtml|phtml|php)$">
+		SSLOptions +StdEnvVars
+	</FilesMatch>
+	<Directory /usr/lib/cgi-bin>
+		SSLOptions +StdEnvVars
+	</Directory>
+
+	AddOutputFilterByType DEFLATE application/json
+	AddOutputFilterByType DEFLATE application/javascript
+	AddOutputFilterByType DEFLATE application/x-javascript
+	AddOutputFilterByType DEFLATE text/html
+	AddOutputFilterByType DEFLATE text/plain
+	AddOutputFilterByType DEFLATE text/css
+
+	SSLCertificateFile /etc/letsencrypt/live/4get.ca/fullchain.pem
+	SSLCertificateKeyFile /etc/letsencrypt/live/4get.ca/privkey.pem
+</VirtualHost>
+```
+
+This ruleset tells apache2 where 4get is located (`/var/www/4get`), ensures that `4get.ca/settings` resolves to `4get.ca/settings.php` internally and that we deny access to `/data/*`, which may contain files you might want to keep private.
+```xml
+<VirtualHost *:443>
+	ServerName 4get.ca
+
+	DocumentRoot /var/www/4get
+
+	Options +MultiViews
+	RewriteEngine On
+	RewriteCond %{REQUEST_FILENAME} !-d
+	RewriteCond %{REQUEST_FILENAME} !-f
+	RewriteRule ^([^\.]+)$ $1.php [NC,L]
+
+	# deny access to private resources
+	<Directory /var/www/4get/data/>
+		Order Deny,allow
+		Deny from all
+	</Directory>
+</VirtualHost>
+```
+
+Don't forget to specify your other services here! Here's an example of a ruleset I use for `lolcat.ca`:
+```xml
+<VirtualHost *:443>
+	ServerName lolcat.ca
+
+	DocumentRoot /var/www/lolcat
+
+	Options +MultiViews
+	RewriteEngine On
+	RewriteCond %{REQUEST_FILENAME} !-d
+	RewriteCond %{REQUEST_FILENAME} !-f
+	RewriteRule ^([^\.]+)$ $1.php [NC,L]
+</VirtualHost>
+```
+
+... Alongside with it's redirect rules.
+```xml
+<VirtualHost *:443>
+	ServerName www.lolcat.ca
+	RedirectMatch 301 ^(.*)$ https://lolcat.ca$1
+</VirtualHost>
+```
+
+## security.conf
+If you enabled the `headers` module, you can head over to `/etc/apache2/conf-enabled/security.conf` and edit:
+```sh
+ServerTokens Prod # instead off Full
+```
+and
+```sh
+ServerSignature Off #instead of On
+```
+This will ensure that the `Server` header apache2 returns is minimal and doesn't leak information like your host system's OS or apache2 version.
+
+You can also uncomment `Header set X-Content-Type-Options: "nosniff"` and `Header set Content-Security-Policy "frame-ancestors 'self';"` respectively.
+
+## charset.conf
+Head over to `/etc/apache2/conf-enabled/charset.conf` and uncomment `AddDefaultCharset UTF-8`.
+
+## other-vhost-access-log.conf
+Since none of our configuration files contains any `CustomLog` directives, all we need to do to disable logging entirely is comment out the `CustomLog` directive located in `/etc/apache2/conf-enabled/other-vhost-access-log.conf`. Only error logs will remain if you configured them.
+
+# Setup SSL
+Great, now we've configured the webserver, but we still don't have our security certificate. Let's generate one!
+
+First, stop `apache2`. 
+```sh
+service apache2 stop
+```
+
+Now, run `certbot`, and specify all of your domains by prepending `-d` every time. Make sure the first domain you specify is your main domain, and the same domain you specified in the configuration above! We use ECDSA encryption here as it's better than RSA.
+```sh
+certbot certonly --standalone --key-type ecdsa -d 4get.ca -d www.4get.ca -d lolcat.ca -d www.lolcat.ca
+```
+
+Certbot should ask you a few questions, just play along. At the end of the setup, certbot should tell you about the location of the certificates. Double check to make sure they correspond to the paths we specified in `default-ssl.conf`. Your certificates should now update every 2-3 months automatically.
+
+After this is complete, create a directory in `/var/www/4get`.
+
+Now, start `apache2`.
+```sh
+service apache2 start
+```
+
+Congratulations! You now have a... 404 error on your webserver, if everything went well. Now's the time to make sure all of our redirect rules work!
+
+# Import the fun junk
+Run these commands:
+```
+cd /var/www/4get
+git clone https://git.lolcat.ca/lolcat/4get
+chmod 777 -R icons/
+```
+
+... And try accessing your webserver. You should now have a working 4get instance!
+
+Please make sure to check out how to further <a href="https://git.lolcat.ca/lolcat/4get/src/branch/master/docs/configure.md">configure 4get</a> to your liking!
diff --git a/docs/caddy.md b/docs/caddy.md
new file mode 100644
index 0000000..90f438c
--- /dev/null
+++ b/docs/caddy.md
@@ -0,0 +1,58 @@
+# Install guide for Caddy webserver
+
+1. Install dependencies:
+
+`sudo apt install caddy php8.2-dom php8.2-imagick imagemagick php8.2-curl curl php8.2-apcu git`
+
+2. Clone this repository where you want to host this from:
+
+`cd /var/www && sudo git clone https://git.konakona.moe/diowo/4get`
+
+3. Set permission on the `icons` directory inside `4get`
+
+`cd /var/www/4get/ && sudo chmod 777 -R icons/`
+
+4. Add an entry for 4get on your Caddyfile at `/etc/caddy/Caddyfile`
+
+```sh
+4get.konakona.moe {
+    root * /var/www/4get
+    file_server
+    encode gzip
+    php_fastcgi unix//var/run/php/php8.2-fpm.sock {
+        index index.php
+    }
+    redir /{path}.php{query} 301
+    try_files {path} {path}.php
+}
+```
+
+Caddy deals with SSL certificates automatically so you don't have to mess with anything. Also if needed, a sample of my Caddyfile can be found [here](https://git.konakona.moe/diowo/misc/src/branch/master/etc/caddy/Caddyfile).
+
+5. Restart Caddy
+
+`sudo systemctl restart caddy`
+
+# Encryption setup
+I'm schizoid (as you should) so I'm gonna setup 4096bit key encryption. To complete this step, you need a domain or subdomain in your possession. Make sure that the DNS shit for your domain has propagated properly before continuing, because certbot is a piece of shit that will error out the ass once you reach 5 attempts under an hour.
+
+## Encryption setup on Apache
+
+```sh
+certbot --apache --rsa-key-size 4096 -d www.yourdomain.com -d yourdomain.com
+```
+When it asks to choose a vhost, choose the option with "HTTPS" listed. Don't setup HTTPS for tor, we don't need it (it doesn't even work anyways with let's encrypt)
+
+Edit `000-default-le-ssl.conf`
+
+Add this at the end:
+```xml
+<Directory /var/www/html/4get>
+	RewriteEngine On
+	RewriteCond %{REQUEST_FILENAME}.php -f
+	RewriteRule (.*) $1.php [L]
+	Options Indexes FollowSymLinks
+	AllowOverride All
+	Require all granted
+</Directory>
+```
diff --git a/docs/configure.md b/docs/configure.md
new file mode 100644
index 0000000..fc8b0bb
--- /dev/null
+++ b/docs/configure.md
@@ -0,0 +1,35 @@
+# 4get configuation options
+
+Welcome! This guide assumes that you have a working 4get instance. This will help you configure your instance to the best it can be!
+
+## Files location
+1. The main configuration file is located at `data/config.php`
+2. The proxies are located in `data/proxies/*.txt`
+3. The captcha imagesets are located in `data/captcha/your_image_set/*.png`
+4. The captcha font is located in `data/fonts/captcha.ttf`
+
+## Server listing
+To be listed on https://4get.ca/instances , you must contact *any* of the people in the server list and ask them to add you to their list of instances in their configuration. The instance list is distributed, and I don't have control over it.
+
+If you see spammy entries in your instances list, simply remove the instance from your list that pushes the offending entries.
+
+## Proxies
+4get supports rotating proxies for scrapers! Configuring one is really easy.
+
+1. Head over to the **proxies** folder. Give it any name you want, like `myproxy`, but make sure it has the `txt` extension.
+2. Add your proxies to the file. Examples:
+	```conf
+	# format -> <protocol>:<address>:<port>:<username>:<password>
+	# protocol list:
+	# raw_ip, http, https, socks4, socks5, socks4a, socks5_hostname
+	socks5:1.1.1.1:juicy:cloaca00
+	http:1.3.3.7::
+	raw_ip::::
+	```
+3. Go to the **main configuration file**. Then, find which website you want to setup a proxy for.
+4. Modify the value `false` with `"myproxy"`, with quotes included and the semicolon at the end.
+
+Done! The scraper you chose should now be using the rotating proxies. When asking for the next page of results, it will use the same proxy to avoid detection!
+
+### Important!
+If you ever test out a `socks5` proxy locally on your machine and find out it works but doesn't on your server, try supplying the `socks5_hostname` protocol instead.
diff --git a/docs/docker.md b/docs/docker.md
new file mode 100644
index 0000000..2aabd9f
--- /dev/null
+++ b/docs/docker.md
@@ -0,0 +1,50 @@
+# Install guide for Docker
+
+```
+docker run -d -p 80:80 -e FOURGET_SERVER_NAME="4get.ca" luuul/4get:latest
+```
+
+...Or with SSL:
+```
+docker run -d -p 443:443 -v /etc/letsencrypt/live/domain.tld:/etc/4get/certs -e FOURGET_SERVER_NAME="4get.ca" luuul/4get:latest
+```
+
+if the certificate files are not mounted to /etc/4get/certs the service listens to port 80
+
+the certificate directory expects files named `fullchain.pem` and `privkey.pem`
+
+# Install using Docker Compose 
+
+copy `docker-compose.yaml`
+
+to serve custom banners create a directory named `banners` for example with images and mount to `/var/www/html/4get/banner`
+
+to serve captcha images create a directory named `captchas` for example containing subfolders with images and mount to `/var/www/html/4get/data/captcha`
+
+any environment variables prefixed with `FOURGET_` will be added to the generated config
+
+the entrypoint will automatically set the `CAPTCHA_DATASET` value for you based on directory names and number of files in each
+
+to set `INSTANCES` pass a comma separated string of urls (FOURGET_INSTANCES = "https://4get.ca,https://domain.tld")
+
+```
+version: "3.7"
+
+services:
+  fourget:
+    image: luuul/4get:latest
+    restart: always
+    environment:
+      - FOURGET_SERVER_NAME=4get.ca
+
+    ports:
+      - "80:80"
+      - "443:443"
+
+    volumes:
+      - /etc/letsencrypt/live/domain.tld:/etc/4get/certs
+      - ./banners:/var/www/html/4get/banner
+      - ./captchas:/var/www/html/4get/data/captcha
+```
+
+Replace relevant values and start with `docker compose up -d`
diff --git a/docs/nginx.md b/docs/nginx.md
new file mode 100644
index 0000000..8693559
--- /dev/null
+++ b/docs/nginx.md
@@ -0,0 +1,103 @@
+# Install on NGINX
+
+>I do NOT recommend following this guide, only follow this if you *really* need to use nginx. I recommend you use the apache2 steps instead.
+
+Login as root.
+
+Create a file in `/etc/nginx/sites-avaliable/` called `4get.conf` or any name you want and put this into the file:
+
+```
+server {
+    # DO YOU REALLY NEED TO LOG SEARCHES?
+    access_log /dev/null;
+    error_log /dev/null;
+    # Change this if you have 4get in other folder.
+    root /var/www/4get;
+    # Change yourdomain by your domain lol
+    server_name www.yourdomain.com yourdomain.com;
+
+    location @php {
+        try_files $uri.php $uri/index.php =404;
+                # Change the unix socket address if it's different for you.
+        fastcgi_pass unix:/var/run/php-fpm/php-fpm.sock;
+        fastcgi_index index.php;
+                # Change this to `fastcgi_params` if you use a debian based distro.
+        include fastcgi.conf;
+        fastcgi_intercept_errors on;
+    }
+
+    location / {
+        try_files $uri @php;
+    }
+
+    location ~* ^(.*)\.php$ {
+        return 301 $1;
+    }
+
+        listen 80;
+}
+```
+
+That is a very basic config so you will need to adapt it to your needs in case you have a more complicated nginx configuration. Anyways, you can see a real world example [here](https://git.zzls.xyz/Fijxu/etc-configs/src/branch/selfhost/nginx/sites-available/4get.zzls.xyz.conf)
+
+After you save the file you will need to do a symlink of the `4get.conf` file to `/etc/nignx/sites-enabled/`, you can do it with this command: 
+
+```sh
+ln -s /etc/nginx/sites-available/4get.conf /etc/nginx/sites-available/4get.conf
+```
+
+Now test the nginx config with `nginx -t`, if it says that everything is good, restart nginx using `systemctl restart nginx`
+
+# Encryption setup
+
+Generate a certificate for the domain using:
+
+```sh
+certbot --nginx --key-type ecdsa -d www.yourdomain.com -d yourdomain.com
+```
+(Remember to install the nginx certbot plugin!!!)
+
+After doing that certbot should deploy the certificate automatically into your 4get nginx config file. It should be ready to use at that point.
+
+# Tor setup on NGINX
+
+Important Note: Tor onion addresses are significantly longer than traditional domain names. Before proceeding with Nginx configuration, ensure you increase the `server_names_hash_bucket_size` value in your `nginx.conf` file. This setting in your Nginx configuration controls the internal data structure used to manage multiple server names (hostnames) associated with your web server. Each hostname requires a certain amount of memory within this structure. If the size is insufficient, Nginx will encounter errors.
+
+1. Open your `nginx.conf` file (that is under `/etc/nginx/nginx.conf`).
+2. Find the line containing `# server_names_hash_bucket_size 64;`.
+3. Uncomment the line and adjust the value. Start with 64, but if you encounter issues, incrementally increase it (e.g., 128, 256) until it accommodates your configuration.
+
+Open your current 4get NGINX config (that is under `/etc/nginx/sites-available/`) and append this to the end of the file:
+
+```
+server {
+	access_log /dev/null;
+	error_log /dev/null;
+
+    listen 80;
+    server_name <youronionaddress>;
+    root /var/www/4get;
+
+    location @php {
+        try_files $uri.php $uri/index.php =404;
+        # Change the unix socket address if it's different for you.
+        fastcgi_pass unix:/var/run/php-fpm/php-fpm.sock;
+        fastcgi_index index.php;
+        # Change this to `fastcgi_params` if you use a debian based distro.
+        include fastcgi.conf;
+        fastcgi_intercept_errors on;
+    }
+
+    location / {
+        try_files $uri @php;
+    }
+
+    location ~* ^(.*)\.php$ {
+        return 301 $1;
+    }
+}
+```
+
+Obviously replace `<youronionaddress>` by the onion address of `/var/lib/tor/4get/hostname` and then check if the nginx config is valid with `nginx -t` if yes, then restart the nginx service and try opening the onion address into the Tor Browser. You can see a real world example [here](https://git.zzls.xyz/Fijxu/etc-configs/src/branch/selfhost/nginx/sites-available/4get.zzls.xyz.conf)
+
+Once you did the above, refer to <a href="https://git.lolcat.ca/lolcat/4get/src/branch/master/docs/tor.md">this tor guide</a> to setup your onionsite.
diff --git a/docs/tor.md b/docs/tor.md
new file mode 100644
index 0000000..2865348
--- /dev/null
+++ b/docs/tor.md
@@ -0,0 +1,14 @@
+# Tor setup
+This guide assumes that there is already a configured webserver sitting on port 80 waiting for localhost connections. The <a href="https://git.lolcat.ca/lolcat/4get/src/branch/master/docs/apache2.md">apache2 guide</a> guides you through this.
+
+1. Login as `root`.
+2. Install `tor`.
+3. Edit `/etc/tor/torrc`
+4. Go to the line that contains `HiddenServiceDir` and `HiddenServicePort`, uncomment those 2 lines and set them like this: 
+	```
+	HiddenServiceDir /var/lib/tor/4get
+	HiddenServicePort 80 127.0.0.1:80
+	```
+5. Start the tor service using `systemctl start tor`
+6. Wait for a while...
+7. Run `cat /var/lib/tor/4get/hostname`. That is your onion address!