mirrors/pleroma
1
0
Fork 0
mirror of https://git.pleroma.social/pleroma/pleroma.git synced 2024-11-13 20:41:19 +00:00
Code Issues Projects Releases Wiki Activity
Pleroma backend
15003 commits 259 branches 58 tags 358 MiB
Elixir 97.5%
HTML 1.9%
Shell 0.2%
CSS 0.2%
Find a file
Mark Felder 2e45be2653 Add :phoenix to extra_applications to suppress a warning 
Related to use of Phoenix.Flash.get/2
2023-06-02 11:34:04 -04:00
.gitlab Explain changelog.d in merge request templates 2023-04-22 21:02:13 -04:00
benchmarks Merge branch 'benchmark-fixes' into 'develop' 2021-12-09 15:38:26 +00:00
changelog.d No user facing changes 2023-05-31 13:38:46 -04:00
ci Bump minimum Elixir to 1.12 2023-05-31 21:12:13 +00:00
config Move websocket config for Shoutbox to the Endpoint 2023-05-31 15:30:58 -04:00
docs Esacpe the asterisks in Markdown 2023-05-29 15:53:16 -04:00
installation allow custom db port 2022-11-11 12:22:21 -03:00
lib Fix compile warning 2023-05-31 22:23:36 +00:00
priv Merge branch 'tusooa/3065-scopes' into 'develop' 2023-05-17 18:51:26 +00:00
rel OTP releases: only set name and distribution type if not set already 2019-11-22 19:58:39 +03:00
restarter Bump minimum Elixir version to 1.10 2022-09-02 22:53:54 +02:00
test Fix test warnings 2023-05-31 16:30:31 -04:00
tools Do not count for renames when diffing 2023-05-02 22:16:00 -04: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
.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 Bump minimum Elixir to 1.12 2023-05-31 21:12:13 +00: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 'release/2.5.2' into mergeback/2.5.2 2023-05-26 23:47:50 +02:00
COPYING Copyright bump for 2022 2022-02-25 23:11:42 -07: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
Dockerfile Bump minimum Elixir to 1.12 2023-05-31 21:12:13 +00:00
elixir_buildpack.config Bump minimum Elixir version to 1.10 2022-09-02 22:53:54 +02:00
mix.exs Add :phoenix to extra_applications to suppress a warning 2023-06-02 11:34:04 -04:00
mix.lock Remove locked version of plug 2023-05-31 15:30:31 -04:00
Procfile CI: Add auto-deployment via dokku. 2019-05-31 10:55:35 +02:00
README.md add nixos to supported distros 2022-01-22 09:39:02 +01:00
SECURITY.md SECURITY.md: update supported versions to only 2.2 2020-10-15 21:45:31 +03: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 and NixOS. 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