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.
19 #### Optional packages used in this guide
21 * `nginx` (preferred, example configs for other reverse proxies can be found in the repo)
22 * `certbot` (or any other ACME client for Let’s Encrypt certificates)
27 ### Prepare the system
29 * 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:
32 awk 'NR==2' /etc/apk/repositories | sed 's/main/community/' | tee -a /etc/apk/repositories
35 * Then update the system, if not already done:
42 * Install some tools, which are needed later:
45 sudo apk add git build-base cmake
48 ### Install Elixir and Erlang
50 * Install Erlang and Elixir:
53 sudo apk add erlang erlang-runtime-tools erlang-xmerl elixir
56 * Install `erlang-eldap` if you want to enable ldap authenticator
59 sudo apk add erlang-eldap
62 ### Install PostgreSQL
64 * Install Postgresql server:
67 sudo apk add postgresql postgresql-contrib
70 * Initialize database:
73 sudo /etc/init.d/postgresql start
76 * Enable and start postgresql server:
79 sudo rc-update add postgresql
82 ### Install media / graphics packages (optional, see [`docs/installation/optional/media_graphics_packages.md`](docs/installation/optional/media_graphics_packages.md))
85 sudo apk add ffmpeg imagemagick exiftool
90 * Add a new system user for the Pleroma service:
94 sudo adduser -S -s /bin/false -h /opt/pleroma -H -G pleroma pleroma
97 **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.
99 * Git clone the PleromaBE repository and make the Pleroma user the owner of the directory:
102 sudo mkdir -p /opt/pleroma
103 sudo chown -R pleroma:pleroma /opt/pleroma
104 sudo -Hu pleroma git clone -b stable https://git.pleroma.social/pleroma/pleroma /opt/pleroma
107 * Change to the new directory:
113 * Install the dependencies for Pleroma and answer with `yes` if it asks you to install `Hex`:
116 sudo -Hu pleroma mix deps.get
119 * Generate the configuration: `sudo -Hu pleroma mix pleroma.instance gen`
120 * Answer with `yes` if it asks you to install `rebar3`.
121 * This may take some time, because parts of pleroma get compiled first.
122 * After that it will ask you a few questions about your instance and generates a configuration file in `config/generated_config.exs`.
124 * 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):
127 mv config/{generated_config.exs,prod.secret.exs}
130 * The previous command creates also the file `config/setup_db.psql`, with which you can create the database:
133 sudo -Hu postgres psql -f config/setup_db.psql
136 * Now run the database migration:
139 sudo -Hu pleroma MIX_ENV=prod mix ecto.migrate
142 * Now you can start Pleroma already
145 sudo -Hu pleroma MIX_ENV=prod mix phx.server
148 ### Finalize installation
150 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.
154 * Install nginx, if not already done:
160 * Setup your SSL cert, using your method of choice or certbot. If using certbot, first install it:
169 sudo mkdir -p /var/lib/letsencrypt/
170 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --standalone
173 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).
175 * Copy the example nginx configuration to the nginx folder
178 sudo cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/conf.d/pleroma.conf
181 * 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).
185 server_name your.domain;
191 server_name your.domain;
192 listen 443 ssl http2;
194 ssl_trusted_certificate /etc/letsencrypt/live/your.domain/chain.pem;
195 ssl_certificate /etc/letsencrypt/live/your.domain/fullchain.pem;
196 ssl_certificate_key /etc/letsencrypt/live/your.domain/privkey.pem;
201 * Enable and start nginx:
204 sudo rc-update add nginx
205 sudo service nginx start
208 If you need to renew the certificate in the future, uncomment the relevant location block in the nginx config and run:
211 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --webroot -w /var/lib/letsencrypt/
216 * Copy example service file:
219 sudo cp /opt/pleroma/installation/init.d/pleroma /etc/init.d/pleroma
222 * Make sure to start it during the boot
225 sudo rc-update add pleroma
228 #### Create your first user
230 If your instance is up and running, you can create your first user with administrative rights with the following task:
233 sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
238 {! backend/installation/further_reading.include !}
242 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**.