git.squeep.com Git - akkoma/blob - README.md

   1 # Pleroma
   2
   3 ## About Pleroma
   4 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.
   5
   6 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).
   7
   8 For clients it supports the [Mastodon client API](https://docs.joinmastodon.org/api/guidelines/) with Pleroma extensions (see the API section on <https://docs-develop.pleroma.social>).
   9
  10 - [Client Applications for Pleroma](https://docs-develop.pleroma.social/backend/clients/)
  11
  12 ## Installation
  13
  14 ### OTP releases (Recommended)
  15 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, it is easily administered via the provided shell script to open up a remote console, start/stop/restart the release, start in the background, send remote commands, and more. The installation instructions are available [here](https://docs-develop.pleroma.social/backend/installation/otp_en/)
  16
  17 ### From Source
  18 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.
  19
  20 - [Debian-based](https://docs-develop.pleroma.social/backend/installation/debian_based_en/)
  21 - [Debian-based (jp)](https://docs-develop.pleroma.social/backend/installation/debian_based_jp/)
  22 - [Alpine Linux](https://docs-develop.pleroma.social/backend/installation/alpine_linux_en/)
  23 - [Arch Linux](https://docs-develop.pleroma.social/backend/installation/arch_linux_en/)
  24 - [Gentoo Linux](https://docs-develop.pleroma.social/backend/installation/gentoo_en/)
  25 - [NetBSD](https://docs-develop.pleroma.social/backend/installation/netbsd_en/)
  26 - [OpenBSD](https://docs-develop.pleroma.social/backend/installation/openbsd_en/)
  27 - [OpenBSD (fi)](https://docs-develop.pleroma.social/backend/installation/openbsd_fi/)
  28 - [CentOS 7](https://docs-develop.pleroma.social/backend/installation/centos7_en/)
  29
  30 ### OS/Distro packages
  31 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](#community-channels). If you want to change default options in your Pleroma package, please **discuss it with us first**.
  32
  33 ### Docker
  34 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>.
  35
  36 ## Documentation
  37 - Latest Released revision: <https://docs.pleroma.social>
  38 - Latest Git revision: <https://docs-develop.pleroma.social>
  39
  40 ## Community Channels
  41 * IRC: **#pleroma** and **#pleroma-dev** on freenode, webchat is available at <https://irc.pleroma.social>
  42 * Matrix: <https://matrix.to/#/#freenode_#pleroma:matrix.org> and <https://matrix.to/#/#freenode_#pleroma-dev:matrix.org>