A fork of AkkomaGang/akkoma
Go to file
Alexander Strizhakov 7f82f18664
exclude file_location check from coveralls
2020-10-13 16:44:01 +03:00
.gitlab release MR template: add a note about merging stable changes back to 2020-08-26 07:09:28 +03:00
benchmarks adding benchmarks in new format 2020-07-06 09:30:42 +03:00
config RemoteIp module name 2020-10-13 16:43:50 +03:00
docs AuthenticationPlug module name 2020-10-13 16:43:58 +03:00
installation Syntax error 2020-09-30 12:49:51 -05:00
lib fix after rebase 2020-10-13 16:44:00 +03:00
priv Update AdminFE build to latest develop 2020-10-13 07:51:48 -05:00
rel
restarter
test fix after rebase 2020-10-13 16:44:01 +03:00
uploads
.buildpacks
.credo.exs file locations consistency 2020-10-13 16:33:24 +03:00
.dockerignore
.formatter.exs
.gitattributes
.gitignore Revert "Merge branch 'issue/1023' into 'develop'" 2020-08-10 13:05:13 +00:00
.gitlab-ci.yml CI: Add ffmpeg 2020-09-28 14:14:32 +02:00
.mailmap
AGPL-3
CC-BY-4.0 Add a copy of CC-BY-4.0 to the repo 2020-09-06 11:38:38 +03:00
CC-BY-SA-4.0
CHANGELOG.md Document the NSFW link preview change 2020-10-06 14:54:21 -05:00
COPYING
Dockerfile Use TLS when adding Alpine community repository in Dockerfile 2020-09-04 19:19:56 -07:00
Procfile
README.md Add FreeBSD and alpha sort 2020-09-22 07:26:31 -05:00
SECURITY.md SECURITY.md: we don't support 2.0 anymore, bump to 2.1 2020-09-08 20:13:00 +03:00
coveralls.json exclude file_location check from coveralls 2020-10-13 16:44:01 +03:00
docker-entrypoint.sh
elixir_buildpack.config Upgrade to Elixir 1.9 2020-06-16 13:18:29 +00:00
mix.exs Update Oban to 2.1.0 2020-09-30 07:53:19 -05:00
mix.lock Update Oban to 2.1.0 2020-09-30 07:53:19 -05: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

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

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