sergiotarxz/Pleroma
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
13,068 Commits 1 Branch 0 Tags 184 MiB
JavaScript 60%
Elixir 38.9%
HTML 0.9%
Shell 0.1%
6dc0b13cf8
Go to file
Mark Felder 6dc0b13cf8 Revert to original formatting for these function defs
2021-02-11 14:24:51 -06:00
.gitlab
benchmarks support for expires_in/expires_at in filters 2021-01-26 08:27:45 +03:00
config Merge branch 'chore/descriptions-improvements' into 'develop' 2021-02-08 19:21:01 +00:00
docs Merge branch 'feat/allow_alt_text_search_config' into 'develop' 2021-02-06 09:42:20 +00:00
installation Add a default rule to not attempt to cache any files larger than 50MB 2021-02-05 13:35:51 -06:00
lib Revert to original formatting for these function defs 2021-02-11 14:24:51 -06:00
priv Merge branch 'feat/allow_alt_text_search_config' into 'develop' 2021-02-06 09:42:20 +00:00
rel
restarter
test Merge branch 'develop' into 'new-user-emails' 2021-02-08 16:01:50 -06:00
uploads
.buildpacks
.credo.exs
.dockerignore
.formatter.exs
.gitattributes
.gitignore
.gitlab-ci.yml CI: Forgot $ in spec-deploy 2021-02-03 18:00:04 +03:00
.mailmap
AGPL-3
CC-BY-4.0
CC-BY-SA-4.0
CHANGELOG.md Lint 2021-02-08 16:40:27 -06:00
COPYING
coveralls.json
docker-entrypoint.sh
Dockerfile
elixir_buildpack.config
mix.exs Switch to a build of Majic that does not try to fix extensions by default 2021-01-28 14:03:29 -06:00
mix.lock Switch to a build of Majic that does not try to fix extensions by default 2021-01-28 14:03:29 -06:00
Procfile
README.md
SECURITY.md

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.

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