BE for bae.st https://bae.st
Go to file
Your New SJW Waifu 6ba6456150 Full migration from Pleroma to Akkoma 2022-07-29 18:16:19 -05:00
.gitlab release MR template: add a note about merging stable changes back to 2020-08-26 07:09:28 +03:00
benchmarks Merge branch 'benchmark-fixes' into 'develop' 2021-12-09 15:38:26 +00:00
ci CI: Use own package as base 2021-12-26 18:05:42 +01:00
config Add authorized_fetch_mode to description.exs 2022-07-25 19:53:51 +02:00
docs DOCS: Add some small piece about setting up a Gitlab-runner 2022-07-13 20:54:24 +02:00
installation Actually fix with forward slashes being restricted inside nickname 2022-07-18 21:30:57 -06:00
lib Merge remote-tracking branch 'upstream/develop' into neckbeard 2022-07-29 18:13:28 -05:00
priv Extract translatable strings 2022-07-26 10:50:29 -04:00
rel
restarter
test Merge branch 'fix/proper-emoji-qualification' into 'develop' 2022-07-28 04:46:15 +00:00
.buildpacks
.credo.exs Move Consistency.FileLocation to ./test 2020-10-13 19:57:45 +02:00
.dockerignore
.formatter.exs .formatter.exs: Format optional migrations 2021-01-10 11:28:41 +03:00
.gitattributes [#3112] .gitattributes fix. 2020-12-09 18:43:20 +03:00
.gitignore gitignore `config/runtime.exs` 2021-05-16 13:22:07 -05:00
.gitlab-ci.yml CI: Remove cache on cycles 2022-07-20 17:49:56 +02:00
.mailmap Add myself to .mailmap 2021-02-15 13:19:44 +03:00
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 Rename the Exiftool module 2022-07-01 12:15:02 +02:00
COPYING Copyright bump for 2022 2022-02-25 23:11:42 -07:00
Dockerfile Bump alpine to 3.14 2021-12-17 18:03:06 -05:00
Procfile CI: Add auto-deployment via dokku. 2019-05-31 10:55:35 +02:00
README.md Add YunoHost to installation guides 2021-08-07 12:49:28 +02:00
SECURITY.md SECURITY.md: update supported versions to only 2.2 2020-10-15 21:45:31 +03:00
coveralls.json exclude file_location check from coveralls 2020-10-13 16:44:01 +03:00
docker-entrypoint.sh
elixir_buildpack.config
fix_users.exs file extensions are really hard 2021-02-09 11:31:11 -06:00
mix.exs Full migration from Pleroma to Akkoma 2022-07-29 18:16:19 -05:00
mix.lock mix: update eblurhash to 1.2.2 2022-07-02 14:52:28 +02:00
uploads update host and uploads location 2021-12-14 07:17:24 -06: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 packaged for YunoHost. If you want to package Pleroma for any OS/Distros, 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.

Raspberry Pi

Community maintained Raspberry Pi image that you can flash and run Pleroma on your Raspberry Pi. Available here https://github.com/guysoft/PleromaPi.

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