1 # Switching a from-source install to OTP releases
3 {! backend/installation/otp_vs_from_source.include !}
5 In this guide we cover how you can migrate from a from source installation to one using OTP releases.
8 You will be running commands as root. If you aren't root already, please elevate your priviledges by executing `sudo su`/`su`.
10 The system needs to have `curl` and `unzip` installed for downloading and unpacking release builds.
19 apt install curl unzip
22 ## Moving content out of the application directory
23 When using OTP releases the application directory changes with every version so it would be a bother to keep content there (and also dangerous unless `--no-rm` option is used when updating). Fortunately almost all paths in Pleroma are configurable, so it is possible to move them out of there.
25 Pleroma should be stopped before proceeding.
27 ### Moving uploads/custom public files directory
30 # Create uploads directory and set proper permissions (skip if using a remote uploader)
31 # Note: It does not have to be `/var/lib/pleroma/uploads`, you can configure it to be something else later
32 mkdir -p /var/lib/pleroma/uploads
33 chown -R pleroma /var/lib/pleroma
35 # Create custom public files directory
36 # Note: It does not have to be `/var/lib/pleroma/static`, you can configure it to be something else later
37 mkdir -p /var/lib/pleroma/static
38 chown -R pleroma /var/lib/pleroma
40 # If you use the local uploader with default settings your uploads should be located in `~pleroma/uploads`
41 mv ~pleroma/uploads/* /var/lib/pleroma/uploads
43 # If you have created the custom public files directory with default settings it should be located in `~pleroma/instance/static`
44 mv ~pleroma/instance/static /var/lib/pleroma/static
48 Assuming you have all emojis in subdirectories of `priv/static/emoji` moving them can be done with
50 mkdir /var/lib/pleroma/static/emoji
51 ls -d ~pleroma/priv/static/emoji/*/ | xargs -i sh -c 'mv "{}" "/var/lib/pleroma/static/emoji/$(basename {})"'
54 But, if for some reason you have custom emojis in the root directory you should copy the whole directory instead.
56 mv ~pleroma/priv/static/emoji /var/lib/pleroma/static/emoji
58 and then copy custom emojis to `/var/lib/pleroma/static/emoji/custom`.
60 This is needed because storing custom emojis in the root directory is deprecated, but if you just move them to `/var/lib/pleroma/static/emoji/custom` it will break emoji urls on old posts.
62 Note that globs have been replaced with `pack_extensions`, so if your emojis are not in png/gif you should [modify the default value](../configuration/cheatsheet.md#emoji).
66 # Create the config directory
67 # The default path for Pleroma config is /etc/pleroma/config.exs
68 # but it can be set via PLEROMA_CONFIG_PATH environment variable
71 # Move the config file
72 mv ~pleroma/config/prod.secret.exs /etc/pleroma/config.exs
74 # Change `use Mix.Config` at the top to `import Config`
75 $EDITOR /etc/pleroma/config.exs
77 ## Installing the release
78 Before proceeding, get the flavour from [Detecting flavour](otp_en.md#detecting-flavour) section in OTP installation guide.
80 # Delete all files in pleroma user's directory
83 # Set the flavour environment variable to the string you got in Detecting flavour section.
84 # For example if the flavour is `amd64-musl` the command will be
85 export FLAVOUR="amd64-musl"
87 # Clone the release build into a temporary directory and unpack it
88 # Replace `stable` with `unstable` if you want to run the unstable branch
89 su pleroma -s $SHELL -lc "
90 curl 'https://git.pleroma.social/api/v4/projects/2/jobs/artifacts/stable/download?job=$FLAVOUR' -o /tmp/pleroma.zip
91 unzip /tmp/pleroma.zip -d /tmp/
94 # Move the release to the home directory and delete temporary files
95 su pleroma -s $SHELL -lc "
96 mv /tmp/release/* ~pleroma/
101 # Start the instance to verify that everything is working as expected
102 su pleroma -s $SHELL -lc "./bin/pleroma daemon"
104 # Wait for about 20 seconds and query the instance endpoint, if it shows your uri, name and email correctly, you are configured correctly
105 sleep 20 && curl http://localhost:4000/api/v1/instance
108 su pleroma -s $SHELL -lc "./bin/pleroma stop"
111 ## Setting up a system service
112 OTP releases have different service files than from-source installs so they need to be copied over again.
114 **Warning:** The service files assume pleroma user's home directory is `/opt/pleroma`, please make sure all paths fit your installation.
118 # Copy the service into a proper directory
119 cp -f ~pleroma/installation/init.d/pleroma /etc/init.d/pleroma
122 rc-service pleroma start
127 # Copy the service into a proper directory
128 cp ~pleroma/installation/pleroma.service /etc/systemd/system/pleroma.service
130 # Reload service files
131 systemctl daemon-reload
133 # Reenable pleroma to start on boot
134 systemctl reenable pleroma
137 systemctl start pleroma
141 Refer to [Running mix tasks](otp_en.md#running-mix-tasks) section from OTP release installation guide.
143 Refer to [Updating](otp_en.md#updating) section from OTP release installation guide.