From d09c6df2d817ab652c064bc3ab20601c461f910a Mon Sep 17 00:00:00 2001 From: Lucien Cartier-Tilet Date: Sun, 26 Mar 2023 16:33:34 +0200 Subject: [PATCH] docs: update README --- README.md | 56 ++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 41 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 8e4c167..7db43f0 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,26 @@ # pleroma -This is a Docker image for running [Pleroma](https://pleroma.social), based on the [official installation instructions](https://docs-develop.pleroma.social/backend/installation/otp_en/) and `ubuntu:20.04`. Build it yourself, or get it from [Docker Hub](https://hub.docker.com/r/jordemort/pleroma). +This is a Docker image for running [Pleroma](https://pleroma.social), +based on the [official installation +instructions](https://docs-develop.pleroma.social/backend/installation/otp_en/) +and `ubuntu:20.04`. Build it yourself, or get it from [Docker +Hub](https://hub.docker.com/r/phundrak/pleroma). + +If you are reading this from DockerHub, you can head over to the repository at . ## Fork This repository is a fork of -[github.com/jordemort/docker-pleroma](https://github.com/jordemort/docker-pleroma), -whose Docker image I used when I first set up my first pleroma -instance. I am now using this fork to run my new instance, hopefully -it won’t break. +, whose Docker image I +used when I first set up my first pleroma instance. I am now using +this fork to run my new instance, hopefully it won’t break. ## Configuration -The container expects to find a Pleroma configuration file at `/etc/pleroma/config.exs`. If the configuration does not exist, the container will call `pleroma_ctl instance gen` for you. The parameters passed to `instance gen` can be influenced by a number of environment variables. +The container expects to find a Pleroma configuration file at +`/etc/pleroma/config.exs`. If the configuration does not exist, the +container will call `pleroma_ctl instance gen` for you. The parameters +passed to `instance gen` can be influenced by a number of environment +variables. The three environment variables you MUST supply are: @@ -19,7 +28,9 @@ The three environment variables you MUST supply are: - `ADMIN_EMAIL` - `POSTGRES_PASSWORD` -The container will try to infer reasonable defaults for the rest of the variables, if not set. Note that some of these defaults may be different from Pleroma's own default settings: +The container will try to infer reasonable defaults for the rest of +the variables, if not set. Note that some of these defaults may be +different from Pleroma's own default settings: | Argument | Evironment variable | Default value | |-----------------------|---------------------|--------------------------| @@ -43,27 +54,42 @@ The container will try to infer reasonable defaults for the rest of the variable | `--dedupe-uploads` | `DEDUPE_UPLOADS` | y | -See the [documentation for `instance gen`](https://docs-develop.pleroma.social/backend/administration/CLI_tasks/instance/) for more information. +See the [documentation for `instance +gen`](https://docs-develop.pleroma.social/backend/administration/CLI_tasks/instance/) +for more information. -If you want to use RUM indexes, you need a [PostgreSQL container that supports them](https://github.com/jordemort/docker-postgres-rum/). +If you want to use RUM indexes, you need a [PostgreSQL container that +supports them](https://github.com/jordemort/docker-postgres-rum/). -If you would like to use the [SoapBox UI](https://soapbox.pub/) instead of the normal Pleroma UI, you can set an environment variable USE_SOAPBOX to "y". SoapBox is a alternative to the normal Pleroma UI and emphasizes easier private branding and theming. +If you would like to use the [SoapBox UI](https://soapbox.pub/) +instead of the normal Pleroma UI, you can set an environment variable +USE_SOAPBOX to "y". SoapBox is a alternative to the normal Pleroma UI +and emphasizes easier private branding and theming. ## Persistence -If you want your instance data to persist properly, you need to mount volumes on the following directories: +If you want your instance data to persist properly, you need to mount +volumes on the following directories: - `/etc/pleroma` - `/var/lib/pleroma/static` - `/var/lib/pleroma/uploads` -Even if you aren't supplying a configuration and letting the container generate it for you, it is still important to persist the generated configuration in `/etc/pleroma` - it contains generated secrets, and things may get weird or broken if those change every time you restart your container. +Even if you aren't supplying a configuration and letting the container +generate it for you, it is still important to persist the generated +configuration in `/etc/pleroma` - it contains generated secrets, and +things may get weird or broken if those change every time you restart +your container. ## Example -The git repository for this container includes [an example of how to use it with `docker-compose`](https://github.com/jordemort/docker-pleroma/tree/main/example) +The git repository for this container includes [an example of how to +use it with +`docker-compose`](https://github.com/jordemort/docker-pleroma/tree/main/example) ## Prior art & inspiration -- https://www.github.com/goodtiding5/docker-pleroma - based on Alpine, if you're into that sort of thing :) -- https://github.com/jordemort/docker-pleroma - original repository from which this one is forked +- https://www.github.com/goodtiding5/docker-pleroma - based on Alpine, + if you're into that sort of thing :) +- https://github.com/jordemort/docker-pleroma - original repository + from which this one is forked