BE for bae.st https://bae.st
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Go to file
Your New SJW Waifu 0567c78b17 Merge remote-tracking branch 'upstream/develop' into neckbeard 2 weeks ago
.gitlab Update MR template to include the type 'change' 3 weeks ago
benchmarks Ensure benchee doesn't run unless we are executing benchmarks 3 weeks ago
changelog.d Merge branch 'favicon' into 'develop' 2 weeks ago
ci Bump minimum Elixir to 1.12 6 months ago
config Add support for configuring a favicon and embed PWA manifest in server-generated-meta 2 weeks ago
docs docs: clang is also supported 2 weeks ago
installation Merge branch 'tusooa/media-altdomain' into 'develop' 5 months ago
lib Merge remote-tracking branch 'upstream/develop' into neckbeard 2 weeks ago
priv Merge branch 'quotes-count' into 'develop' 3 weeks ago
rel Add no_new_privs to OpenRC service files 6 months ago
restarter Bump minimum Elixir version to 1.10 1 year ago
test Merge branch 'favicon' into 'develop' 2 weeks ago
tools Fix changelogd grep syntax error 3 weeks 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
.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 Test coverage: Switch to covertool to get cobertura output 1 year ago
.gitlab-ci.yml Merge branch 'develop' into phoenix1.7 3 weeks ago
.mailmap Add myself to .mailmap 3 years ago
AGPL-3 LICENSE → AGPL-3 5 years ago
CC-BY-4.0 Add a copy of CC-BY-4.0 to the repo 3 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 Merge branch 'stable' into 'release/2.6.0' 1 month ago
COPYING Revert "Merge branch 'copyright-bump' into 'develop'" 11 months ago
Dockerfile Merge branch 'develop' into phoenix1.7 3 weeks ago
Procfile CI: Add auto-deployment via dokku. 5 years ago
README.md README.md: Update packaging state (GURU, AUR) 5 months ago
SECURITY.md SECURITY.md: update supported versions to only 2.2 3 years ago
coveralls.json exclude file_location check from coveralls 3 years ago
docker-entrypoint.sh allow custom db port 1 year ago
elixir_buildpack.config Bump minimum Elixir version to 1.10 1 year ago
fix_users.exs file extensions are really hard 3 years ago
mix.exs Merge remote-tracking branch 'upstream/develop' into neckbeard 2 weeks ago
mix.lock mix: Bump elixir-captcha for system-CFLAGS 2 weeks ago
uploads update host and uploads location 2 years 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 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.

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