Fork of Pleroma with site-specific changes and feature branches https://git.pleroma.social/pleroma/pleroma
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
rinpatch 96da25c92f Partial readme rewrite 4 years ago
benchmarks Fix benchmarks 4 years ago
config Bump fast_sanitize to 0.1.1 4 years ago
docs Mastodon API: Add the `recipients` parameter to `GET /api/v1/conversations` 4 years ago
installation Add `remote_ip` plug 4 years ago
lib object containment: handle all cases where ID is invalid (missing, nil, non-string) 4 years ago
priv Bump pleroma-fe bundle to 044c9ad0562af059dd961d50961a3880fca9c642 4 years ago
rel pleroma_ctl: fix crashes due to different shift(1) behavior on dash 4 years ago
test object containment: handle all cases where ID is invalid (missing, nil, non-string) 4 years ago
uploads fix issues with the uploads directory 5 years ago
.buildpacks CI: Add auto-deployment via dokku. 5 years ago
.credo.exs [Credo][CI] Add readability as it’s fixed 5 years ago
.dockerignore Add .dockerignore 4 years ago
.formatter.exs Enable `mix format` for migrations 4 years ago
.gitignore Revert "Merge branch 'revert-4fabf83a' into 'develop'" 4 years ago
.gitlab-ci.yml CI: Remove the docs-build job 4 years ago
.mailmap add mailmap [ci skip] 4 years ago
AGPL-3 LICENSE → AGPL-3 5 years ago
CC-BY-SA-4.0 CC-BY-SA-4.0: Add a copy of the CC-BY-SA-4.0 license 5 years ago
CHANGELOG.md Mastodon API: Add the `recipients` parameter to `GET /api/v1/conversations` 4 years ago
COPYING pleroma-fox-tan-shy.png: Add another version of pleroma-tan 5 years ago
Dockerfile Switch to alpine:3.9 to avoid dlsym errors 4 years ago
Procfile CI: Add auto-deployment via dokku. 5 years ago
README.md Partial readme rewrite 4 years ago
docker-entrypoint.sh Create docker.exs and docker-entrypoint + round out Dockerfile 4 years ago
elixir_buildpack.config CI: Add auto-deployment via dokku. 5 years ago
mix.exs Bump fast_sanitize to 0.1.1 4 years ago
mix.lock Bump fast_sanitize 4 years ago

README.md

Pleroma

About Pleroma

Pleroma is a microblogging server software that can federate (= exchange messages with) other servers that support ActivityPub. What that means is that you can host a server for yourself or your friends and stay in control of your online identity, but still exchange messages with people on larger servers. Pleroma will federate with all servers that implement ActivityPub, like Friendica, GNU Social, Hubzilla, Mastodon, Misskey, Peertube, and Pixelfed.

Pleroma is written in Elixir and uses PostgresSQL for data storage. It's efficient enough to be ran on low-power devices like Raspberry Pi (though we wouldn't recommend storing the database on the internal SD card ;) but can scale well when ran on more powerful hardware (albeit only single-node for now).

For clients it supports the Mastodon client API with Pleroma extensions (see the API section on https://docs-develop.pleroma.social).

Installation

If you are running Linux (glibc or musl) on x86/arm, the recommended way to install Pleroma is by using OTP releases. OTP releases are as close as you can get to binary releases with Erlang/Elixir. The release is self-contained, and provides everything needed to boot it, it is easily administered via the provided shell script to open up a remote console, start/stop/restart the release, start in the background, send remote commands, and more. The installation instructions are available here

From Source

If your platform is not supported, or you just want to be able to edit the source code easily, you may install Pleroma from source.

OS/Distro packages

Currently Pleroma is not packaged by any OS/Distros, but if you want to package it for one, we can guide you through the process on our community channels. If you want to change default options in your Pleroma package, please discuss it with us first.

Docker

While we don’t provide docker files, other people have written very good ones. Take a look at https://github.com/angristan/docker-pleroma or https://glitch.sh/sn0w/pleroma-docker.

Documentation

Community Channels