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.
Haelwenn ddf2314836 Merge branch 'chore/jason-in-tests' into 'develop' 18 hours ago
.gitlab release MR template: add a note about merging stable changes back to 3 months ago
benchmarks adding benchmarks in new format 4 months ago
config Password Resets: Don't accept tokens above a certain age. 5 days ago
docs Merge remote-tracking branch 'remotes/origin/develop' into 2301-users-search-discoverability-fix 5 days ago
installation Remove FedSockets 1 week ago
lib Search: Save detected pg version in a persistent term. 1 day ago
priv Translated using Weblate (Hebrew) 3 days ago
rel OTP releases: only set name and distribution type if not set already 1 year ago
restarter Merge branch 'develop' into gun 8 months ago
test Fix badly formatted JSON fixtures which causes Jason to erroneously detect control characters 1 day ago
uploads fix issues with the uploads directory 1 year ago
.buildpacks CI: Add auto-deployment via dokku. 1 year ago
.credo.exs Move Consistency.FileLocation to ./test 1 month ago
.dockerignore remove docs/ from .dockerignore 1 year ago
.formatter.exs HTML: Compile Scrubbers on boot 11 months ago
.gitattributes .gitattributes: Treat js/css/source maps as binary files 1 week ago
.gitignore added generated `pleroma.env` 1 month ago
.gitlab-ci.yml Gitlab CI: Update postgres 5 days ago
.mailmap add mailmap [ci skip] 1 year ago
AGPL-3 LICENSE → AGPL-3 1 year ago
CC-BY-4.0 Add a copy of CC-BY-4.0 to the repo 2 months ago
CC-BY-SA-4.0 CC-BY-SA-4.0: Add a copy of the CC-BY-SA-4.0 license 1 year ago
CHANGELOG.md Merge branch 'develop' of git.pleroma.social:pleroma/pleroma into websearch 1 day ago
COPYING Bump copyright dates. 8 months ago
Dockerfile Merge branch 'libmagic' into 'develop' 3 days ago
Procfile CI: Add auto-deployment via dokku. 1 year ago
README.md Add FreeBSD and alpha sort 2 months ago
SECURITY.md SECURITY.md: update supported versions to only 2.2 1 month ago
coveralls.json exclude file_location check from coveralls 1 month ago
docker-entrypoint.sh Create docker.exs and docker-entrypoint + round out Dockerfile 1 year ago
elixir_buildpack.config Upgrade to Elixir 1.9 5 months ago
mix.exs Update Linkify to 0.3.0 1 day ago
mix.lock Update Linkify to 0.3.0 1 day 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