moon
/
spc-pleroma
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
where we keep the spc fork
14,197 Commits 2 Branches 0 Tags 208 MiB
Elixir 97.5%
HTML 1.9%
Shell 0.2%
CSS 0.2%
Go to file
marcin mikołajczak d26aadb743 Add tests 
Signed-off-by: marcin mikołajczak <git@mkljczk.pl>
 		2022-05-16 14:06:53 +02: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 Max media attachment count 2022-02-06 17:41:15 +01:00
docs Merge branch 'improve_anti_followbot_policy' into 'develop' 2022-05-08 18:10:40 +00:00
installation Update Caddyfile to Caddy v2 2022-03-06 14:24:32 +01:00
lib Allow submitting an array of rule_ids to /api/v1/reports 2022-05-16 14:06:49 +02:00
priv Instance rules 2022-05-16 14:02:32 +02: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 Add tests 2022-05-16 14:06:53 +02: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 Move Consistency.FileLocation to ./test 2020-10-13 19:57:45 +02:00
.dockerignore remove docs/ from .dockerignore 2019-11-20 00:09:07 +09:00
.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 unit-testing-erratic: allow failure 2022-01-15 13:35:22 -06:00
.mailmap Add myself to .mailmap 2021-02-15 13:19:44 +03:00
AGPL-3 LICENSE → AGPL-3 2019-04-01 00:31:21 +02:00
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 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 'improve_anti_followbot_policy' into 'develop' 2022-05-08 18:10:40 +00: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 Create docker.exs and docker-entrypoint + round out Dockerfile 2019-08-03 00:21:54 -04:00
elixir_buildpack.config Upgrade to Elixir 1.9 2020-06-16 13:18:29 +00:00
mix.exs mix: Bump to 2.4.52 for 2.4.3 mergeback 2022-05-06 10:23:43 +02:00
mix.lock update sweet_xml [Security] 2022-05-06 10:23:25 +02: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 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 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.

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