phundrak/docker-pleroma
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: change information on repository status

Browse Source
This commit is contained in:
Lucien Cartier-Tilet 2023-03-26 15:53:41 +02:00
parent 7a2741e45e
commit a8ecf5fc1a
Signed by: phundrak
GPG Key ID: BD7789E705CB8DCA
1 changed files with 27 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
README.md
View File

@ -2,11 +2,12 @@
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 container is no longer maintained ⚠️
I built this in 2021 with the intention of setting up a Pleroma instance. Then, I never did. I don't currently use this container in production, and I never have. I have archived this repository and removed the container from Docker Hub.
If you like this container and feel like stepping up to maintain it, I encourage you to fork it and let me know - I will cheerfully link folks over to yours.
## 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.
## Configuration
@ -20,26 +21,26 @@ The three environment variables you MUST supply are:
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 |
| -------- | ------------------- | ------------- |
| `--domain` | `DOMAIN` | _none_ |
| `--instance-name` | `INSTANCE_NAME` | same as `DOMAIN` |
| `--admin-email` | `ADMIN_EMAIL` | _none_ |
| `--notify-email` | `NOTIFY_EMAIL` | same as `ADMIN_EMAIL` |
| `--dbhost` | `POSTGRES_HOST` | postgres |
| `--dbname` | `POSTGRES_DB` | pleroma |
| `--dbuser` | `POSTGRES_USER` | pleroma |
| `--dbpass` | `POSTGRES_PASSWORD` | _none_ |
| `--rum` | `USE_RUM` | n |
| `--indexable` | `INDEXABLE` | y |
| `--db-configurable` | `DB_CONFIGURABLE` | y |
| `--uploads-dir` | `UPLOADS_DIR` | /var/lib/pleroma/uploads |
| `--static-dir` | `STATIC_DIR` | /var/lib/pleroma/static |
| `--listen-ip` | `LISTEN_IP` | 0.0.0.0 |
| `--listen-port` | `LISTEN_PORT` | 4000 |
| `--strip-uploads` | `STRIP_UPLOADS` | y |
| `--anonymize-uploads` | `ANONYMIZE_UPLOADS` | y |
| `--dedupe-uploads` | `DEDUPE_UPLOADS` | y |
| Argument | Evironment variable | Default value |
|-----------------------|---------------------|--------------------------|
| `--domain` | `DOMAIN` | _none_ |
| `--instance-name` | `INSTANCE_NAME` | same as `DOMAIN` |
| `--admin-email` | `ADMIN_EMAIL` | _none_ |
| `--notify-email` | `NOTIFY_EMAIL` | same as `ADMIN_EMAIL` |
| `--dbhost` | `POSTGRES_HOST` | postgres |
| `--dbname` | `POSTGRES_DB` | pleroma |
| `--dbuser` | `POSTGRES_USER` | pleroma |
| `--dbpass` | `POSTGRES_PASSWORD` | _none_ |
| `--rum` | `USE_RUM` | n |
| `--indexable` | `INDEXABLE` | y |
| `--db-configurable` | `DB_CONFIGURABLE` | y |
| `--uploads-dir` | `UPLOADS_DIR` | /var/lib/pleroma/uploads |
| `--static-dir` | `STATIC_DIR` | /var/lib/pleroma/static |
| `--listen-ip` | `LISTEN_IP` | 0.0.0.0 |
| `--listen-port` | `LISTEN_PORT` | 4000 |
| `--strip-uploads` | `STRIP_UPLOADS` | y |
| `--anonymize-uploads` | `ANONYMIZE_UPLOADS` | y |
| `--dedupe-uploads` | `DEDUPE_UPLOADS` | y |
See the [documentation for `instance gen`](https://docs-develop.pleroma.social/backend/administration/CLI_tasks/instance/) for more information.
@ -65,3 +66,4 @@ The git repository for this container includes [an example of how to use it with
## 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