Frontend mix task: Add tests.

[akkoma] / docs / installation / freebsd_en.md

diff --git a/docs/installation/freebsd_en.md b/docs/installation/freebsd_en.md
index a8741e56581dd280b6e0535beb5c71f903b027c8..130d68766de4d2457fd8d86242fc39dacc3dcfc0 100644 (file)
--- a/docs/installation/freebsd_en.md
+++ b/docs/installation/freebsd_en.md
@@ -1,13 +1,14 @@
 # Installing on FreeBSD 
 
-This document was written for FreeBSD 12.1, but should be trivially trailerable to future releases.
-Additionally, this guide document can be modified to 
+This document was written for FreeBSD 12.1, but should be work on future releases.
 
 ## Required software 
 
 This assumes the target system has `pkg(8)`.
 
-`# pkg install elixir postgresql12-server postgresql12-client postgresql12-contrib git-lite sudo nginx gmake acme.sh`
+```
+# pkg install elixir postgresql12-server postgresql12-client postgresql12-contrib git-lite sudo nginx gmake acme.sh
+```
 
 Copy the rc.d scripts to the right directory:
 
@@ -48,7 +49,7 @@ Configure Pleroma. Note that you need a domain name at this point:
 $ cd /home/pleroma/pleroma
 $ mix deps.get # Enter "y" when asked to install Hex
 $ mix pleroma.instance gen # You will be asked a few questions here.
-$ cp config/generated_config.exs config/prod.secret.exs # The default values should be sufficient but you should edit it and check that everything seems OK.
+$ cp config/generated_config.exs config/prod.secret.exs
 ```
 
 Since Postgres is configured, we can now initialize the database. There should
@@ -65,7 +66,10 @@ Postgres allows connections from all users without a password by default. To
 fix this, edit `/var/db/postgres/data12/pg_hba.conf`. Change every `trust` to
 `password`.
 
-Once this is done, restart Postgres with `# service postgresql restart`.
+Once this is done, restart Postgres with:
+```
+# service postgresql restart
+```
 
 Run the database migrations.
 
@@ -119,24 +123,14 @@ It should now be possible to issue a cert (replace `example.com`
 with your domain name):
 
 ```
-$ sudo -Hu acme -g acme acme.sh --issue -d example.com --stateless
-$ acme.sh --install-cert -d example.com \
-       --key-file       /path/to/keyfile/in/nginx/key.pem  \
-       --fullchain-file /path/to/fullchain/nginx/cert.pem \
+# sudo -Hu acme -g acme acme.sh --issue -d example.com --stateless
 ```
 
-Let's add auto-renewal to `/etc/daily.local`
+Let's add auto-renewal to `/etc/crontab`
 (replace `example.com` with your domain):
 
 ```
-/usr/local/bin/sudo -Hu acme -g acme \
-    /usr/local/sbin/acme.sh -r \
-    -d example.com \
-    --cert-file /etc/nginx/tls/cert \
-    --key-file /etc/nginx/tls/key \
-    --ca-file /etc/nginx/tls/ca \
-    --fullchain-file /etc/nginx/tls/fullchain \
-    --stateless
+/usr/local/bin/sudo -Hu acme -g acme /usr/local/sbin/acme.sh -r -d example.com --stateless
 ```
 
 ### Configuring nginx
@@ -157,18 +151,18 @@ block, as follows:
 ```
 http {
 ...
-       include /usr/local/etc/nginx/sites-available/*.conf;
+       include /usr/local/etc/nginx/sites-available/*;
 }
 ```
 
 As root, copy `/home/pleroma/pleroma/installation/pleroma.nginx` to
-`/usr/local/etc/nginx/sites-available/pleroma.conf`.
+`/usr/local/etc/nginx/sites-available/pleroma.nginx`.
 
-Edit the defaults of `/usr/local/etc/nginx/sites-available/pleroma.conf`:
+Edit the defaults of `/usr/local/etc/nginx/sites-available/pleroma.nginx`:
 
-* Change `ssl_trusted_certificate` to `/etc/ssl/example.tld/chain.pem`.
-* Change `ssl_certificate` to `/etc/ssl/example.tld/fullchain.pem`.
-* Change `ssl_certificate_key` to `/etc/ssl/example.tld/privkey.pem`.
+* Change `ssl_trusted_certificate` to `/var/db/acme/certs/example.tld/example.tld.cer`.
+* Change `ssl_certificate` to `/var/db/acme/certs/example.tld/fullchain.cer`.
+* Change `ssl_certificate_key` to `/var/db/acme/certs/example.tld/example.tld.key`.
 * Change all references of `example.tld` to your instance's domain name.
 
 ## Creating a startup script for Pleroma
@@ -197,8 +191,13 @@ Update the `/etc/rc.conf` and start pleroma with the following commands:
 # service pleroma start
 ```
 
-Now you can start pleroma with `# service pleroma start`.
+#### Create your first user
+
+If your instance is up and running, you can create your first user with administrative rights with the following task:
 
+```shell
+sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
+```
 ## Conclusion
 
 Restart nginx with `# service nginx restart` and you should be up and running.