Fork of Pleroma with site-specific changes and feature branches https://git.pleroma.social/pleroma/pleroma
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
James Edington 21fe97fa16 Saner TOTP provisioning 2 年之前
.gitlab release MR template: add a note about merging stable changes back to 3 年之前
benchmarks Deprecate Pleroma.Web.base_url/0 2 年之前
config Merge remote-tracking branch 'pleroma/develop' into errorview-json-fix 2 年之前
docs mix pleroma.database set_text_search_config now runs concurrently and infinitely 2 年之前
installation Add a default rule to not attempt to cache any files larger than 50MB 3 年之前
lib Saner TOTP provisioning 2 年之前
priv Update PleromaFE Bundle (2.4.0) 2 年之前
rel OTP releases: only set name and distribution type if not set already 4 年之前
restarter Merge branch 'develop' into gun 4 年之前
test Selecting MRF policies didn't work as intended any more 2 年之前
uploads fix issues with the uploads directory 5 年之前
.buildpacks CI: Add auto-deployment via dokku. 4 年之前
.credo.exs Move Consistency.FileLocation to ./test 3 年之前
.dockerignore remove docs/ from .dockerignore 4 年之前
.formatter.exs .formatter.exs: Format optional migrations 3 年之前
.gitattributes [#3112] .gitattributes fix. 3 年之前
.gitignore gitignore `config/runtime.exs` 2 年之前
.gitlab-ci.yml Cycles CI: skip unless Elixir code is modified 2 年之前
.mailmap Add myself to .mailmap 3 年之前
AGPL-3 LICENSE → AGPL-3 5 年之前
CC-BY-4.0 Add a copy of CC-BY-4.0 to the repo 3 年之前
CC-BY-SA-4.0 CC-BY-SA-4.0: Add a copy of the CC-BY-SA-4.0 license 5 年之前
CHANGELOG.md Release 2.4.1 2 年之前
COPYING Relicense documentation under CC-BY-4.0 3 年之前
Dockerfile Add ffmpeg 2 年之前
Procfile CI: Add auto-deployment via dokku. 4 年之前
README.md Merge branch 'pleromapi' into 'develop' 2 年之前
SECURITY.md SECURITY.md: update supported versions to only 2.2 3 年之前
coveralls.json exclude file_location check from coveralls 3 年之前
docker-entrypoint.sh Create docker.exs and docker-entrypoint + round out Dockerfile 4 年之前
elixir_buildpack.config Upgrade to Elixir 1.9 3 年之前
mix.exs Release 2.4.1 2 年之前
mix.lock Update Linkify to fix crash on posts with a URL we failed to parse correctly 2 年之前

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 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.

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