AkkomaGang/akkoma
AkkomaGang/akkoma
15
65
Fork 92
Code Issues 177 Pull requests 24 Projects 2 Releases 14 Packages Wiki Activity

Update FreeBSD install docs

Browse source
This commit is contained in:
Norm 2022-07-02 13:12:27 -04:00
parent d24c420740
commit 41c8f67453
1 changed files with 21 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
docs/installation/freebsd_en.md
View file

@ -39,22 +39,22 @@ Setup the required services to automatically start at boot, using `sysrc(8)`.
Create a user for Akkoma: Create a user for Akkoma:
``` ```
# pw add user pleroma -m # pw add user akkoma -m
# echo 'export LC_ALL="en_US.UTF-8"' >> /home/pleroma/.profile # echo 'export LC_ALL="en_US.UTF-8"' >> /home/akkoma/.profile
# su -l pleroma # su -l akkoma
``` ```
Clone the repository: Clone the repository:
``` ```
$ cd $HOME # Should be the same as /home/pleroma $ cd $HOME # Should be the same as /home/akkoma
$ git clone https://akkoma.dev/AkkomaGang/akkoma.git $ git clone https://akkoma.dev/AkkomaGang/akkoma.git
``` ```
Configure Akkoma. Note that you need a domain name at this point: Configure Akkoma. Note that you need a domain name at this point:
``` ```
$ cd /home/pleroma/pleroma $ cd /home/akkoma/akkoma
$ mix deps.get # Enter "y" when asked to install Hex $ mix deps.get # Enter "y" when asked to install Hex
$ MIX_ENV=prod mix pleroma.instance gen # You will be asked a few questions here. $ MIX_ENV=prod mix pleroma.instance gen # You will be asked a few questions here.
$ cp config/generated_config.exs config/prod.secret.exs $ cp config/generated_config.exs config/prod.secret.exs
@ -66,7 +66,7 @@ now be a file in `config/setup_db.psql` that makes this easier. Edit it, and
it'll be protecting your database. As root, you can now initialize the database: it'll be protecting your database. As root, you can now initialize the database:
``` ```
# cd /home/pleroma/pleroma # cd /home/akkoma/akkoma
# sudo -Hu postgres -g postgres psql -f config/setup_db.psql # sudo -Hu postgres -g postgres psql -f config/setup_db.psql
``` ```
@ -81,11 +81,11 @@ Once this is done, restart Postgres with:
Run the database migrations. Run the database migrations.
Back as the pleroma user, run the following to implement any database migrations. Back as the akkoma user, run the following to implement any database migrations.
``` ```
# su -l pleroma # su -l akkoma
$ cd /home/pleroma/pleroma $ cd /home/akkoma/akkoma
$ MIX_ENV=prod mix ecto.migrate $ MIX_ENV=prod mix ecto.migrate
``` ```
@ -163,10 +163,10 @@ http {
} }
``` ```
As root, copy `/home/pleroma/pleroma/installation/pleroma.nginx` to As root, copy `/home/akkoma/akkoma/installation/akkoma.nginx` to
`/usr/local/etc/nginx/sites-available/pleroma.nginx`. `/usr/local/etc/nginx/sites-available/akkoma.nginx`.
Edit the defaults of `/usr/local/etc/nginx/sites-available/pleroma.nginx`: Edit the defaults of `/usr/local/etc/nginx/sites-available/akkoma.nginx`:
* Change `ssl_trusted_certificate` to `/var/db/acme/certs/example.tld/example.tld.cer`. * 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` to `/var/db/acme/certs/example.tld/fullchain.cer`.
@ -176,27 +176,27 @@ Edit the defaults of `/usr/local/etc/nginx/sites-available/pleroma.nginx`:
## Creating a startup script for Akkoma ## Creating a startup script for Akkoma
Akkoma will need to compile when it initially starts, which typically takes a longer Akkoma will need to compile when it initially starts, which typically takes a longer
period of time. Therefore, it is good practice to initially run pleroma from the period of time. Therefore, it is good practice to initially run akkoma from the
command-line before utilizing the rc.d script. That is done as follows: command-line before utilizing the rc.d script. That is done as follows:
``` ```
# su -l pleroma # su -l akkoma
$ cd $HOME/pleroma $ cd $HOME/akkoma
$ MIX_ENV=prod mix phx.server $ MIX_ENV=prod mix phx.server
``` ```
Copy the startup script to the correct location and make sure it's executable: Copy the startup script to the correct location and make sure it's executable:
``` ```
# cp /home/pleroma/pleroma/installation/freebsd/rc.d/pleroma /usr/local/etc/rc.d/pleroma # cp /home/akkoma/akkoma/installation/freebsd/rc.d/akkoma /usr/local/etc/rc.d/akkoma
# chmod +x /usr/local/etc/rc.d/pleroma # chmod +x /usr/local/etc/rc.d/akkoma
``` ```
Update the `/etc/rc.conf` and start pleroma with the following commands: Update the `/etc/rc.conf` and start akkoma with the following commands:
``` ```
# sysrc pleroma_enable=YES # sysrc akkoma_enable=YES
# service pleroma start # service akkoma start
``` ```
#### Create your first user #### Create your first user
@ -204,7 +204,7 @@ Update the `/etc/rc.conf` and start pleroma with the following commands:
If your instance is up and running, you can create your first user with administrative rights with the following task: If your instance is up and running, you can create your first user with administrative rights with the following task:
```shell ```shell
sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin sudo -Hu akkoma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
``` ```
## Conclusion ## Conclusion