Go to file
verita84 9dc06c3529 Update 'pleroma/Dockerfile' 2022-07-31 03:58:56 +00:00
config Update 'config/config.exs' 2022-03-31 01:38:34 +00:00
pleroma Update 'pleroma/Dockerfile' 2022-07-31 03:58:56 +00:00
postgresql Update 'postgresql/backup.sh' 2022-05-11 03:21:46 +00:00
var fix 2021-08-25 08:39:26 -06:00
README.md fix 2021-11-02 14:24:25 -06:00
docker-compose.yaml Update 'docker-compose.yaml' 2022-05-11 03:09:48 +00:00
emoji.sh fix 2021-08-25 08:39:26 -06:00
get_pleroma.sh Update 'get_pleroma.sh' 2022-07-31 03:58:27 +00:00
new-instance.sh fix 2021-11-02 13:10:43 -06:00
relays.txt Update 'relays.txt' 2021-10-26 14:41:59 +00:00
test.sh fix 2021-08-25 08:39:26 -06:00
update.sh fix 2021-08-25 08:39:26 -06:00

README.md

Quickly Run Pleroma in Docker

This setup will allow you to quickly run and maintain a Pleroma instance.

Features

  • Mostly Automated Install
  • Automatic Backup
  • Automatic Restore
  • Automatic Upgrades
  • Automatic install of SoapBoxFE
  • Daily Postgresql backups

System Requirements

  • Your own Domain Name
  • Docker installed
  • Cloudflare setup for your Domain Name (Or do certbot manually after the instance is up)
  • Port 443 open on your firewall/router

Getting Started

Modify terms-of-service.html with your terms of service
Modify ENDPOINT in docker-compose.yml with your domain name
Modify the second to last line in pleroma/setup.sh with your desired admin name
Run get_pleroma.sh to get the latest Pleroma and SoapboxFE release

Running with a low-memory machine?

Here is the recommended changes to make at the bottom of postgresql/postgresql.conf

max_connections = 200
shared_buffers = 128MB
effective_cache_size = 384MB
maintenance_work_mem = 32MB
checkpoint_completion_target = 0.9
wal_buffers = 3932kB
default_statistics_target = 100
random_page_cost = 4
effective_io_concurrency = 2
work_mem = 327kB
min_wal_size = 1GB
max_wal_size = 4GB
Build and Start Pleroma
git checkout HEAD config/config.exs
docker-compose up -d
Get the URL to change the Pleromp Admin user
docker-compose logs -f

The URL will let you set the admin password so you can login your instance.