hj/pleroma
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
No description
17,176 commits 2 branches 0 tags 243 MiB
Find a file
Mark Felder 77dca7c3e5 Refactor ReachabilityWorker to use a 5-phase reachability testing approach 
It will check reachability for an instance deemed unreachable at the following intervals:

4 attempts, once a minute
4 attempts, once every 15 minutes
4 attempts, once every 60 minutes
4 attempts, once every 8 hours
4 attempts, once every 24 hours

This should be effective and respectful of the resources of instances on the fediverse.

We have the Oban Pruner plugin enabled to keep the Oban Jobs table from growing indefinitely. It prunes every 15 minutes, but this will interfere with our ability to enforce uniqueness on the ReachabilityWorker jobs for a time period longer than 15 minutes. The solution is to exclude the ReachabilityWorker from the pruning operation and instead schedule a custom job that will prune the table for us once a day. The ReachabilityPruner cron task will clean up the history of the ReachabilityWorker jobs older than 6 days.
2025-06-27 17:00:02 -07:00
.gitlab
benchmarks
changelog.d Merge remote-tracking branch 'origin/develop' into improved-reachability 2025-06-27 15:59:46 -07:00
ci Replace Elixir 1.17 with 1.18 for build unit-testing pipelines 2025-05-24 22:17:38 +02:00
config Refactor ReachabilityWorker to use a 5-phase reachability testing approach 2025-06-27 17:00:02 -07:00
docs Merge branch 'scrobbles' into 'develop' 2025-06-18 10:25:38 +00:00
installation Merge branch 'openbsd-docs' into 'develop' 2025-06-06 00:59:58 +00:00
lib Refactor ReachabilityWorker to use a 5-phase reachability testing approach 2025-06-27 17:00:02 -07:00
priv Merge branch 'tusooa/assign-app-user-oom' into 'develop' 2025-06-07 19:39:57 +00:00
rel Disable busywaits in releases 2024-10-25 11:34:54 -04:00
restarter
supplemental/search/fastembed-api
test Refactor ReachabilityWorker to use a 5-phase reachability testing approach 2025-06-27 17:00:02 -07:00
tools
.buildpacks
.credo.exs
.dialyzer_ignore.exs
.dockerignore
.formatter.exs
.gitattributes
.gitignore
.gitlab-ci.yml Use manually created variables for CI instead of CI_JOB_TOKEN 2025-06-18 17:36:08 +03:00
.mailmap
.rgignore
AGPL-3
CC-BY-4.0
CC-BY-SA-4.0 CC-BY-SA-4.0: Add a copy of the CC-BY-SA-4.0 license 2019-04-01 00:30:21 +02:00
CHANGELOG.md Update changelog 2025-03-11 18:06:43 +04:00
COPYING
coveralls.json
docker-entrypoint.sh
Dockerfile Dockerfile: Elixir 1.14 2024-09-21 15:40:04 +02:00
elixir_buildpack.config
mix.exs Remove forgotten Pleroma.OTPVersion usage in mix.exs 2025-06-05 16:48:58 +02:00
mix.lock Elixir 1.18 Update credo 2025-06-04 19:18:01 +02:00
Procfile
README.md
SECURITY.md

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

OTP releases (Recommended)

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