HTTP header improvements (#294)
[akkoma] / docs / docs / installation / openbsd_en.md
1 # Installing on OpenBSD
2
3 This guide describes the installation and configuration of akkoma (and the required software to run it) on a single OpenBSD 6.6 server.
4
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.
6
7 {! installation/generic_dependencies.include !}
8
9 ### Preparing the system
10 #### Required software
11
12 To install them, run the following command (with doas or as root):
13
14 ```
15 pkg_add elixir gmake git postgresql-server postgresql-contrib cmake ffmpeg ImageMagick
16 ```
17
18 Akkoma 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.
19
20 #### Optional software
21
22 Per [`docs/installation/optional/media_graphics_packages.md`](../installation/optional/media_graphics_packages.md):
23 * ImageMagick
24 * ffmpeg
25 * exiftool
26
27 To install the above:
28
29 ```
30 pkg_add ImageMagick ffmpeg p5-Image-ExifTool
31 ```
32
33 #### Creating the akkoma user
34 Akkoma will be run by a dedicated user, \_akkoma. Before creating it, insert the following lines in login.conf:
35 ```
36 akkoma:\
37 :datasize-max=1536M:\
38 :datasize-cur=1536M:\
39 :openfiles-max=4096
40 ```
41 This creates a "akkoma" 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 akkoma crash some time after starting.
42
43 Create the \_akkoma user, assign it the akkoma login class and create its home directory (/home/\_akkoma/): `useradd -m -L akkoma _akkoma`
44
45 #### Clone akkoma's directory
46 Enter a shell as the \_akkoma user. As root, run `su _akkoma -;cd`. Then clone the repository with `git clone https://akkoma.dev/AkkomaGang/akkoma.git`. Akkoma is now installed in /home/\_akkoma/akkoma/, it will be configured and started at the end of this guide.
47
48 #### PostgreSQL
49 Start a shell as the \_postgresql user (as root run `su _postgresql -` then run the `initdb` command to initialize postgresql:
50 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:
51
52 ```
53 initdb -D /var/postgresql/data -U postgres
54 ```
55 If you are not using the default directory, you will have to update the `datadir` variable in the /etc/rc.d/postgresql script.
56
57 When this is done, enable postgresql so that it starts on boot and start it. As root, run:
58 ```
59 rcctl enable postgresql
60 rcctl start postgresql
61 ```
62 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.
63
64 #### httpd
65 httpd will have three fuctions:
66
67 * redirect requests trying to reach the instance over http to the https URL
68 * serve a robots.txt file
69 * get Let's Encrypt certificates, with acme-client
70
71 Insert the following config in httpd.conf:
72 ```
73 # $OpenBSD: httpd.conf,v 1.17 2017/04/16 08:50:49 ajacoutot Exp $
74
75 ext_inet="<IPv4 address>"
76 ext_inet6="<IPv6 address>"
77
78 server "default" {
79 listen on $ext_inet port 80 # Comment to disable listening on IPv4
80 listen on $ext_inet6 port 80 # Comment to disable listening on IPv6
81 listen on 127.0.0.1 port 80 # Do NOT comment this line
82
83 log syslog
84 directory no index
85
86 location "/.well-known/acme-challenge/*" {
87 root "/acme"
88 request strip 2
89 }
90
91 location "/robots.txt" { root "/htdocs/local/" }
92 location "/*" { block return 302 "https://$HTTP_HOST$REQUEST_URI" }
93 }
94
95 types {
96 }
97 ```
98 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.
99
100 Create the /var/www/htdocs/local/ folder and write the content of your robots.txt in /var/www/htdocs/local/robots.txt.
101 Check the configuration with `httpd -n`, if it is OK enable and start httpd (as root):
102 ```
103 rcctl enable httpd
104 rcctl start httpd
105 ```
106
107 #### acme-client
108 acme-client is used to get SSL/TLS certificates from Let's Encrypt.
109 Insert the following configuration in /etc/acme-client.conf:
110 ```
111 #
112 # $OpenBSD: acme-client.conf,v 1.4 2017/03/22 11:14:14 benno Exp $
113 #
114
115 authority letsencrypt-<domain name> {
116 #agreement url "https://letsencrypt.org/documents/LE-SA-v1.2-November-15-2017.pdf"
117 api url "https://acme-v02.api.letsencrypt.org/directory"
118 account key "/etc/acme/letsencrypt-privkey-<domain name>.pem"
119 }
120
121 domain <domain name> {
122 domain key "/etc/ssl/private/<domain name>.key"
123 domain certificate "/etc/ssl/<domain name>.crt"
124 domain full chain certificate "/etc/ssl/<domain name>.fullchain.pem"
125 sign with letsencrypt-<domain name>
126 challengedir "/var/www/acme/"
127 }
128 ```
129 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.
130 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`.
131
132 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:
133 ```
134 ln -s /etc/ssl/<domain name>.fullchain.pem /etc/ssl/<IP address>.crt
135 ln -s /etc/ssl/private/<domain name>.key /etc/ssl/private/<IP address>.key
136 ```
137 This will have to be done for each IPv4 and IPv6 address relayd listens on.
138
139 #### relayd
140 relayd will be used as the reverse proxy sitting in front of akkoma.
141 Insert the following configuration in /etc/relayd.conf:
142 ```
143 # $OpenBSD: relayd.conf,v 1.4 2018/03/23 09:55:06 claudio Exp $
144
145 ext_inet="<IPv4 address>"
146 ext_inet6="<IPv6 address>"
147
148 table <akkoma_server> { 127.0.0.1 }
149 table <httpd_server> { 127.0.0.1 }
150
151 http protocol plerup { # Protocol for upstream akkoma server
152 #tcp { nodelay, sack, socket buffer 65536, backlog 128 } # Uncomment and adjust as you see fit
153 tls ciphers "ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305"
154 tls ecdhe secp384r1
155
156 # Forward some paths to the local server (as akkoma won't respond to them as you might want)
157 pass request quick path "/robots.txt" forward to <httpd_server>
158
159 # Append a bunch of headers
160 match request header append "X-Forwarded-For" value "$REMOTE_ADDR" # This two header and the next one are not strictly required by akkoma but adding them won't hurt
161 match request header append "X-Forwarded-By" value "$SERVER_ADDR:$SERVER_PORT"
162
163 match response header append "X-XSS-Protection" value "0"
164 match response header append "X-Permitted-Cross-Domain-Policies" value "none"
165 match response header append "X-Frame-Options" value "DENY"
166 match response header append "X-Content-Type-Options" value "nosniff"
167 match response header append "Referrer-Policy" value "same-origin"
168 match response header append "Content-Security-Policy" value "default-src 'none'; base-uri 'none'; 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
169 match request header append "Connection" value "upgrade"
170 #match response header append "Strict-Transport-Security" value "max-age=63072000; includeSubDomains; preload" # Uncomment this only after you get HTTPS working.
171
172 # If you do not want remote frontends to be able to access your Akkoma backend server, comment these lines
173 match response header append "Access-Control-Allow-Origin" value "*"
174 match response header append "Access-Control-Allow-Methods" value "POST, PUT, DELETE, GET, PATCH, OPTIONS"
175 match response header append "Access-Control-Allow-Headers" value "Authorization, Content-Type, Idempotency-Key"
176 match response header append "Access-Control-Expose-Headers" value "Link, X-RateLimit-Reset, X-RateLimit-Limit, X-RateLimit-Remaining, X-Request-Id"
177 # Stop commenting lines here
178 }
179
180 relay wwwtls {
181 listen on $ext_inet port https tls # Comment to disable listening on IPv4
182 listen on $ext_inet6 port https tls # Comment to disable listening on IPv6
183
184 protocol plerup
185
186 forward to <akkoma_server> port 4000 check http "/" code 200
187 forward to <httpd_server> port 80 check http "/robots.txt" code 200
188 }
189 ```
190 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\>*.
191 Check the configuration with `relayd -n`, if it is OK enable and start relayd (as root):
192 ```
193 rcctl enable relayd
194 rcctl start relayd
195 ```
196
197 #### pf
198 Enabling and configuring pf is highly recommended.
199 In /etc/pf.conf, insert the following configuration:
200 ```
201 # Macros
202 if="<network interface>"
203 authorized_ssh_clients="any"
204
205 # Skip traffic on loopback interface
206 set skip on lo
207
208 # Default behavior
209 set block-policy drop
210 block in log all
211 pass out quick
212
213 # Security features
214 match in all scrub (no-df random-id)
215 block in log from urpf-failed
216
217 # Rules
218 pass in quick on $if inet proto icmp to ($if) icmp-type { echoreq unreach paramprob trace } # ICMP
219 pass in quick on $if inet6 proto icmp6 to ($if) icmp6-type { echoreq unreach paramprob timex toobig } # ICMPv6
220 pass in quick on $if proto tcp to ($if) port { http https } # relayd/httpd
221 pass in quick on $if proto tcp from $authorized_ssh_clients to ($if) port ssh
222 ```
223 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.
224
225 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`.
226
227 #### Configure and start akkoma
228 Enter a shell as \_akkoma (as root `su _akkoma -`) and enter akkoma's installation directory (`cd ~/akkoma/`).
229
230 Then follow the main installation guide:
231
232 * run `mix deps.get`
233 * run `MIX_ENV=prod mix pleroma.instance gen` and enter your instance's information when asked
234 * 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.
235 * exit your current shell back to a root one and run `psql -U postgres -f /home/_akkoma/akkoma/config/setup_db.psql` to setup the database.
236 * return to a \_akkoma shell into akkoma's installation directory (`su _akkoma -;cd ~/akkoma`) and run `MIX_ENV=prod mix ecto.migrate`
237
238 As \_akkoma in /home/\_akkoma/akkoma, you can now run `LC_ALL=en_US.UTF-8 MIX_ENV=prod mix phx.server` to start your instance.
239 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.
240
241 ##### Starting akkoma at boot
242 An rc script to automatically start akkoma at boot hasn't been written yet, it can be run in a tmux session (tmux is in base).
243
244
245 #### Create administrative user
246
247 If your instance is up and running, you can create your first user with administrative rights with the following command as the \_akkoma user.
248 ```
249 LC_ALL=en_US.UTF-8 MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
250 ```
251
252 {! installation/frontends.include !}
253
254 #### Further reading
255
256 {! installation/further_reading.include !}
257
258 {! support.include !}