# Rebased/Soapbox inštancia

Rebased/Soapbox je webová služba na spôsob Twittera založená na protokole ActivityPub. Využitie tohto protokolu umožňuje prepájanie rôznych služieb vďaka "federovaniu" (združovaniu) výstupov - predstavte si to tak, že by ste v jednej aplikácii mohli sledovať príspevky z Facebooku (statusy), Twittera (statusy), Instagramu (fotky) a Youtube (videá). 

Tento návod vám pomôže prevádzkovať inštanciu (komunikačný uzol) takejto siete na vlastnom zariadení.

Obsah:
0. Predpríprava
1. Príprava DNS
2. Hardware
3. Inštalácia OS
4. Inštalácia Docker
5. Deployment inštancie
6. Monitoring
7. Inštalácia reverse-proxy
8. Upgrading

## 1. Príprava DNS

1.1 Obstarať doménu - zakúpiť, dohodnúť sa s niekým, kto doménu už má  

1.2 Vytvoriť A záznam pre budúcu inštanciu:  
> Typ záznamu: A  
> TTL: 300  
> Názov: \<FQDN instancie\> \[príklad: vas_server.domena.eu\]  
> Dáta: \<verejna IP adresa vasho servera\>

## 5. Deployment inštancie

5.1 Vytvoriť adresár pre docker kofiguráciu:  
```
mkdir meno_adresara
cd meno_adresara
```

5.2 V adresári vytvoriť súbor docker-compose.yaml s nasledovným obsahom:  
```
services:
  postgres:
    image: postgres
    restart: always
    container_name: vas_server.domena.eu_db
    environment:
      POSTGRES_PASSWORD: vase_heslo
      POSTGRES_USER: postgres
    volumes:
      - "../scif/data/vas_server.domena.eu_db/var/lib/postgresql/data:/var/lib/postgresql/data"
      - "../scif/app/vas_server.domena.eu_db/docker-entrypoint-initdb.d:/docker-entrypoint-initdb.d"
    networks:
      - proxiednet

networks:
  proxiednet:
    external: true
```

5.3 V adresári vytvoriť súbor pleroma.sh s nasledovným obsahom:  
``` 
#!/bin/bash
docker run -d --name vas_server.domena.eu --network proxiednet -e MIX_ENV=prod -e VIRTUAL_PORT=4003 \
  -e VIRTUAL_HOST=vas_server.domena.eu -e LETSENCRYPT_HOST=vas_server.domena.eu \
  --mount type=bind,source="../scif/app/vas_server.domena.eu/opt/pleroma/config/prod.secret.exs",target="/opt/pleroma/config/prod.secret.exs" \
	--mount type=bind,source="../scif/data/vas_server.domena.eu/opt/pleroma/instance/static/robots.txt",target="/opt/pleroma/instance/static/robots.txt" \
  --volume "../scif/data/vas_server.domena.eu/opt/pleroma/instance/static/instance/about:/opt/pleroma/instance/static/instance/about" \
  --volume "../scif/data/vas_server.domena.eu/opt/pleroma/uploads:/opt/pleroma/uploads" \
  --volume "/run/docker.sock:/var/run/docker.sock:ro" \
  mauricethomas/soapbox-docker
```
5.4. Vytvoriť adresárovú štruktúru, ktorá bude mapovaná do Docker kontajnerov:    
```
mkdir -p ../scif/data/vas_server.domena.eu_db/var/lib/postgresql/data
mkdir -p ../scif/app/vas_server.domena.eu_db/docker-entrypoint-initdb.d
mkdir -p ../scif/data/vas_server.domena.eu/opt/pleroma/instance/static/instance/about
mkdir -p ../scif/data/vas_server.domena.eu/opt/pleroma/uploads
mkdir -p ../scif/app/vas_server.domena.eu/opt/pleroma/config
```

5.5 Spustiť kontajner na vygenerovanie konfigurácie:  
`docker run -it mauricethomas/soapbox-docker bash`

