1 # Installing on Alpine Linux
4 This guide is a step-by-step installation guide for Alpine Linux. The instructions were verified against Alpine v3.10 standard image. You might miss additional dependencies if you use `netboot` instead.
6 It assumes that you have administrative rights, either as root or a user with [sudo permissions](https://www.linode.com/docs/tools-reference/custom-kernels-distros/install-alpine-linux-on-your-linode/#configuration). If you want to run this guide with root, ignore the `sudo` at the beginning of the lines, unless it calls a user like `sudo -Hu pleroma`; in this case, use `su -l <username> -s $SHELL -c 'command'` instead.
20 #### Optional packages used in this guide
22 * `nginx` (preferred, example configs for other reverse proxies can be found in the repo)
23 * `certbot` (or any other ACME client for Let’s Encrypt certificates)
28 ### Prepare the system
30 * The community repository must be enabled in `/etc/apk/repositories`. Depending on which version and mirror you use this looks like `http://alpine.42.fr/v3.10/community`. If you autogenerated the mirror during installation:
33 awk 'NR==2' /etc/apk/repositories | sed 's/main/community/' | tee -a /etc/apk/repositories
36 * Then update the system, if not already done:
43 * Install some tools, which are needed later:
46 sudo apk add git build-base cmake file-dev
49 ### Install Elixir and Erlang
51 * Install Erlang and Elixir:
54 sudo apk add erlang erlang-runtime-tools erlang-xmerl elixir
57 * Install `erlang-eldap` if you want to enable ldap authenticator
60 sudo apk add erlang-eldap
63 ### Install PostgreSQL
65 * Install Postgresql server:
68 sudo apk add postgresql postgresql-contrib
71 * Initialize database:
74 sudo /etc/init.d/postgresql start
77 * Enable and start postgresql server:
80 sudo rc-update add postgresql
83 ### Install media / graphics packages (optional, see [`docs/installation/optional/media_graphics_packages.md`](docs/installation/optional/media_graphics_packages.md))
86 sudo apk add ffmpeg imagemagick exiftool
91 * Add a new system user for the Pleroma service:
95 sudo adduser -S -s /bin/false -h /opt/pleroma -H -G pleroma pleroma
98 **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 and want `sudo` on your system, you can use `su` as root user (UID 0) for a single command by using `su -l pleroma -s $SHELL -c 'command'` and `su -l pleroma -s $SHELL` for starting a shell.
100 * Git clone the PleromaBE repository and make the Pleroma user the owner of the directory:
103 sudo mkdir -p /opt/pleroma
104 sudo chown -R pleroma:pleroma /opt/pleroma
105 sudo -Hu pleroma git clone -b stable https://git.pleroma.social/pleroma/pleroma /opt/pleroma
108 * Change to the new directory:
114 * Install the dependencies for Pleroma and answer with `yes` if it asks you to install `Hex`:
117 sudo -Hu pleroma mix deps.get
120 * Generate the configuration: `sudo -Hu pleroma mix pleroma.instance gen`
121 * Answer with `yes` if it asks you to install `rebar3`.
122 * This may take some time, because parts of pleroma get compiled first.
123 * After that it will ask you a few questions about your instance and generates a configuration file in `config/generated_config.exs`.
125 * Check the configuration and if all looks right, rename it, so Pleroma will load it (`prod.secret.exs` for productive instance, `dev.secret.exs` for development instances):
128 mv config/{generated_config.exs,prod.secret.exs}
131 * The previous command creates also the file `config/setup_db.psql`, with which you can create the database:
134 sudo -Hu postgres psql -f config/setup_db.psql
137 * Now run the database migration:
140 sudo -Hu pleroma MIX_ENV=prod mix ecto.migrate
143 * Now you can start Pleroma already
146 sudo -Hu pleroma MIX_ENV=prod mix phx.server
149 ### Finalize installation
151 If you want to open your newly installed instance to the world, you should run nginx or some other webserver/proxy in front of Pleroma and you should consider to create an OpenRC service file for Pleroma.
155 * Install nginx, if not already done:
161 * Setup your SSL cert, using your method of choice or certbot. If using certbot, first install it:
170 sudo mkdir -p /var/lib/letsencrypt/
171 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --standalone
174 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).
176 * Copy the example nginx configuration to the nginx folder
179 sudo cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/conf.d/pleroma.conf
182 * Before starting nginx edit the configuration and change it to your needs. You must change change `server_name` and the paths to the certificates. You can use `nano` (install with `apk add nano` if missing).
186 server_name your.domain;
192 server_name your.domain;
193 listen 443 ssl http2;
195 ssl_trusted_certificate /etc/letsencrypt/live/your.domain/chain.pem;
196 ssl_certificate /etc/letsencrypt/live/your.domain/fullchain.pem;
197 ssl_certificate_key /etc/letsencrypt/live/your.domain/privkey.pem;
202 * Enable and start nginx:
205 sudo rc-update add nginx
206 sudo service nginx start
209 If you need to renew the certificate in the future, uncomment the relevant location block in the nginx config and run:
212 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --webroot -w /var/lib/letsencrypt/
217 * Copy example service file:
220 sudo cp /opt/pleroma/installation/init.d/pleroma /etc/init.d/pleroma
223 * Make sure to start it during the boot
226 sudo rc-update add pleroma
229 #### Create your first user
231 If your instance is up and running, you can create your first user with administrative rights with the following task:
234 sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
239 {! backend/installation/further_reading.include !}
243 Questions about the installation or didn’t it work as it should be, ask in [#pleroma:matrix.org](https://matrix.heldscal.la/#/room/#freenode_#pleroma:matrix.org) or IRC Channel **#pleroma** on **Freenode**.