README.md 3.73 KB
Newer Older
1
<img src="https://git.pleroma.social/pleroma/pleroma/uploads/8cec84f5a084d887339f57deeb8a293e/pleroma-banner-vector-nopad-notext.svg" width="300px" />
rinpatch's avatar
rinpatch committed
2 3

## About 
lain's avatar
lain committed
4

rinpatch's avatar
rinpatch committed
5 6 7
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).
lain's avatar
lain committed
8

rinpatch's avatar
rinpatch committed
9
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>).
shibayashi's avatar
shibayashi committed
10

rinpatch's avatar
rinpatch committed
11
- [Client Applications for Pleroma](https://docs-develop.pleroma.social/backend/clients/)
lain's avatar
lain committed
12

rinpatch's avatar
rinpatch committed
13
## Installation
lain's avatar
lain committed
14

rinpatch's avatar
rinpatch committed
15
### OTP releases (Recommended)
16
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](https://docs-develop.pleroma.social/backend/installation/otp_en/).
lain's avatar
lain committed
17

rinpatch's avatar
rinpatch committed
18 19
### 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.
lain's avatar
lain committed
20

rinpatch's avatar
rinpatch committed
21 22 23 24 25 26 27 28 29
- [Debian-based](https://docs-develop.pleroma.social/backend/installation/debian_based_en/)
- [Debian-based (jp)](https://docs-develop.pleroma.social/backend/installation/debian_based_jp/)
- [Alpine Linux](https://docs-develop.pleroma.social/backend/installation/alpine_linux_en/)
- [Arch Linux](https://docs-develop.pleroma.social/backend/installation/arch_linux_en/)
- [Gentoo Linux](https://docs-develop.pleroma.social/backend/installation/gentoo_en/)
- [NetBSD](https://docs-develop.pleroma.social/backend/installation/netbsd_en/)
- [OpenBSD](https://docs-develop.pleroma.social/backend/installation/openbsd_en/)
- [OpenBSD (fi)](https://docs-develop.pleroma.social/backend/installation/openbsd_fi/)
- [CentOS 7](https://docs-develop.pleroma.social/backend/installation/centos7_en/)
lain's avatar
lain committed
30

31
### OS/Distro packages
rinpatch's avatar
rinpatch committed
32
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**.
33

lain's avatar
lain committed
34
### Docker
Pierce McGoran's avatar
Pierce McGoran committed
35
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>.
lain's avatar
lain committed
36

37 38 39 40 41 42 43 44 45 46
### 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.

rinpatch's avatar
rinpatch committed
47 48 49
## Documentation
- Latest Released revision: <https://docs.pleroma.social>
- Latest Git revision: <https://docs-develop.pleroma.social>
lain's avatar
lain committed
50

rinpatch's avatar
rinpatch committed
51 52
## Community Channels
* IRC: **#pleroma** and **#pleroma-dev** on freenode, webchat is available at <https://irc.pleroma.social>
53
* Matrix: <https://matrix.to/#/#freenode_#pleroma:matrix.org> and <https://matrix.to/#/#freenode_#pleroma-dev:matrix.org>