Go to file
Lukas 1a3ca3517b Merge branch 'patch-1' into 'master'
Add admin user instructions

See merge request pleroma/pleroma-docker-compose!1
2020-05-28 06:28:21 +00:00
environments adding docker-compose related files/configs 2020-05-26 16:18:06 -04:00
volumes add config.exs example 2020-05-26 16:38:52 -04:00
README.md Add admin user instructions 2020-05-28 06:27:39 +00:00
docker-compose.yml adding docker-compose related files/configs 2020-05-26 16:18:06 -04:00

README.md

pleroma-docker-compose

This repo can be used as an example of utilizing docker-compose for your pleroma instance. It will start a pleroma instance container and pleroma-db (postgres) container. The instance will be available on 127.0.0.1:4000 - you will need to provide your own proxy such as nginx.

Please be advised you may need to adjust some things to fit your environment.

To deploy a pleroma instance using docker-compose - perform the following:

# git clone https://git.pleroma.social/pleroma/pleroma-docker-compose.git
# cd pleroma-docker-compose

You will need to edit the ./environments/pleroma/pleroma.env and replace the ops.pleroma.social domain with your own (and other necessary configuration variables you need)

After, start the containers with:

# docker-compuse up -d

After pleroma initializes it should be available to proxy to on port 4000.

Notes

You can customize the mounted config.exs to extend the pleroma config outside the ones generated off environment variables

In ./volumes/pleroma/config.exs you can append like so:

# cat volumes/pleroma/config.exs
import Config

config :pleroma, :instance,
  registrations_open: true,
  federating: true

Add an instance admin like this:

docker exec pleroma /opt/pleroma/bin/pleroma_ctl user new joeuser joeuser@sld.tld --admin -y

The postgres database files are located in ./volumes/pleroma-db/pgdata. You can also insert postgres startup scripts inside ./volumes/pleroma-db/pginit