alyssa
/
pleroma
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
8,928 Commits 1 Branch 0 Tags 177 MiB
JavaScript 60.8%
Elixir 38.1%
HTML 0.9%
Shell 0.1%
Go to file
feld 8444e7ee96 Merge branch 'fix/docs-markdown' into 'develop' 
Fix formatting in documentation

See merge request pleroma/pleroma!2348
 		2020-04-02 19:36:55 +00:00
.gitlab gitlab: create templates for bug reports and release MRs 2020-03-16 17:30:50 +03:00
benchmarks use in timelines benchmark new user generator 2020-03-30 11:59:14 +03:00
config Merge branch 'gun' into 'develop' 2020-04-01 17:05:09 +00:00
docs Fix formatting in documentation 2020-04-02 23:10:13 +04:00
installation Do not strip Cache-Control headers from media. Trust the Pleroma backend. 2020-03-13 11:31:55 -05:00
lib [#2323] Fixed a typo causing /accounts/relationships to render default relationships. Improved the tests. 2020-04-02 19:23:30 +03:00
priv Merge branch 'update/adminfe-20200331' into 'develop' 2020-04-01 17:12:59 +00:00
rel OTP releases: only set name and distribution type if not set already 2019-11-22 19:58:39 +03:00
restarter Merge branch 'develop' into gun 2020-03-07 12:41:37 +03:00
test [#2323] Fixed a typo causing /accounts/relationships to render default relationships. Improved the tests. 2020-04-02 19:23:30 +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
.gitattributes .gitattributes: use native support for elixir definitions 2020-02-17 13:27:28 +03:00
.gitignore ActivityPub actions & side-effects in transaction 2020-03-01 12:01:39 +03:00
.gitlab-ci.yml remove testing `only:` in docker build 2020-03-31 22:16:36 -04: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 changelog fix 2020-03-30 12:16:45 +03:00
COPYING pleroma-fox-tan-shy.png: Add another version of pleroma-tan 2019-05-12 05:09:15 +02:00
Dockerfile add imagemagick and update inherited container to alpine:3.11 2020-03-31 21:31:23 -04: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
docker-entrypoint.sh Create docker.exs and docker-entrypoint + round out Dockerfile 2019-08-03 00:21:54 -04:00
elixir_buildpack.config CI: Add auto-deployment via dokku. 2019-05-31 10:55:35 +02:00
mix.exs updating gun with bug fix 2020-03-30 12:47:12 +03:00
mix.lock updating gun with bug fix 2020-03-30 12:47:12 +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