Pleroma backend
Find a file
Mark Felder 73204c1bca LDAP: fix compile warning
Sometimes the compile will emit the following warning, so we'll just avoid it by making it call a function in the LDAP module which will never have this problem.

warning: :GenServer.call/2 is undefined (module :GenServer is not available or is yet to be defined)
2024-09-18 11:58:52 -04:00
.gitlab
benchmarks
changelog.d LDAP: fix compile warning 2024-09-18 11:58:52 -04:00
ci CI: Switch to Elixir 1.17 2024-07-01 15:58:56 +00:00
config Formatting 2024-09-17 13:46:49 -04:00
docs Merge branch 'swoosh-mua' into 'develop' 2024-09-17 19:45:29 +00:00
installation docs: update docs for NetBSD 2024-06-20 01:40:02 +02:00
lib LDAP: fix compile warning 2024-09-18 11:58:52 -04:00
priv Ensure apps are assigned to users 2024-09-04 10:40:37 -04:00
rel pleroma_ctl: Use realpath(1) instead of readlink(1) 2024-05-23 00:39:53 +02:00
restarter
supplemental/search/fastembed-api Fastembed Server: Add health check endpoint 2024-05-27 14:15:04 +04:00
test Fix tests 2024-09-17 13:40:15 -04:00
tools Revert "Support a new changelog entry type: deps" 2024-02-16 12:52:56 -05:00
.buildpacks
.credo.exs
.dialyzer_ignore.exs Quiet Dialyzer 2024-07-25 16:36:34 -04:00
.dockerignore
.formatter.exs
.gitattributes
.gitignore Do not allow committing tests with a .ex extension 2024-08-07 13:07:54 -04:00
.gitlab-ci.yml Reapply "Custom mix task to retry failed tests once in CI pipeline" 2024-09-16 11:42:55 -04:00
.mailmap
.rgignore Add .rgignore for easier grepping 2023-12-10 17:06:28 +04:00
AGPL-3
CC-BY-4.0
CC-BY-SA-4.0
CHANGELOG.md Prepare changelog 2024-08-01 11:44:05 +04:00
COPYING
coveralls.json
docker-entrypoint.sh
Dockerfile Elixir 1.13 is the minimum required version 2023-12-20 23:39:12 +00:00
elixir_buildpack.config
mix.exs Add dependencies for Swoosh's Mua mail adapter 2024-09-13 02:58:59 +03:00
mix.lock Add dependencies for Swoosh's Mua mail adapter 2024-09-13 02:58:59 +03:00
Procfile
README.md
SECURITY.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