Pleroma#

Pleroma Pleroma is a federated social networking platform, compatible with GNU social and other OStatus implementations. It is free software licensed under the AGPLv3.

amd64
arm64
armv7

Information#

Docker Image: !!! LINK TO DOCKER IMAGE/ DOCKER HUB !!!
Current Image Version: latest

SETUP#

Enabling pleroma#

Command:#

vlab set pleroma.enable True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

pleroma
enable: True

Finalising changes:#

run: vlab update_one service=pleroma

FIRST RUN#

!!! DEVELOPERS: make sure that you include any information that the user requires to get started, below. !!!
!!! Below are some examples with headings, and with some example instructions !!!

Additional Installation Steps#

  • Pleroma requires you to interactively create the first user using docker exec, or something similar. Here's a templated version for you to run. You'll need to do this from your vivumlab server's ~/vivumlab/pleroma directory.
docker-compose exec web /opt/pleroma/bin/pleroma_ctl user new admin [email protected] --name admin --password 123456789 --admin --moderator -y

SMTP/ MAIL#

  1. run vlab decrypt to decrypt the vault.yml file
  2. make some changes

SMTP Settings#

smtp:
host:
port:
user:
pass:
from_email:
from_name:
  1. run vlab update_one service=pleroma to complete the changes

ACCESS#

pleroma (HTTPS) link: https://pleroma.vivumlab.xyz/ pleroma (HTTP) link: http://pleroma.vivumlab.xyz/

OPTIONS#

HTTPS_ONLY#

Default: False
Options: True/False

Command:#

vlab set pleroma.https_only True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

pleroma
https_only: True
Finalising changes:#

run: vlab update_one service=pleroma

AUTH#

Default: False
Options: True/False

Command:#

vlab set pleroma.auth True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

pleroma
auth: True
Finalising changes:#

run: vlab update_one service=pleroma

DOMAIN#

Default: False
NOTE: include the sitename and top level domain suffix. eg. name.com, site.net

Command:#

vlab set pleroma.domain pleroma.com

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

pleroma
domain: pleroma.com
Finalising changes:#

run: vlab update_one service=pleroma

SUBDOMAIN#

Default: pleroma
NOTE: Periods/ delimiters are not required. eg. 'media' will set the full URL as 'media.vivumlab.xyz'

Command:#

vlab set pleroma.subdomain media

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

pleroma
subdomain: media
Finalising changes:#

run: vlab update_one service=pleroma

VERSION#

Default: latest
NOTE: Ensure that the version exists

Command:#

vlab set pleroma.version 2.7

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

pleroma
version: 2.7
Finalising changes:#

run: vlab update_one service=pleroma

Need more help?#

Further information regarding services can be found.
General Information can be found in the documentation.
Additional assistance can be found on our Contact Us page.