A froth fork of the federated social media platform https://pleroma.social
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
Not Sam 28fde4d87a
Merge branch 'develop' of ssh://git.pleroma.social:2222/pleroma/pleroma into froth
7 months ago
.gitlab Explain changelog.d in merge request templates 8 months ago
benchmarks Merge branch 'benchmark-fixes' into 'develop' 2 years ago
changelog.d Merge branch 'tusooa/3065-scopes' into 'develop' 7 months ago
ci Update to Phoenix 1.6 and chase dependencies 1 year ago
config Remove SSH/BBS feature from core 8 months ago
docs Merge branch 'list-installed-frontends' into 'develop' 7 months ago
installation allow custom db port 1 year ago
lib Merge branch 'develop' of ssh://git.pleroma.social:2222/pleroma/pleroma into froth 7 months ago
priv Merge branch 'develop' of ssh://git.pleroma.social:2222/pleroma/pleroma into froth 7 months ago
rel OTP releases: only set name and distribution type if not set already 4 years ago
restarter Bump minimum Elixir version to 1.10 1 year ago
test Merge branch 'accept-tags-2.5' into 'develop' 7 months ago
tools Do not count for renames when diffing 7 months ago
uploads fix issues with the uploads directory 5 years 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 'tusooa/changelog-improve' into 'develop' 7 months 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 'features/image-object' into 'develop' 9 months ago
COPYING Copyright bump for 2022 2 years ago
Dockerfile Use self-built elixir image for arm 8 months ago
Procfile CI: Add auto-deployment via dokku. 5 years ago
README.md add nixos to supported distros 2 years 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
mix.exs Merge branch 'develop' of ssh://git.pleroma.social:2222/pleroma/pleroma into froth 7 months ago
mix.lock Merge branch 'develop' of ssh://git.pleroma.social:2222/pleroma/pleroma into froth 7 months 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 and NixOS. 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