pleroma

Fork of Pleroma with site-specific changes and feature branches https://git.pleroma.social/pleroma/pleroma

James Edington 21fe97fa16 Saner TOTP provisioning A user's e-mail address may be fluid, and the site "instance name" may be strange or change regularly. There's no reason to use these over the user's stable ID and the site's stable hostname for TOTP parameters. Even if the system is built to TOLERATE changes (as it is -- I tested it), it seems much more elegant to have these para- meters as stable identifiers.		před 2 roky
.gitlab	release MR template: add a note about merging stable changes back to	před 3 roky
benchmarks	Deprecate Pleroma.Web.base_url/0	před 2 roky
config	Merge remote-tracking branch 'pleroma/develop' into errorview-json-fix	před 2 roky
docs	mix pleroma.database set_text_search_config now runs concurrently and infinitely	před 2 roky
installation	Add a default rule to not attempt to cache any files larger than 50MB	před 3 roky
lib	Saner TOTP provisioning	před 2 roky
priv	Update PleromaFE Bundle (2.4.0)	před 2 roky
rel	OTP releases: only set name and distribution type if not set already	před 4 roky
restarter	Merge branch 'develop' into gun	před 4 roky
test	Selecting MRF policies didn't work as intended any more	před 2 roky
uploads	fix issues with the uploads directory	před 5 roky
.buildpacks	CI: Add auto-deployment via dokku.	před 4 roky
.credo.exs	Move Consistency.FileLocation to ./test	před 3 roky
.dockerignore	remove docs/ from .dockerignore	před 4 roky
.formatter.exs	.formatter.exs: Format optional migrations	před 3 roky
.gitattributes	[#3112] .gitattributes fix.	před 3 roky
.gitignore	gitignore `config/runtime.exs`	před 2 roky
.gitlab-ci.yml	Cycles CI: skip unless Elixir code is modified	před 2 roky
.mailmap	Add myself to .mailmap	před 3 roky
AGPL-3	LICENSE → AGPL-3	před 5 roky
CC-BY-4.0	Add a copy of CC-BY-4.0 to the repo	před 3 roky
CC-BY-SA-4.0	CC-BY-SA-4.0: Add a copy of the CC-BY-SA-4.0 license	před 5 roky
CHANGELOG.md	Release 2.4.1	před 2 roky
COPYING	Relicense documentation under CC-BY-4.0	před 3 roky
Dockerfile	Add ffmpeg	před 2 roky
Procfile	CI: Add auto-deployment via dokku.	před 4 roky
README.md	Merge branch 'pleromapi' into 'develop'	před 2 roky
SECURITY.md	SECURITY.md: update supported versions to only 2.2	před 3 roky
coveralls.json	exclude file_location check from coveralls	před 3 roky
docker-entrypoint.sh	Create docker.exs and docker-entrypoint + round out Dockerfile	před 4 roky
elixir_buildpack.config	Upgrade to Elixir 1.9	před 3 roky
mix.exs	Release 2.4.1	před 2 roky
mix.lock	Update Linkify to fix crash on posts with a URL we failed to parse correctly	před 2 roky

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).

Client Applications for Pleroma

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 not packaged by any OS/Distros, but if you want to package it for one, 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

Latest Released revision: https://docs.pleroma.social
Latest Git revision: https://docs-develop.pleroma.social

Community Channels

IRC: #pleroma and #pleroma-dev on libera.chat, webchat is available at https://irc.pleroma.social
Matrix: #pleroma:libera.chat and #pleroma-dev:libera.chat