sergiotarxz/Pleroma
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
9,211 Commits 1 Branch 0 Tags 184 MiB
JavaScript 60%
Elixir 38.9%
HTML 0.9%
Shell 0.1%
1a75ef63b2
Go to file
Alexander Strizhakov 1a75ef63b2
updating benchmarks
2020-04-24 15:43:54 +03:00
.gitlab
benchmarks updating benchmarks 2020-04-24 15:43:54 +03:00
config
docs formatting 2020-04-24 15:43:54 +03:00
installation
lib reply filtering 2020-04-24 15:43:49 +03:00
priv
rel
restarter
test reply filtering 2020-04-24 15:43:49 +03:00
uploads
.buildpacks
.credo.exs
.dockerignore
.formatter.exs
.gitattributes
.gitignore
.gitlab-ci.yml
.mailmap
AGPL-3
CC-BY-SA-4.0
CHANGELOG.md reply filtering 2020-04-24 15:43:49 +03:00
COPYING
coveralls.json
docker-entrypoint.sh
Dockerfile
elixir_buildpack.config
mix.exs
mix.lock
Procfile
README.md readme: replace banner logo with the one using paths for text 2019-11-10 00:52:04 +03:00

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

Documentation

Community Channels