1 # Installing on OpenBSD
3 This guide describes the installation and configuration of pleroma (and the required software to run it) on a single OpenBSD 6.6 server.
5 For any additional information regarding commands and configuration files mentioned here, check the man pages [online](https://man.openbsd.org/) or directly on your server with the man command.
9 The following packages need to be installed:
18 To install them, run the following command (with doas or as root):
21 pkg_add elixir gmake ImageMagick git postgresql-server postgresql-contrib
24 Pleroma requires a reverse proxy, OpenBSD has relayd in base (and is used in this guide) and packages/ports are available for nginx (www/nginx) and apache (www/apache-httpd). Independently of the reverse proxy, [acme-client(1)](https://man.openbsd.org/acme-client) can be used to get a certificate from Let's Encrypt.
26 #### Creating the pleroma user
27 Pleroma will be run by a dedicated user, \_pleroma. Before creating it, insert the following lines in login.conf:
34 This creates a "pleroma" login class and sets higher values than default for datasize and openfiles (see [login.conf(5)](https://man.openbsd.org/login.conf)), this is required to avoid having pleroma crash some time after starting.
36 Create the \_pleroma user, assign it the pleroma login class and create its home directory (/home/\_pleroma/): `useradd -m -L pleroma _pleroma`
38 #### Clone pleroma's directory
39 Enter a shell as the \_pleroma user. As root, run `su _pleroma -;cd`. Then clone the repository with `git clone -b stable https://git.pleroma.social/pleroma/pleroma.git`. Pleroma is now installed in /home/\_pleroma/pleroma/, it will be configured and started at the end of this guide.
42 Start a shell as the \_postgresql user (as root run `su _postgresql -` then run the `initdb` command to initialize postgresql:
43 You will need to specify pgdata directory to the default (/var/postgresql/data) with the `-D <path>` and set the user to postgres with the `-U <username>` flag. This can be done as follows:
46 initdb -D /var/postgresql/data -U postgres
48 If you are not using the default directory, you will have to update the `datadir` variable in the /etc/rc.d/postgresql script.
50 When this is done, enable postgresql so that it starts on boot and start it. As root, run:
52 rcctl enable postgresql
53 rcctl start postgresql
55 To check that it started properly and didn't fail right after starting, you can run `ps aux | grep postgres`, there should be multiple lines of output.
58 httpd will have three fuctions:
60 * redirect requests trying to reach the instance over http to the https URL
61 * serve a robots.txt file
62 * get Let's Encrypt certificates, with acme-client
64 Insert the following config in httpd.conf:
66 # $OpenBSD: httpd.conf,v 1.17 2017/04/16 08:50:49 ajacoutot Exp $
68 ext_inet="<IPv4 address>"
69 ext_inet6="<IPv6 address>"
72 listen on $ext_inet port 80 # Comment to disable listening on IPv4
73 listen on $ext_inet6 port 80 # Comment to disable listening on IPv6
74 listen on 127.0.0.1 port 80 # Do NOT comment this line
79 location "/.well-known/acme-challenge/*" {
84 location "/robots.txt" { root "/htdocs/local/" }
85 location "/*" { block return 302 "https://$HTTP_HOST$REQUEST_URI" }
91 Do not forget to change *<IPv4/6 address\>* to your server's address(es). If httpd should only listen on one protocol family, comment one of the two first *listen* options.
93 Create the /var/www/htdocs/local/ folder and write the content of your robots.txt in /var/www/htdocs/local/robots.txt.
94 Check the configuration with `httpd -n`, if it is OK enable and start httpd (as root):
101 acme-client is used to get SSL/TLS certificates from Let's Encrypt.
102 Insert the following configuration in /etc/acme-client.conf:
105 # $OpenBSD: acme-client.conf,v 1.4 2017/03/22 11:14:14 benno Exp $
108 authority letsencrypt-<domain name> {
109 #agreement url "https://letsencrypt.org/documents/LE-SA-v1.2-November-15-2017.pdf"
110 api url "https://acme-v02.api.letsencrypt.org/directory"
111 account key "/etc/acme/letsencrypt-privkey-<domain name>.pem"
114 domain <domain name> {
115 domain key "/etc/ssl/private/<domain name>.key"
116 domain certificate "/etc/ssl/<domain name>.crt"
117 domain full chain certificate "/etc/ssl/<domain name>.fullchain.pem"
118 sign with letsencrypt-<domain name>
119 challengedir "/var/www/acme/"
122 Replace *<domain name\>* by the domain name you'll use for your instance. As root, run `acme-client -n` to check the config, then `acme-client -ADv <domain name>` to create account and domain keys, and request a certificate for the first time.
123 Make acme-client run everyday by adding it in /etc/daily.local. As root, run the following command: `echo "acme-client <domain name>" >> /etc/daily.local`.
125 Relayd will look for certificates and keys based on the address it listens on (see next part), the easiest way to make them available to relayd is to create a link, as root run:
127 ln -s /etc/ssl/<domain name>.fullchain.pem /etc/ssl/<IP address>.crt
128 ln -s /etc/ssl/private/<domain name>.key /etc/ssl/private/<IP address>.key
130 This will have to be done for each IPv4 and IPv6 address relayd listens on.
133 relayd will be used as the reverse proxy sitting in front of pleroma.
134 Insert the following configuration in /etc/relayd.conf:
136 # $OpenBSD: relayd.conf,v 1.4 2018/03/23 09:55:06 claudio Exp $
138 ext_inet="<IPv4 address>"
139 ext_inet6="<IPv6 address>"
141 table <pleroma_server> { 127.0.0.1 }
142 table <httpd_server> { 127.0.0.1 }
144 http protocol plerup { # Protocol for upstream pleroma server
145 #tcp { nodelay, sack, socket buffer 65536, backlog 128 } # Uncomment and adjust as you see fit
146 tls ciphers "ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305"
149 # Forward some paths to the local server (as pleroma won't respond to them as you might want)
150 pass request quick path "/robots.txt" forward to <httpd_server>
152 # Append a bunch of headers
153 match request header append "X-Forwarded-For" value "$REMOTE_ADDR" # This two header and the next one are not strictly required by pleroma but adding them won't hurt
154 match request header append "X-Forwarded-By" value "$SERVER_ADDR:$SERVER_PORT"
156 match response header append "X-XSS-Protection" value "1; mode=block"
157 match response header append "X-Permitted-Cross-Domain-Policies" value "none"
158 match response header append "X-Frame-Options" value "DENY"
159 match response header append "X-Content-Type-Options" value "nosniff"
160 match response header append "Referrer-Policy" value "same-origin"
161 match response header append "X-Download-Options" value "noopen"
162 match response header append "Content-Security-Policy" value "default-src 'none'; base-uri 'self'; form-action 'self'; img-src 'self' data: https:; media-src 'self' https:; style-src 'self' 'unsafe-inline'; font-src 'self'; script-src 'self'; connect-src 'self' wss://CHANGEME.tld; upgrade-insecure-requests;" # Modify "CHANGEME.tld" and set your instance's domain here
163 match request header append "Connection" value "upgrade"
164 #match response header append "Strict-Transport-Security" value "max-age=31536000; includeSubDomains" # Uncomment this only after you get HTTPS working.
166 # If you do not want remote frontends to be able to access your Pleroma backend server, comment these lines
167 match response header append "Access-Control-Allow-Origin" value "*"
168 match response header append "Access-Control-Allow-Methods" value "POST, PUT, DELETE, GET, PATCH, OPTIONS"
169 match response header append "Access-Control-Allow-Headers" value "Authorization, Content-Type, Idempotency-Key"
170 match response header append "Access-Control-Expose-Headers" value "Link, X-RateLimit-Reset, X-RateLimit-Limit, X-RateLimit-Remaining, X-Request-Id"
171 # Stop commenting lines here
175 listen on $ext_inet port https tls # Comment to disable listening on IPv4
176 listen on $ext_inet6 port https tls # Comment to disable listening on IPv6
180 forward to <pleroma_server> port 4000 check http "/" code 200
181 forward to <httpd_server> port 80 check http "/robots.txt" code 200
184 Again, change *<IPv4/6 address\>* to your server's address(es) and comment one of the two *listen* options if needed. Also change *wss://CHANGEME.tld* to *wss://<your instance's domain name\>*.
185 Check the configuration with `relayd -n`, if it is OK enable and start relayd (as root):
192 Enabling and configuring pf is highly recommended.
193 In /etc/pf.conf, insert the following configuration:
196 if="<network interface>"
197 authorized_ssh_clients="any"
199 # Skip traffic on loopback interface
203 set block-policy drop
208 match in all scrub (no-df random-id)
209 block in log from urpf-failed
212 pass in quick on $if inet proto icmp to ($if) icmp-type { echoreq unreach paramprob trace } # ICMP
213 pass in quick on $if inet6 proto icmp6 to ($if) icmp6-type { echoreq unreach paramprob timex toobig } # ICMPv6
214 pass in quick on $if proto tcp to ($if) port { http https } # relayd/httpd
215 pass in quick on $if proto tcp from $authorized_ssh_clients to ($if) port ssh
217 Replace *<network interface\>* by your server's network interface name (which you can get with ifconfig). Consider replacing the content of the authorized\_ssh\_clients macro by, for exemple, your home IP address, to avoid SSH connection attempts from bots.
219 Check pf's configuration by running `pfctl -nf /etc/pf.conf`, load it with `pfctl -f /etc/pf.conf` and enable pf at boot with `rcctl enable pf`.
221 #### Configure and start pleroma
222 Enter a shell as \_pleroma (as root `su _pleroma -`) and enter pleroma's installation directory (`cd ~/pleroma/`).
224 Then follow the main installation guide:
227 * run `mix pleroma.instance gen` and enter your instance's information when asked
228 * copy config/generated\_config.exs to config/prod.secret.exs. The default values should be sufficient but you should edit it and check that everything seems OK.
229 * exit your current shell back to a root one and run `psql -U postgres -f /home/_pleroma/pleroma/config/setup_db.psql` to setup the database.
230 * return to a \_pleroma shell into pleroma's installation directory (`su _pleroma -;cd ~/pleroma`) and run `MIX_ENV=prod mix ecto.migrate`
232 As \_pleroma in /home/\_pleroma/pleroma, you can now run `LC_ALL=en_US.UTF-8 MIX_ENV=prod mix phx.server` to start your instance.
233 In another SSH session/tmux window, check that it is working properly by running `ftp -MVo - http://127.0.0.1:4000/api/v1/instance`, you should get json output. Double-check that *uri*'s value is your instance's domain name.
235 ##### Starting pleroma at boot
236 An rc script to automatically start pleroma at boot hasn't been written yet, it can be run in a tmux session (tmux is in base).
239 #### Create administrative user
241 If your instance is up and running, you can create your first user with administrative rights with the following command as the \_pleroma user.
243 LC_ALL=en_US.UTF-8 MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin