moon
/
spc-pleroma
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
where we keep the spc fork
15,863 Commits 2 Branches 0 Tags 208 MiB
Elixir 97.5%
HTML 1.9%
Shell 0.2%
CSS 0.2%
Go to file
Mark Felder cb4d3db8c6 Changelog for notifications fix pulled in from Rebased 2024-02-12 14:14:38 -05:00
.gitlab Update MR template to include the type 'change' 2023-11-08 09:37:08 -05:00
benchmarks Ensure benchee doesn't run unless we are executing benchmarks 2023-11-08 12:44:57 -05:00
changelog.d Changelog for notifications fix pulled in from Rebased 2024-02-12 14:14:38 -05:00
ci Pin to otp25 2024-01-26 17:38:40 +00:00
config Use config to control inclusion of test emoji 2024-01-22 18:37:13 -05:00
docs Update API docs for my changes 2024-01-17 17:13:21 +01:00
installation Fix some more typos 2023-12-28 00:17:04 +01:00
lib Fix notifications index 2024-02-12 14:13:11 -05:00
priv Fix more Logger warn -> warning 2023-12-20 16:24:27 -05:00
rel Add no_new_privs to OpenRC service files 2023-06-13 12:47:02 +02:00
restarter Bump minimum Elixir version to 1.10 2022-09-02 22:53:54 +02:00
test Pleroma.Web.RichMedia.Parser: Remove test-specific codepaths 2024-02-06 18:33:54 -05:00
tools Fix changelogd grep syntax error 2023-11-08 12:28:23 -05: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 Tell newer Credo it's OK to exit 0 on single with clauses and piping into anonymous functions for now 2022-11-13 18:46:02 -05:00
.dialyzer_ignore.exs These are all due to Cachex typespec bugs 2024-01-27 15:14:40 -05: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 Test coverage: Switch to covertool to get cobertura output 2022-09-03 05:03:50 +02:00
.gitlab-ci.yml Fix testing cache policy 2024-01-21 04:35:31 +00:00
.mailmap Add myself to .mailmap 2021-02-15 13:19:44 +03:00
.rgignore Add .rgignore for easier grepping 2023-12-10 17:06:28 +04: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 Fix some more typos 2023-12-28 00:17:04 +01:00
COPYING Revert "Merge branch 'copyright-bump' into 'develop'" 2023-01-02 20:38:50 +00:00
Dockerfile Fix dockerfile compilation. 2023-12-12 13:04:53 +04:00
Procfile CI: Add auto-deployment via dokku. 2019-05-31 10:55:35 +02:00
README.md README.md: Update packaging state (GURU, AUR) 2023-06-27 21:13:02 +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 allow custom db port 2022-11-11 12:22:21 -03:00
elixir_buildpack.config Bump minimum Elixir version to 1.10 2022-09-02 22:53:54 +02:00
mix.exs Clear up missing function dialyzer errors for :eldap 2024-01-22 18:37:29 -05:00
mix.lock Bump open_api_spex 2024-01-30 14:48:45 -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

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, NixOS, Gentoo through GURU and Archlinux through AUR. You may find more at https://repology.org/project/pleroma/versions.
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