Mirror of official Pleroma repo at 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.
feld 78484fe0ef Merge branch 'admin-active-filter' into 'develop' 7 hours ago
.gitlab Bug issue template: remove choice in "Installation type" 3 weeks ago
benchmarks adding benchmarks in new format 1 month ago
config Merge branch 'develop' into 'feat/floki-fast-html-2' 1 day ago
docs docs: add cmake to other installation guides 11 hours ago
installation Revert "Merge branch 'issue/1023' into 'develop'" 11 hours ago
lib Admin API: Filter out unapproved users when the `active` filter is on 10 hours ago
priv 20200802170532_fix_legacy_tags: chunk the user query 15 hours ago
rel OTP releases: only set name and distribution type if not set already 8 months ago
restarter Merge branch 'develop' into gun 5 months ago
test Admin API: Filter out unapproved users when the `active` filter is on 10 hours ago
uploads fix issues with the uploads directory 1 year ago
.buildpacks CI: Add auto-deployment via dokku. 1 year ago
.credo.exs [Credo][CI] Add readability as it’s fixed 1 year ago
.dockerignore remove docs/ from .dockerignore 8 months ago
.formatter.exs HTML: Compile Scrubbers on boot 8 months ago
.gitattributes .gitattributes: use native support for elixir definitions 5 months ago
.gitignore Revert "Merge branch 'issue/1023' into 'develop'" 11 hours ago
.gitlab-ci.yml CI: install cmake since fast_html now requires it 3 days ago
.mailmap add mailmap [ci skip] 1 year ago
AGPL-3 LICENSE → AGPL-3 1 year 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' into fix/ldap-auth-issues 3 days ago
COPYING Bump copyright dates. 4 months ago
Dockerfile Support Exiftool for stripping EXIF data 1 month ago
Procfile CI: Add auto-deployment via dokku. 1 year ago
README.md README: Add some troubleshooting info for compilation issues. 1 month ago
SECURITY.md Add security policy for Pleroma backend 3 days ago
coveralls.json tests for emoji mix task 4 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 1 month ago
mix.exs mix.exs: update fast_sanitize to 0.2.0 3 days ago
mix.lock mix.exs: update fast_sanitize to 0.2.0 3 days 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

OTP releases (Recommended)

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