Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/explodingcamera/docker-pleroma
a simple and compact docker image for pleroma
https://github.com/explodingcamera/docker-pleroma
docker fediverse mastodon pleroma
Last synced: about 1 month ago
JSON representation
a simple and compact docker image for pleroma
- Host: GitHub
- URL: https://github.com/explodingcamera/docker-pleroma
- Owner: explodingcamera
- License: isc
- Created: 2022-12-18T19:32:03.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-04T00:48:56.000Z (12 months ago)
- Last Synced: 2024-04-11T06:48:48.058Z (9 months ago)
- Topics: docker, fediverse, mastodon, pleroma
- Language: Elixir
- Homepage:
- Size: 44.9 KB
- Stars: 10
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Pleroma Docker
Simple Docker image for [Pleroma](https://pleroma.social/).
Currently, only x86_64 is supported. If you want to run Pleroma on other architectures, you should be able to build it yourself using the Dockerfile.
Since there were no prebuild images for pleroma, I decided to create one myself for usage on [social.dawdle.space](https://social.dawdle.space/).
# Supported tags
- [`latest`](https://github.com/explodingcamera/docker-pleroma/pkgs/container/pleroma) - latest stable release
- [`2`](https://github.com/explodingcamera/docker-pleroma/pkgs/container/pleroma) - latest 2.x release
- [`2.5`](https://github.com/explodingcamera/docker-pleroma/pkgs/container/pleroma) - specific minor version
- [`2.5.0`](https://github.com/explodingcamera/docker-pleroma/pkgs/container/pleroma) - specific version
- [`develop`](https://github.com/explodingcamera/docker-pleroma/pkgs/container/pleroma) - latest develop branch build
Versions are build automatically using GitHub Actions weekly.
# How to use this image
## Start a Pleroma instance
**Docker Compose**
```yaml
version: "3.8"
services:
db:
image: postgres:12.1-alpine
container_name: pleroma_db
restart: always
healthcheck:
test: ["CMD", "pg_isready", "-U", "pleroma"]
environment:
POSTGRES_USER: pleroma
POSTGRES_PASSWORD: ChangeMe!
POSTGRES_DB: pleroma
volumes:
- ./data/postgres:/var/lib/postgresql/data
web:
image: ghcr.io/explodingcamera/pleroma:stable
container_name: pleroma_web
healthcheck:
test:
["CMD-SHELL", "wget -q --spider --proxy=off localhost:4000 || exit 1"]
restart: always
ports:
- "4000:4000"
volumes:
- ./data/uploads:/data/uploads
- ./data/static:/data/static
- ./custom-config.exs:/data/config.exs # optional
environment:
PUID: 1000
PGID: 1000
DOMAIN: example.com
INSTANCE_NAME: Pleroma
ADMIN_EMAIL: [email protected]
NOTIFY_EMAIL: [email protected]
DB_USER: pleroma
DB_PASS: ChangeMe!
DB_NAME: pleroma
depends_on:
- db
```
**Docker CLI**
```bash
docker run -d \
--name=pleroma \
-e PUID=1000 \
-e PGID=1000 \
-e DOMAIN="example.com"
-e INSTANCE_NAME="Pleroma"
-e ADMIN_EMAIL="[email protected]"
-e NOTIFY_EMAIL="[email protected]"
-e DB_USER="pleroma"
-e DB_PASS="ChangeMe!"
-e DB_NAME="pleroma"
-p 4000:4000 \
-v /path/to/static:/data/static \
-v /path/to/uploads:/data/uploads \
-v /path/to/customconfig:/data/config.exs \ # optional
--restart unless-stopped \
ghcr.io/explodingcamera/pleroma:stable
```
# Running Commands
```bash
$ docker exec -it pleroma_web ./cli.sh user new --admin
```
# Configuration
## Environment variables
- `PUID` - User ID (default: `1000`)
- `PGID` - Group ID (default: `1000`)
- `DOMAIN` - Domain name (default: `example.com`)
## Pleroma configuration
See [Pleroma documentation](https://docs.pleroma.social/backend/configuration/auth/) for more information.
`custom-config.exs`
```elixir
import Config
config :pleroma, :instance,
registrations_open: false
config :pleroma, Pleroma.Web.Endpoint,
url: [host: "pleroma.example.org"]
config :pleroma, Pleroma.Web.WebFinger, domain: "example.org"
```
# Build-time variables
- `PLEROMA_VERSION` - Pleroma version to build (default: `stable`)
- `PLEROMA_REPO` - Pleroma repository to clone (default: `https://git.pleroma.social/pleroma/pleroma.git`)
- `EXTRA_PKGS` - Extra packages to install (default: `imagemagick libmagic ffmpeg`)
# Other Docker images
- [angristan/docker-pleroma](https://github.com/angristan/docker-pleroma)
- [potproject/docker-pleroma](https://github.com/potproject/docker-pleroma)
- [rysiek/docker-pleroma](https://git.pleroma.social/rysiek/docker-pleroma)
- [RX14/iscute.moe](https://github.com/RX14/kurisu.rx14.co.uk/blob/master/services/iscute.moe/pleroma/Dockerfile)