1 # Installing on FreeBSD
3 This document was written for FreeBSD 12.1, but should be work on future releases.
5 {! backend/installation/generic_dependencies.include !}
7 ## Installing software used in this guide
9 This assumes the target system has `pkg(8)`.
12 # pkg install elixir postgresql12-server postgresql12-client postgresql12-contrib git-lite sudo nginx gmake acme.sh cmake
15 Copy the rc.d scripts to the right directory:
17 Setup the required services to automatically start at boot, using `sysrc(8)`.
20 # sysrc nginx_enable=YES
21 # sysrc postgresql_enable=YES
24 ## Initialize postgres
27 # service postgresql initdb
28 # service postgresql start
31 ### Install media / graphics packages (optional, see [`docs/installation/optional/media_graphics_packages.md`](../installation/optional/media_graphics_packages.md))
34 # pkg install imagemagick ffmpeg p5-Image-ExifTool
37 ## Configuring Pleroma
39 Create a user for Pleroma:
42 # pw add user pleroma -m
43 # echo 'export LC_ALL="en_US.UTF-8"' >> /home/pleroma/.profile
50 $ cd $HOME # Should be the same as /home/pleroma
51 $ git clone -b stable https://git.pleroma.social/pleroma/pleroma.git
54 Configure Pleroma. Note that you need a domain name at this point:
57 $ cd /home/pleroma/pleroma
58 $ mix deps.get # Enter "y" when asked to install Hex
59 $ MIX_ENV=prod mix pleroma.instance gen # You will be asked a few questions here.
60 $ cp config/generated_config.exs config/prod.secret.exs
63 Since Postgres is configured, we can now initialize the database. There should
64 now be a file in `config/setup_db.psql` that makes this easier. Edit it, and
65 *change the password* to a password of your choice. Make sure it is secure, since
66 it'll be protecting your database. As root, you can now initialize the database:
69 # cd /home/pleroma/pleroma
70 # sudo -Hu postgres -g postgres psql -f config/setup_db.psql
73 Postgres allows connections from all users without a password by default. To
74 fix this, edit `/var/db/postgres/data12/pg_hba.conf`. Change every `trust` to
77 Once this is done, restart Postgres with:
79 # service postgresql restart
82 Run the database migrations.
84 Back as the pleroma user, run the following to implement any database migrations.
88 $ cd /home/pleroma/pleroma
89 $ MIX_ENV=prod mix ecto.migrate
92 You will need to do this whenever you update with `git pull`:
94 ## Configuring acme.sh
96 We'll be using acme.sh in Stateless Mode for TLS certificate renewal.
98 First, as root, allow the user `acme` to have access to the acme log file, as follows:
101 # touch /var/log/acme.sh.log
102 # chown acme:acme /var/log/acme.sh.log
103 # chmod 600 /var/log/acme.sh.log
106 Next, obtain your account fingerprint:
109 # sudo -Hu acme -g acme acme.sh --register-account
112 You need to add the following to your nginx configuration for the server
116 location ~ ^/\.well-known/acme-challenge/([-_a-zA-Z0-9]+)$ {
117 default_type text/plain;
118 return 200 "$1.6fXAG9VyG0IahirPEU2ZerUtItW2DHzDzD9wZaEKpqd";
122 Replace the string after after `$1.` with your fingerprint.
127 # service nginx start
130 It should now be possible to issue a cert (replace `example.com`
131 with your domain name):
134 # sudo -Hu acme -g acme acme.sh --issue -d example.com --stateless
137 Let's add auto-renewal to `/etc/crontab`
138 (replace `example.com` with your domain):
141 /usr/local/bin/sudo -Hu acme -g acme /usr/local/sbin/acme.sh -r -d example.com --stateless
144 ### Configuring nginx
146 FreeBSD's default nginx configuration does not contain an include directive, which is
147 typically used for multiple sites. Therefore, you will need to first create the required
148 directory as follows:
152 # mkdir -p /usr/local/etc/nginx/sites-available
155 Next, add an `include` directive to `/usr/local/etc/nginx/nginx.conf`, within the `http {}`
162 include /usr/local/etc/nginx/sites-available/*;
166 As root, copy `/home/pleroma/pleroma/installation/pleroma.nginx` to
167 `/usr/local/etc/nginx/sites-available/pleroma.nginx`.
169 Edit the defaults of `/usr/local/etc/nginx/sites-available/pleroma.nginx`:
171 * Change `ssl_trusted_certificate` to `/var/db/acme/certs/example.tld/example.tld.cer`.
172 * Change `ssl_certificate` to `/var/db/acme/certs/example.tld/fullchain.cer`.
173 * Change `ssl_certificate_key` to `/var/db/acme/certs/example.tld/example.tld.key`.
174 * Change all references of `example.tld` to your instance's domain name.
176 ## Creating a startup script for Pleroma
178 Pleroma will need to compile when it initially starts, which typically takes a longer
179 period of time. Therefore, it is good practice to initially run pleroma from the
180 command-line before utilizing the rc.d script. That is done as follows:
185 $ MIX_ENV=prod mix phx.server
188 Copy the startup script to the correct location and make sure it's executable:
191 # cp /home/pleroma/pleroma/installation/freebsd/rc.d/pleroma /usr/local/etc/rc.d/pleroma
192 # chmod +x /usr/local/etc/rc.d/pleroma
195 Update the `/etc/rc.conf` and start pleroma with the following commands:
198 # sysrc pleroma_enable=YES
199 # service pleroma start
202 #### Create your first user
204 If your instance is up and running, you can create your first user with administrative rights with the following task:
207 sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
211 Restart nginx with `# service nginx restart` and you should be up and running.
213 Make sure your time is in sync, or other instances will receive your posts with
214 incorrect timestamps. You should have ntpd running.
218 Questions about the installation or didn’t it work as it should be, ask in [#pleroma:libera.chat](https://matrix.to/#/#pleroma:libera.chat) via Matrix or **#pleroma** on **libera.chat** via IRC.