5.6 Vytvoriť konfiguráciu inštancie:  
`mix pleroma.instance gen`
Odpovedzte na otázky:  
> What domain will your instance use? (e.g mysite.com) \[\]  vas_server.domena.eu  
> What is the name of your instance? (e.g. Our Wonderful Community) \[vas_server.domena.eu\]  
> What is your admin email address? (this will be public) \[\]  platny_email@nejaka_domena.eu  
> What email address do you want to use for sending email notifications? \[platny_email@nejaka_domena.eu\]  
> Do you want search engines to index your site? (y/n) \[y\]  n  
> Where will your database live? \[localhost\]  vas_server.domena.eu_db  
> What shall we name your database? \[pleroma\]  nazov_databazy  
> What shall we name your database user? \[pleroma\]  meno_uzivatela_databazy  
> What shall be your database password? \[autogenerated\]  
> What port will the app listen to (leave it if you are using the default setup with nginx)? \[4000\]  4003  
> What IP will the app listen to (leave it if you are using the default setup with nginx)? \[127.0.0.1\]  0.0.0.0  
> Writing config to config/generated_config.exs.  
> Writing the postgres script to config/setup_db.psql.  
> Writing /opt/pleroma/instance/static/robots.txt.  

5.7 Nakopírovať vygenerované konfiguračné súbory z kontajnera do konfiguračného adresára inštancie:  
```  
cd meno_adresara
docker container cp nazov_kontainera:/opt/pleroma/config/generated_config.exs prod.secret.exs
docker container cp nazov_kontainera:/opt/pleroma/config/setup_db.psql setup_db.psql
docker container cp nazov_kontainera:/opt/pleroma/instance/static/robots.txt robots.txt
```

5.8 Nakopírovať konfiguračné súbory do adresárov, ktoré budú mapované do kontajnera inštancie:  
```
cp ./prod.secret.exs ../scif/app/vas_server.domena.eu/opt/pleroma/config/prod.secret.exs
cp ./setup_db.psql ../scif/app/vas_server.domena.eu_db/docker-entrypoint-initdb.d/init.sh
cp ./robots.txt ../scif/data/vas_server.domena.eu/opt/pleroma/instance/static/robots.txt
```

5.9 Zmeniť súbor init.sh nasledovne (pridať prvé 3 riadky na začiatok a riadok obsahujuci EOSQL nakoniec):  
```
#!/bin/bash
set -e
psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" --dbname "$POSTGRES_DB" <<-EOSQL
CREATE USER sdbpdev2snc WITH ENCRYPTED PASSWORD 'IHMBvOxHXdBI63AQY/Sd0dCSLJbnTvU5F4Yi0vdfln89OWJDAgMiW1BBtfnPQrIN';
CREATE DATABASE dbpdev OWNER sdbpdev2snc;
\c dbpdev;
--Extensions made by ecto.migrate that need superuser access
CREATE EXTENSION IF NOT EXISTS citext;
CREATE EXTENSION IF NOT EXISTS pg_trgm;
CREATE EXTENSION IF NOT EXISTS "uuid-ossp";
EOSQL
```

5.10 Zmeniť prístupové práva k adresárom tak, aby do nich mohol zapisovať neprivilegovaný užívateľ použitý v kontajneri:  
```
chown -Rf 998:998 ../scif/data/podhubie-dev.2snc.eu/opt/pleroma/instance
chown -Rf 998:998 ../scif/data/podhubie-dev.2snc.eu/opt/pleroma/uploads
```

5.11 Spustiť kontajner s databázou pomocou príkazu docker-compose:  
`docker-compose up -d`

5.12 Spustiť kontajner s inštanciou aplikačného servera:  
`./pleroma.sh`

5.13 Vytvoriť administrátorský účet pre inštanciu:  
`docker container exec -it podhubie-dev.2snc.eu /bin/bash`  
V kontajneri:  
`MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin`  
(napríklad: MIX_ENV=prod mix pleroma.user new meno_admin_uctu platny_email@nejaka_domena.eu --admin)  

> A user will be created with the following information:  
>   \- nickname: meno_admin_uctu  
>   \- email: platny_email@nejaka_domena.eu  
>   \- password: \[generated; a reset link will be created\]  
>   \- name: meno_admin_uctu  
>   \- bio:  
>   \- moderator: false  
>   \- admin: true  
>  
> Continue? \[n\]  y  
> User meno_admin_uctu created  
> Admin status of meno_admin_uctu: truenn
> Generated password reset token for meno_admin_uctu  
> URL: https://vas_server.domena.eu/api/v1/pleroma/password_reset/CEIDUx8m7Svpndj2usdBAaaG1hmOF9SxNsBnpW2aL-8%3D  

V prípade, že password reset odkaz vyexpiruje, je možné vygenerovať nový pomocou príkazu (\<username\> nahradiť skutočným menom používateľa):  
`./bin/pleroma_ctl user reset_password <username>`

## 7. Inštalácia reverse-proxy

