First
[anni] / docs / installation / gentoo_en.md
1 # Installing on Gentoo GNU/Linux
2
3 {! backend/installation/otp_vs_from_source_source.include !}
4
5 ## Installation
6
7 This guide will assume that you have administrative rights, either as root or a user with [sudo permissions](https://wiki.gentoo.org/wiki/Sudo). Lines that begin with `#` indicate that they should be run as the superuser. Lines using `$` should be run as the indicated user, e.g. `pleroma$` should be run as the `pleroma` user.
8
9 {! backend/installation/generic_dependencies.include !}
10
11 ### Your make.conf, package.use, and USE flags
12
13 The only specific USE flag you should need is the `uuid` flag for `dev-db/postgresql`. Add the following line to any new file in `/etc/portage/package.use`. If you would like a suggested name for the file, either `postgresql` or `pleroma` would do fine, depending on how you like to arrange your package.use flags.
14
15 ```text
16 dev-db/postgresql uuid
17 ```
18
19 You could opt to add `USE="uuid"` to `/etc/portage/make.conf` if you'd rather set this as a global USE flags, but this flags does unrelated things in other packages, so keep that in mind if you elect to do so.
20
21 Double check your compiler flags in `/etc/portage/make.conf`. If you require any special compilation flags or would like to set up remote builds, now is the time to do so. Be sure that your CFLAGS and MAKEOPTS make sense for the platform you are using. It is not recommended to use above `-O2` or risky optimization flags for a production server.
22
23 ### Installing a cron daemon
24
25 Gentoo quite pointedly does not come with a cron daemon installed, and as such it is recommended you install one to automate certbot renewals and to allow other system administration tasks to be run automatically. Gentoo has [a whole wide world of cron options](https://wiki.gentoo.org/wiki/Cron) but if you just want A Cron That Works, `emerge --ask virtual/cron` will install the default cron implementation (probably cronie) which will work just fine. For the purpouses of this guide, we will be doing just that.
26
27 ### Required ebuilds
28
29 * `dev-db/postgresql`
30 * `dev-lang/elixir`
31 * `dev-vcs/git`
32 * `dev-util/cmake`
33 * `sys-apps/file`
34
35 #### Optional ebuilds used in this guide
36
37 * `www-servers/nginx` (preferred, example configs for other reverse proxies can be found in the repo)
38 * `app-crypt/certbot` (or any other ACME client for Let’s Encrypt certificates)
39 * `app-crypt/certbot-nginx` (nginx certbot plugin that allows use of the all-powerful `--nginx` flag on certbot)
40 * `media-gfx/imagemagick`
41 * `media-video/ffmpeg`
42 * `media-libs/exiftool`
43
44 ### Prepare the system
45
46 * First ensure that you have the latest copy of the portage ebuilds if you have not synced them yet:
47
48 ```shell
49  # emaint sync -a
50 ```
51
52 * Emerge all required the required and suggested software in one go:
53
54 ```shell
55  # emerge --ask dev-db/postgresql dev-lang/elixir dev-vcs/git www-servers/nginx app-crypt/certbot app-crypt/certbot-nginx dev-util/cmake sys-apps/file
56 ```
57
58 If you would not like to install the optional packages, remove them from this line.
59
60 If you're running this from a low-powered virtual machine, it should work though it will take some time. There were no issues on a VPS with a single core and 1GB of RAM; if you are using an even more limited device and run into issues, you can try creating a swapfile or use a more powerful machine running Gentoo to [cross build](https://wiki.gentoo.org/wiki/Cross_build_environment). If you have a wait ahead of you, now would be a good time to take a break, strech a bit, refresh your beverage of choice and/or get a snack, and reply to Arch users' posts with "I use Gentoo btw" as we do.
61
62 ### Install PostgreSQL
63
64 [Gentoo  Wiki article](https://wiki.gentoo.org/wiki/PostgreSQL) as well as [PostgreSQL QuickStart](https://wiki.gentoo.org/wiki/PostgreSQL/QuickStart) might be worth a quick glance, as the way Gentoo handles postgres is slightly unusual, with built in capability to have two different databases running for testing and live or whatever other purpouse. While it is still straightforward to install, it does mean that the version numbers used in this guide might change for future updates, so keep an eye out for the output you get from `emerge` to ensure you are using the correct ones.
65
66 * Install postgresql if you have not done so already:
67
68 ```shell
69  # emerge --ask dev-db/postgresql
70 ```
71
72 Ensure that `/etc/conf.d/postgresql-11` has the encoding you want (it defaults to UTF8 which is probably what you want) and make any adjustments to the data directory if you find it necessary. Be sure to adjust the number at the end depending on what version of postgres you actually installed.
73
74 * Initialize the database cluster
75
76 The output from emerging postgresql should give you a command for initializing the postgres database. The default slot should be indicated in this command, ensure that it matches the command below.
77
78 ```shell
79  # emerge --config dev-db/postgresql:11
80 ```
81
82 * Start postgres and enable the system service
83
84 ```shell
85  # /etc/init.d/postgresql-11 start
86  # rc-update add postgresql-11 default
87  ```
88
89 ### A note on licenses, the AGPL, and deployment procedures
90
91 If you do not plan to make any modifications to your Pleroma instance, cloning directly from the main repo will get you what you need. However, if you plan on doing any contributions to upstream development, making changes or modifications to your instance, making custom themes, or want to play around--and let's be honest here, if you're using Gentoo that is most likely you--you will save yourself a lot of headache later if you take the time right now to fork the Pleroma repo and use that in the following section.
92
93 Not only does this make it much easier to deploy changes you make, as you can commit and pull from upstream and all that good stuff from the comfort of your local machine then simply `git pull` on your instance server when you're ready to deploy, it also ensures you are compliant with the Affero General Public Licence that Pleroma is licenced under, which stipulates that all network services provided with modified AGPL code must publish their changes on a publicly available internet service and for free. It also makes it much easier to ask for help from and provide help to your fellow Pleroma admins if your public repo always reflects what you are running because it is part of your deployment procedure.
94
95 ### Install media / graphics packages (optional, see [`docs/installation/optional/media_graphics_packages.md`](docs/installation/optional/media_graphics_packages.md))
96
97 ```shell
98 # emerge --ask media-video/ffmpeg media-gfx/imagemagick media-libs/exiftool
99 ```
100
101 ### Install PleromaBE
102
103 * Add a new system user for the Pleroma service and set up default directories:
104
105 Remove `,wheel` if you do not want this user to be able to use `sudo`, however note that being able to `sudo` as the `pleroma` user will make finishing the insallation and common maintenence tasks somewhat easier:
106
107 ```shell
108  # useradd -m -G users,wheel -s /bin/bash pleroma
109 ```
110
111 Optional: If you are using sudo, review your sudo setup to ensure it works for you. The `/etc/sudoers` file has a lot of options and examples to help you, and [the Gentoo sudo guide](https://wiki.gentoo.org/wiki/Sudo) has more information. Finishing this installation will be somewhat easier if you have a way to sudo from the `pleroma` user, but it might be best to not allow that user to sudo during normal operation, and as such there will be a reminder at the end of this guide to double check if you would like to lock down the `pleroma` user after initial setup.
112
113 **Note**: To execute a single command as the Pleroma system user, use `sudo -Hu pleroma command`. You can also switch to a shell by using `sudo -Hu pleroma $SHELL`. If you don't have or want `sudo` or would like to use the system as the `pleroma` user for instance maintenance tasks, you can simply use `su - pleroma` to switch to the `pleroma` user.
114
115 * Git clone the PleromaBE repository and make the Pleroma user the owner of the directory:
116
117 It is highly recommended you use your own fork for the `https://path/to/repo` part below, however if you foolishly decide to forego using your own fork, the primary repo `https://git.pleroma.social/pleroma/pleroma` will work here.
118
119 ```shell
120  pleroma$ cd ~
121  pleroma$ git clone -b stable https://path/to/repo
122 ```
123
124 * Change to the new directory:
125
126 ```shell
127 pleroma$ cd ~/pleroma
128 ```
129
130 * Install the dependencies for Pleroma and answer with `yes` if it asks you to install `Hex`:
131
132 ```shell
133 pleroma$ mix deps.get
134 ```
135
136 * Generate the configuration:
137
138 ```shell
139 pleroma$ MIX_ENV=prod mix pleroma.instance gen
140 ```
141
142   * Answer with `yes` if it asks you to install `rebar3`.
143
144   * This part precompiles some parts of Pleroma, so it might take a few moments
145
146   * After that it will ask you a few questions about your instance and generates a configuration file in `config/generated_config.exs`.
147
148   * Spend some time with `generated_config.exs` to ensure that everything is in order. If you plan on using an S3-compatible service to store your local media, that can be done here. You will likely mostly be using `prod.secret.exs` for a production instance, however if you would like to set up a development environment, make a copy to `dev.secret.exs` and adjust settings as needed as well.
149
150 ```shell
151 pleroma$ mv config/generated_config.exs config/prod.secret.exs
152 ```
153
154 * The previous command creates also the file `config/setup_db.psql`, with which you can create the database. Ensure that it is using the correct database name on the `CREATE DATABASE` and the `\c` lines, then run the postgres script:
155
156 ```shell
157 pleroma$ sudo -Hu postgres psql -f config/setup_db.psql
158 ```
159
160 * Now run the database migration:
161
162 ```shell
163 pleroma$ MIX_ENV=prod mix ecto.migrate
164 ```
165
166 * Now you can start Pleroma already
167
168 ```shell
169 pleroma$ MIX_ENV=prod mix phx.server
170 ```
171
172 It probably won't work over the public internet quite yet, however, as we still need to set up a web servere to proxy to the pleroma application, as well as configure SSL.
173
174 ### Finalize installation
175
176 Assuming you want to open your newly installed federated social network to, well, the federation, you should run nginx or some other webserver/proxy in front of Pleroma. It is also a good idea to set up Pleroma to run as a system service.
177
178 #### Nginx
179
180 * Install nginx, if not already done:
181
182 ```shell
183  # emerge --ask www-servers/nginx
184 ```
185
186 * Create directories for available and enabled sites:
187
188 ```shell
189  # mkdir -p /etc/nginx/sites-{available,enabled}
190 ```
191
192 * Append the following line at the end of the `http` block in `/etc/nginx/nginx.conf`:
193
194 ```Nginx
195 include sites-enabled/*;
196 ```
197
198 * Setup your SSL cert, using your method of choice or certbot. If using certbot, install it if you haven't already:
199
200 ```shell
201  # emerge --ask app-crypt/certbot app-crypt/certbot-nginx
202 ```
203
204 and then set it up:
205
206 ```shell
207  # mkdir -p /var/lib/letsencrypt/
208  # certbot certonly --email <your@emailaddress> -d <yourdomain> --standalone
209 ```
210
211 If that doesn't work the first time, add `--dry-run` to further attempts to avoid being ratelimited as you identify the issue, and do not remove it until the dry run succeeds. If that doesn’t work, make sure, that nginx is not already running. If it still doesn’t work, try setting up nginx first (change ssl “on” to “off” and try again). Often the answer to issues with certbot is to use the `--nginx` flag once you have nginx up and running.
212
213 If you are using any additional subdomains, such as for a media proxy, you can re-run the same command with the subdomain in question. When it comes time to renew later, you will not need to run multiple times for each domain, one renew will handle it.
214
215 ---
216
217 * Copy the example nginx configuration and activate it:
218
219 ```shell
220  # cp /home/pleroma/pleroma/installation/pleroma.nginx /etc/nginx/sites-available/
221  # ln -s /etc/nginx/sites-available/pleroma.nginx /etc/nginx/sites-enabled/pleroma.nginx
222 ```
223
224 * Take some time to ensure that your nginx config is correct
225
226 Replace all instances of `example.tld` with your instance's public URL. If for whatever reason you made changes to the port that your pleroma app runs on, be sure that is reflected in your configuration.
227
228 Pay special attention to the line that begins with `ssl_ecdh_curve`. It is stongly advised to comment that line out so that OpenSSL will use its full capabilities, and it is also possible you are running OpenSSL 1.0.2 necessitating that you do this.
229
230 * Enable and start nginx:
231
232 ```shell
233  # rc-update add nginx default
234  # /etc/init.d/nginx start
235 ```
236
237 If you are using certbot, it is HIGHLY recommend you set up a cron job that renews your certificate, and that you install the suggested `certbot-nginx` plugin. If you don't do these things, you only have yourself to blame when your instance breaks suddenly because you forgot about it.
238
239 First, ensure that the command you will be installing into your crontab works.
240
241 ```shell
242  # /usr/bin/certbot renew --nginx
243 ```
244
245 Assuming not much time has passed since you got certbot working a few steps ago, you should get a message for all domains you installed certificates for saying `Cert not yet due for renewal`.
246
247 Now, run crontab as a superuser with `crontab -e` or `sudo crontab -e` as appropriate, and add the following line to your cron:
248
249 ```cron
250 0 0 1 * * /usr/bin/certbot renew --nginx
251 ```
252
253 This will run certbot on the first of the month at midnight. If you'd rather run more frequently, it's not a bad idea, feel free to go for it.
254
255 #### Other webserver/proxies
256
257 If you would like to use other webservers or proxies, there are example configurations for some popular alternatives in `/home/pleroma/pleroma/installation/`. You can, of course, check out [the Gentoo wiki](https://wiki.gentoo.org) for more information on installing and configuring said alternatives.
258
259 #### Create the uploads folder
260
261 Even if you are using S3, Pleroma needs someplace to store media posted on your instance. If you are using the `/home/pleroma/pleroma` root folder suggested by this guide, simply:
262
263 ```shell
264  pleroma$ mkdir -p ~/pleroma/uploads
265  ```
266
267 #### init.d service
268
269 * Copy example service file
270
271 ```shell
272  # cp /home/pleroma/pleroma/installation/init.d/pleroma /etc/init.d/
273 ```
274
275 * Be sure to take a look at this service file and make sure that all paths fit your installation
276
277 * Enable and start `pleroma`:
278
279 ```shell
280  # rc-update add pleroma default
281  # /etc/init.d/pleroma start
282 ```
283
284 #### Create your first user
285
286 If your instance is up and running, you can create your first user with administrative rights with the following task:
287
288 ```shell
289 pleroma$ MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
290 ```
291
292 #### Privilege cleanup
293
294 If you opted to allow sudo for the `pleroma` user but would like to remove the ability for greater security, now might be a good time to edit `/etc/sudoers` and/or change the groups the `pleroma` user belongs to. Be sure to restart the pleroma service afterwards to ensure it picks up on the changes.
295
296 #### Further reading
297
298 {! backend/installation/further_reading.include !}
299
300 ## Questions
301
302 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.