Go to file
lain 3b5282bef2 Merge branch 'develop' of git.pleroma.social:pleroma/pleroma into remake-remodel-dms 2020-06-08 11:19:18 +02:00
.gitlab
benchmarks Use atoms as keys in `ActivityPub.fetch_*` functions options 2020-06-04 21:36:26 +04:00
config Merge branch 'tagline' into 'develop' 2020-06-02 14:10:53 +00:00
docs ChatController: Remove nonsensical pagination. 2020-06-08 11:09:53 +02:00
installation Apply suggestion to installation/nginx-cache-purge.sh.example 2020-05-20 04:12:21 +00:00
lib Merge branch 'develop' of git.pleroma.social:pleroma/pleroma into remake-remodel-dms 2020-06-08 11:19:18 +02:00
priv Chats: Change id to flake id. 2020-06-07 14:25:30 +02:00
rel
restarter
test Merge branch 'develop' of git.pleroma.social:pleroma/pleroma into remake-remodel-dms 2020-06-08 11:19:18 +02:00
uploads
.buildpacks
.credo.exs
.dockerignore
.formatter.exs
.gitattributes
.gitignore
.gitlab-ci.yml
.mailmap
AGPL-3
CC-BY-SA-4.0
CHANGELOG.md Changelog: Add chats to changelog. 2020-06-03 19:25:57 +02:00
COPYING
Dockerfile
Procfile
README.md
coveralls.json
docker-entrypoint.sh
elixir_buildpack.config
mix.exs Update crypt library 2020-05-19 14:46:06 +03:00
mix.lock mix.lock: update hackney to 1.16.0 2020-05-30 00:18:17 +03:00

README.md

About

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. 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 dont 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