7.1 Vytvoriť adresárovú štruktúru, ktorá bude mapovaná do kontajnera:  
```
mkdir -p ../scif/app/reverse-proxy/etc/nginx/certs
mkdir -p ../scif/app/reverse-proxy/etc/nginx/dhparam
mkdir -p ../scif/app/reverse-proxy/etc/nginx/vhost
```

7.2 Vytvoriť konfiguračný súbor pre nginx vo funkcii reverse-proxy v adresári ../scif/app/reverse-proxy/etc/nginx/vhost:  
`vi ../scif/app/reverse-proxy/etc/nginx/vhost/vas_server.domena.eu.conf`
Skopírovať tento obsah (a zmeniť názov domény na váš):
```
# default nginx site config for Pleroma
#
# Simple installation instructions:
# 1. Install your TLS certificate, possibly using Let's Encrypt.
# 2. Replace 'example.tld' with your instance's domain wherever it appears.
# 3. Copy this file to /etc/nginx/sites-available/ and then add a symlink to it
#    in /etc/nginx/sites-enabled/ and run 'nginx -s reload' or restart nginx.

proxy_cache_path /tmp/pleroma-media-cache levels=1:2 keys_zone=pleroma_media_cache:10m max_size=10g
                 inactive=720m use_temp_path=off;

# this is explicitly IPv4 since Pleroma.Web.Endpoint binds on IPv4 only
# and localhost resolves to [::0] on some systems: see issue #930
upstream phoenix {
    server vas_server.domena.eu:4003 max_fails=5 fail_timeout=60s;
}

server {
    server_name    vas_server.domena.eu;

    listen         80;
    listen         [::]:80;

    # Uncomment this if you need to use the 'webroot' method with certbot. Make sure
    # that the directory exists and that it is accessible by the webserver. If you followed
    # the guide, you already ran 'mkdir -p /var/lib/letsencrypt' to create the folder.
    # You may need to load this file with the ssl server block commented out, run certbot
    # to get the certificate, and then uncomment it.
    #
    # location ~ /\.well-known/acme-challenge {
    #     root /var/lib/letsencrypt/;
    # }
    location / {
      return         301 https://$server_name$request_uri;
    }
}

# Enable SSL session caching for improved performance
ssl_session_cache shared:ssl_session_cache:10m;

server {
    server_name vas_server.domena.eu;

    listen 443 ssl http2;
    listen [::]:443 ssl http2;
    ssl_session_timeout 1d;
    ssl_session_cache shared:MozSSL:10m;  # about 40000 sessions
    ssl_session_tickets off;

    ssl_trusted_certificate   /etc/nginx/certs/vas_server.domena.eu/chain.pem;
    ssl_certificate           /etc/nginx/certs/vas_server.domena.eu/fullchain.pem;
    ssl_certificate_key       /etc/nginx/certs/vas_server.domena.eu/key.pem;

    ssl_protocols TLSv1.2 TLSv1.3;
    ssl_ciphers "ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:!aNULL:!eNULL:!EXPORT:!DES:!MD5:!PSK:!RC4";
    ssl_prefer_server_ciphers off;
    # In case of an old server with an OpenSSL version of 1.0.2 or below,
    # leave only prime256v1 or comment out the following line.
    ssl_ecdh_curve X25519:prime256v1:secp384r1:secp521r1;
    ssl_stapling on;
    ssl_stapling_verify on;

    gzip_vary on;
    gzip_proxied any;
    gzip_comp_level 6;
    gzip_buffers 16 8k;
    gzip_http_version 1.1;
    gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript application/activity+json application/atom+xml;

    # the nginx default is 1m, not enough for large media uploads
    client_max_body_size 16m;
    ignore_invalid_headers off;

    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";
    proxy_set_header Host $http_host;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

    location / {
        proxy_pass http://phoenix;
    }

    location ~ ^/(media|proxy) {
        proxy_cache        pleroma_media_cache;
        slice              1m;
        proxy_cache_key    $host$uri$is_args$args$slice_range;
        proxy_set_header   Range $slice_range;
        proxy_cache_valid  200 206 301 304 1h;
        proxy_cache_lock   on;
        proxy_ignore_client_abort on;
        proxy_buffering    on;
        chunked_transfer_encoding on;
        proxy_pass         http://phoenix;
    }
}
```
7.3 Načítať novú konfiguráciu pre nginx:  
`docker exec -it reverse-proxy /etc/init.d/nginx reload`