A froth fork of the federated social media platform https://pleroma.social
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.
 
 
 
 
Not Sam 8f4a61cae3
Merge branch 'develop' of git.pleroma.social:pleroma/pleroma into froth
1 week ago
.gitlab release MR template: add a note about merging stable changes back to 1 year ago
benchmarks Deprecate Pleroma.Web.base_url/0 6 months ago
config Merge branch 'develop' of git.pleroma.social:pleroma/pleroma into develop 3 months ago
docs Merge branch 'block-behavior' into 'develop' 2 weeks ago
installation Remove bash script for downloading new MastoFE build 7 months ago
lib Merge branch 'develop' of git.pleroma.social:pleroma/pleroma into froth 1 week ago
priv Translated using Weblate (Japanese) 2 months ago
rel OTP releases: only set name and distribution type if not set already 2 years ago
restarter Merge branch 'develop' into gun 2 years ago
test Merge branch 'fix-tests' into 'develop' 2 weeks ago
uploads fix issues with the uploads directory 3 years ago
.buildpacks CI: Add auto-deployment via dokku. 3 years ago
.credo.exs Move Consistency.FileLocation to ./test 1 year ago
.dockerignore remove docs/ from .dockerignore 2 years ago
.formatter.exs .formatter.exs: Format optional migrations 11 months ago
.gitattributes [#3112] .gitattributes fix. 12 months ago
.gitignore gitignore `config/runtime.exs` 6 months ago
.gitlab-ci.yml CI: Upload the image for all platforms 2 weeks ago
.mailmap Add myself to .mailmap 9 months ago
AGPL-3 LICENSE → AGPL-3 3 years ago
CC-BY-4.0 Add a copy of CC-BY-4.0 to the repo 1 year ago
CC-BY-SA-4.0 CC-BY-SA-4.0: Add a copy of the CC-BY-SA-4.0 license 3 years ago
CHANGELOG.md Merge branch 'block-behavior' into 'develop' 2 weeks ago
COPYING Relicense documentation under CC-BY-4.0 9 months ago
Dockerfile Add ffmpeg 6 months ago
Procfile CI: Add auto-deployment via dokku. 3 years ago
README.md Add YunoHost to installation guides 4 months ago
SECURITY.md SECURITY.md: update supported versions to only 2.2 1 year ago
coveralls.json exclude file_location check from coveralls 1 year ago
docker-entrypoint.sh Create docker.exs and docker-entrypoint + round out Dockerfile 2 years ago
elixir_buildpack.config Upgrade to Elixir 1.9 1 year ago
mix.exs Merge branch 'bugfix/markdown-newlines' into 'develop' 1 week ago
mix.lock Merge branch 'bugfix/markdown-newlines' into 'develop' 1 week 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. 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