Maintaining a Prose Pod

Updating

If you are making a major update (from X1.Y1.Z1 to X2.Y2.Z2 if X1 != X2), have a look at the Prose Pod API changelog to spot potential changes in configuration keys. We might document major changes here at some point but for now you will have to look at changelogs directly.

When using Compose

Update your compose.yaml file using:

curl -L https://raw.githubusercontent.com/prose-im/prose-pod-system/refs/tags/${PROSE_VERSION:?}/compose.yaml -o /etc/prose/compose.yaml

Then restart using:

systemctl restart prose

Adding a license

If you need a higher user limit than in the Community version, you will have to pay for a Business license. After the payment has been processed, you will receive a prose.lic file. Put it in /etc/prose/prose.lic, then restart the Pod API (systemctl restart prose).

After a factory reset

rsync -aL --chown=prose:prose /etc/{letsencrypt/live,prosody/certs}/

curl -L https://raw.githubusercontent.com/prose-im/prose-pod-system/refs/heads/master/templates/prose.toml \
  | sed s/'{your_domain}'/${YOUR_DOMAIN:?}/g \
  > /etc/prose/prose.toml
chown prose:prose /etc/prose/prose.toml
# Then edit </etc/prose/prose.toml>!