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 15f87cf658 Merge branch 'features/ingestion-ecto-tag' into 'develop' 1 day ago
.gitlab release MR template: add a note about merging stable changes back to 7 months ago
benchmarks support for expires_in/expires_at in filters 2 months ago
config Support for configuration via AdminFE 2 weeks ago
docs Merge branch 'feature/521-pinned-post-federation' into 'develop' 1 day ago
installation Add a default rule to not attempt to cache any files larger than 50MB 2 months ago
lib Merge branch 'features/ingestion-ecto-tag' into 'develop' 1 day ago
priv Merge branch 'feature/521-pinned-post-federation' into 'develop' 1 day ago
rel OTP releases: only set name and distribution type if not set already 1 year ago
restarter Merge branch 'develop' into gun 1 year ago
test Merge branch 'features/ingestion-ecto-tag' into 'develop' 1 day ago
uploads fix issues with the uploads directory 2 years ago
.buildpacks CI: Add auto-deployment via dokku. 1 year ago
.credo.exs Move Consistency.FileLocation to ./test 6 months ago
.dockerignore remove docs/ from .dockerignore 1 year ago
.formatter.exs .formatter.exs: Format optional migrations 3 months ago
.gitattributes [#3112] .gitattributes fix. 4 months ago
.gitignore Vi and emacs temp files 1 month ago
.gitlab-ci.yml Execute mix deps.get earlier and avoid duplicate invocations if possible 1 month ago
.mailmap Add myself to .mailmap 2 months ago
AGPL-3 LICENSE → AGPL-3 2 years ago
CC-BY-4.0 Add a copy of CC-BY-4.0 to the repo 7 months ago
CC-BY-SA-4.0 CC-BY-SA-4.0: Add a copy of the CC-BY-SA-4.0 license 2 years ago
CHANGELOG.md Merge branch 'develop' into 'fix/notifsettings-breaking-login' 2 days ago
COPYING Relicense documentation under CC-BY-4.0 2 months ago
Dockerfile Merge branch 'libmagic' into 'develop' 4 months ago
Procfile CI: Add auto-deployment via dokku. 1 year ago
README.md Add FreeBSD and alpha sort 6 months ago
SECURITY.md SECURITY.md: update supported versions to only 2.2 6 months ago
coveralls.json exclude file_location check from coveralls 6 months ago
docker-entrypoint.sh Create docker.exs and docker-entrypoint + round out Dockerfile 1 year ago
elixir_buildpack.config Upgrade to Elixir 1.9 10 months ago
mix.exs release runtime provider fix for paths 1 week ago
mix.lock updating timex 4 weeks ago

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

Compilation Troubleshooting

If you ever encounter compilation issues during the updating of Pleroma, you can try these commands and see if they fix things:

  • mix deps.clean --all
  • mix local.rebar
  • mix local.hex
  • rm -r _build

If you are not developing Pleroma, it is better to use the OTP release, which comes with everything precompiled.

Documentation

Community Channels