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.
 
 
 
 
Henry Jameson 2561febffd thanks emacs/arch 2 days ago
.gitlab Update MR template to include the type 'change' 5 months ago
benchmarks Ensure benchee doesn't run unless we are executing benchmarks 5 months ago
changelog.d Merge branch 'bookmark-folders' into 'develop' 1 week ago
ci Pin to otp25 2 months ago
config Merge remote-tracking branch 'origin/develop' into shigusegubu 2 days ago
docs Update minimum Postgres version to 11.0; disable JIT 1 week ago
installation Merge remote-tracking branch 'origin/develop' into shigusegubu 2 days ago
lib thanks emacs/arch 2 days ago
priv Merge branch 'develop' into 'bookmark-folders' 1 week ago
rel Add no_new_privs to OpenRC service files 10 months ago
restarter Bump minimum Elixir version to 1.10 2 years ago
test Merge branch 'bookmark-folders' into 'develop' 1 week ago
tools Revert "Support a new changelog entry type: deps" 1 month ago
.buildpacks CI: Add auto-deployment via dokku. 5 years ago
.credo.exs Tell newer Credo it's OK to exit 0 on single with clauses and piping into anonymous functions for now 1 year ago
.dialyzer_ignore.exs These are all due to Cachex typespec bugs 2 months ago
.dockerignore remove docs/ from .dockerignore 4 years ago
.formatter.exs .formatter.exs: Format optional migrations 3 years ago
.gitattributes [#3112] .gitattributes fix. 3 years ago
.gitignore Update .gitignore 1 month ago
.gitlab-ci.yml CI: Move changelog check to later in the pipeline 1 week ago
.mailmap Add myself to .mailmap 3 years ago
.rgignore Add .rgignore for easier grepping 4 months ago
AGPL-3 LICENSE → AGPL-3 5 years ago
CC-BY-4.0 Add a copy of CC-BY-4.0 to the repo 4 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 add changelog.d 4 weeks ago
COPYING Revert "Merge branch 'copyright-bump' into 'develop'" 1 year ago
Dockerfile Fix dockerfile compilation. 4 months ago
Procfile CI: Add auto-deployment via dokku. 5 years ago
README.md README.md: Update packaging state (GURU, AUR) 9 months ago
SECURITY.md SECURITY.md: update supported versions to only 2.2 3 years ago
coveralls.json exclude file_location check from coveralls 4 years ago
docker-entrypoint.sh allow custom db port 1 year ago
elixir_buildpack.config Bump minimum Elixir version to 1.10 2 years ago
mix.exs Exile: change to upstream pre-release commit that fixes build on FreeBSD 1 month ago
mix.lock Exile: change to upstream pre-release commit that fixes build on FreeBSD 1 month 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 packaged for YunoHost, NixOS, Gentoo through GURU and Archlinux through AUR. You may find more at https://repology.org/project/pleroma/versions.
If you want to package Pleroma for any OS/Distros, 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.

Raspberry Pi

Community maintained Raspberry Pi image that you can flash and run Pleroma on your Raspberry Pi. Available here https://github.com/guysoft/PleromaPi.

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