mirrors/pleroma
1
0
Fork 0
mirror of https://git.pleroma.social/pleroma/pleroma.git synced 2024-11-18 15:41:05 +00:00
Code Issues Projects Releases Wiki Activity
Pleroma backend
13271 commits 259 branches 58 tags 334 MiB
Elixir 97.5%
HTML 1.9%
Shell 0.2%
CSS 0.2%
Find a file
Alexander Strizhakov e8107cc96a
pleroma installer and config versioning 
- added DynamicSupervisor, which starts Pleroma deps and restarts config dependent deps
- added pleroma installer, where user can configure database credentials
and pleroma config. Settings are saved into file and in database
- added versioning for in database config. New version is created from
changes which are passed to config update/delete endpoint. Every version
contains backup with all changes added through update. Versioning
supports rollbacks with N steps. With a rollback, all versions that
come after the version on which the rollback was made are deleted.
2021-03-21 10:47:59 +03:00
.gitlab release MR template: add a note about merging stable changes back to 2020-08-26 07:09:28 +03:00
benchmarks support for expires_in/expires_at in filters 2021-01-26 08:27:45 +03:00
config pleroma installer and config versioning 2021-03-21 10:47:59 +03:00
docs pleroma installer and config versioning 2021-03-21 10:47:59 +03:00
installation Add a default rule to not attempt to cache any files larger than 50MB 2021-02-05 13:35:51 -06:00
installer pleroma installer and config versioning 2021-03-21 10:47:59 +03:00
lib pleroma installer and config versioning 2021-03-21 10:47:59 +03:00
priv pleroma installer and config versioning 2021-03-21 10:47:59 +03:00
rel OTP releases: only set name and distribution type if not set already 2019-11-22 19:58:39 +03:00
test pleroma installer and config versioning 2021-03-21 10:47:59 +03: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 pleroma installer and config versioning 2021-03-21 10:47:59 +03:00
.dockerignore remove docs/ from .dockerignore 2019-11-20 00:09:07 +09:00
.formatter.exs pleroma installer and config versioning 2021-03-21 10:47:59 +03:00
.gitattributes [#3112] .gitattributes fix. 2020-12-09 18:43:20 +03:00
.gitignore pleroma installer and config versioning 2021-03-21 10:47:59 +03:00
.gitlab-ci.yml Execute mix deps.get earlier and avoid duplicate invocations if possible 2021-03-11 09:42:04 -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 pleroma installer and config versioning 2021-03-21 10:47:59 +03:00
COPYING Relicense documentation under CC-BY-4.0 2021-02-16 13:10:58 +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
Dockerfile Merge branch 'libmagic' into 'develop' 2020-11-21 18:11:58 +00:00
elixir_buildpack.config Upgrade to Elixir 1.9 2020-06-16 13:18:29 +00:00
mix.exs pleroma installer and config versioning 2021-03-21 10:47:59 +03:00
mix.lock pleroma installer and config versioning 2021-03-21 10:47:59 +03:00
Procfile CI: Add auto-deployment via dokku. 2019-05-31 10:55:35 +02:00
README.md Add FreeBSD and alpha sort 2020-09-22 07:26:31 -05: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 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.

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