sam/pleroma
sam/pleroma
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
A froth fork of the federated social media platform. This will not be updated frequently, use at your own peril. https://blog.froth.zone/sam/the-end-of-an-era
7937 commits 2 branches 40 tags 290 MiB
Elixir 97%
HTML 2.2%
CSS 0.4%
Shell 0.3%
Find a file
sadposter 803bce3668 Merge branch 'develop' of https://git.pleroma.social/pleroma/pleroma into develop
2019-12-12 17:48:36 +00:00
benchmarks Merge branch 'remove-info-from-users' into 'develop' 2019-11-30 10:42:51 +00:00
config Merge branch 'develop' of https://git.pleroma.social/pleroma/pleroma into develop 2019-12-12 17:48:36 +00:00
docs Merge branch 'develop' into feature/report-notes 2019-12-12 02:16:23 +03:00
installation Add remote_ip plug 2019-09-27 21:59:23 +00:00
lib Merge branch 'develop' of https://git.pleroma.social/pleroma/pleroma into develop 2019-12-12 17:48:36 +00:00
priv Merge branch 'develop' of https://git.pleroma.social/pleroma/pleroma into develop 2019-12-12 17:48:36 +00:00
rel OTP releases: only set name and distribution type if not set already 2019-11-22 19:58:39 +03:00
test [#1427] Graceful clearance of OAuth admin scopes for non-admin users (no error raised). 2019-12-12 16:00:06 +03:00
uploads fix issues with the uploads directory 2019-04-28 06:43:00 +02:00
.buildpacks CI: Add auto-deployment via dokku. 2019-05-31 10:55:35 +02:00
.credo.exs [Credo][CI] Add readability as it’s fixed 2019-03-13 04:26:56 +01:00
.dockerignore remove docs/ from .dockerignore 2019-11-20 00:09:07 +09:00
.formatter.exs HTML: Compile Scrubbers on boot 2019-12-08 20:35:41 +03:00
.gitignore Merge branch 'develop' of https://git.pleroma.social/pleroma/pleroma into develop 2019-09-16 12:14:48 +01:00
.gitlab-ci.yml Merge branch 'chore/manual-benchmark' into 'develop' 2019-11-28 17:46:23 +00:00
.mailmap add mailmap [ci skip] 2019-07-11 08:57:51 +00:00
AGPL-3 LICENSE → AGPL-3 2019-04-01 00:31:21 +02:00
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 Merge branch 'develop' into feature/report-notes 2019-12-12 02:16:23 +03:00
COPYING pleroma-fox-tan-shy.png: Add another version of pleroma-tan 2019-05-12 05:09:15 +02:00
docker-entrypoint.sh Create docker.exs and docker-entrypoint + round out Dockerfile 2019-08-03 00:21:54 -04:00
Dockerfile Switch to alpine:3.9 to avoid dlsym errors 2019-09-04 14:56:26 -04:00
elixir_buildpack.config CI: Add auto-deployment via dokku. 2019-05-31 10:55:35 +02:00
mix.exs Merge remote-tracking branch 'remotes/upstream/develop' into 1335-user-api-id-fields-relations 2019-11-29 10:17:59 +03:00
mix.lock mix.lock: update fast_sanitize 2019-12-11 20:44:45 +03:00
Procfile CI: Add auto-deployment via dokku. 2019-05-31 10:55:35 +02:00
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