README.md 2.64 KB
Newer Older
lain's avatar
lain committed
1
2
# Pleroma

lain's avatar
lain committed
3
4
5
6
## About Pleroma

Pleroma is an OStatus-compatible social networking server written in Elixir, compatible with GNU Social and Mastodon. It is high-performance and can run on small devices like a Raspberry Pi.

eal's avatar
eal committed
7
For clients it supports both the [GNU Social API with Qvitter extensions](https://twitter-api.readthedocs.io/en/latest/index.html) and the [Mastodon client API](https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md).
lain's avatar
lain committed
8

lain's avatar
lain committed
9
Mobile clients that are known to work well:
lain's avatar
lain committed
10
11
12

* Twidere
* Tusky
lain's avatar
lain committed
13
* Pawoo (Android + iOS)
lain's avatar
lain committed
14
* Subway Tooter
lain's avatar
lain committed
15
* Amaroq (iOS)
eal's avatar
eal committed
16
* Tootdon (Android + iOS)
lain's avatar
lain committed
17

lain's avatar
lain committed
18
No release has been made yet, but several servers have been online for months already. If you want to run your own server, feel free to contact us at @lain@pleroma.soykaf.com or in our dev chat at #pleroma on freenode or via matrix at https://matrix.heldscal.la/#/room/#freenode_#pleroma:matrix.org.
lain's avatar
lain committed
19

20
## Installation
lain's avatar
lain committed
21

22
23
### Dependencies

HJ's avatar
HJ committed
24
* Postgresql version 9.6 or newer
25
* Elixir version 1.4 or newer
HJ's avatar
update    
HJ committed
26
* Build-essential tools
27

28
### Configuration
29

30
  * Run `mix generate_config`. This will ask you a few questions about your instance and generate a configuration file in `config/generated_config.exs`. Check that and copy it to either `config/dev.secret.exs` or `config/prod.secret.exs`. You can check if your instance is configured correctly by running it with `mix phx.serve` and checking the instance info endpoint at `/api/v1/instance`. If it shows your uri, name and email correctly, you are configured correctly. If it shows something like `localhost:4000`, your configuration is probably wrong, unless you are running a local development setup.
Roger Braun's avatar
Roger Braun committed
31

HJ's avatar
HJ committed
32
33
  * The common and convenient way for adding HTTPS is by using Nginx as a reverse proxy. You can look at example Nginx configuration in `installation/pleroma.nginx`. If you need TLS/SSL certificates for HTTPS, you can look get some for free with letsencrypt: https://letsencrypt.org/
  On Debian you can use `certbot` package and command to manage letsencrypt certificates.
34

HJ's avatar
HJ committed
35
  * [Not tested with system reboot yet!] You'll also want to set up Pleroma to be run as a systemd service. Example .service file can be found in `installation/pleroma.service` you can put it in `/etc/systemd/system/`.
36

HJ's avatar
HJ committed
37
## Running
lain's avatar
lain committed
38

HJ's avatar
fix    
HJ committed
39
By default, it listens on port 4000 (TCP), so you can access it on http://localhost:4000/ (if you are on the same machine). In case of an error it will restart automatically.
HJ's avatar
update    
HJ committed
40

HJ's avatar
HJ committed
41
42
43
### As systemd service (with provided .service file)
Running `service pleroma start`
Logs can be watched by using `journalctl -fu pleroma.service`
HJ's avatar
update    
HJ committed
44

HJ's avatar
HJ committed
45
46
### Standalone/run by other means
Run `mix phx.server` in repository's root, it will output log into stdout/stderr