README.md 4.48 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.

lain's avatar
lain committed
7
8
For clients it supports both the GNU Social API with Qvitter extensions and the Mastodon client API.

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

* Twidere
* Tusky
* Pawoo (Android)
* Subway Tooter
lain's avatar
lain committed
15
* Amaroq (iOS)
lain's avatar
lain committed
16

lain's avatar
lain committed
17
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 https://matrix.heldscal.la/#/room/#pleromafe:matrix.heldscal.la.

19
## Installation
lain's avatar
lain committed
20

21
22
### Dependencies

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

#### Installing dependencies on Debian system
HJ's avatar
HJ committed
28
PostgreSQL 9.6 should be available on Debian stable (Jessie) from "main" area. Install it using apt: `apt install postgresql-9.6`. Make sure that older versions are not installed since Debian allows multiple versions to coexist but still runs only one version.
29
30
31

You must install elixir 1.4+ from elixir-lang.org, because Debian repos only have 1.3.x version. You will need to add apt repo to sources.list(.d) and import GPG key. Follow instructions here: https://elixir-lang.org/install.html#unix-and-unix-like (See "Ubuntu or Debian 7"). This should be valid until Debian updates elixir in their repositories. Package you want is named `elixir`, so install it using `apt install elixir`

HJ's avatar
update    
HJ committed
32
33
Elixir will also require `make` and probably other related software for building dependencies - in case you don't have them, get them via `apt install build-essential`

34
35
### Preparation

HJ's avatar
update    
HJ committed
36
37
  * You probably want application to run as separte user - so create a new one: `adduser pleroma`, you can login as it via `su pleroma`
  * Clone the git repository into new user's dir (clone as the pleroma user to avoid permissions errors)
38
39
  * Again, as new user, install dependencies with `mix deps.get` if it asks you to install "hex" - agree to that.

HJ's avatar
HJ committed
40
### Database setup
41

lain's avatar
lain committed
42
  * Create a database user and database for pleroma
43
     * Open psql shell as postgres user: (as root) `su postgres -c psql`
lain's avatar
lain committed
44
     * Create a new PostgreSQL user:
HJ's avatar
HJ committed
45

46
47
48
     ```sql
     \c pleroma_dev
     CREATE user pleroma;
HJ's avatar
HJ committed
49
     ALTER user pleroma with encrypted password '<your password>';
50
51
52
     GRANT ALL ON ALL tables IN SCHEMA public TO pleroma;
     GRANT ALL ON ALL sequences IN SCHEMA public TO pleroma;
     ```
HJ's avatar
HJ committed
53

Roger Braun's avatar
Roger Braun committed
54
55
     * Create `config/dev.secret.exs` and copy the database settings from `dev.exs` there.
     * Change password in `config/dev.secret.exs`, and change user to `"pleroma"` (line like `username: "postgres"`)
lain's avatar
lain committed
56
     * Create and update your database with `mix ecto.create && mix ecto.migrate`.
57
58
59

### Some additional configuration

lain's avatar
lain committed
60
  * You will need to let pleroma instance to know what hostname/url it's running on. _THIS IS THE MOST IMPORTANT STEP. GET THIS WRONG AND YOU'LL HAVE TO RESET YOUR DATABASE_.
61

Roger Braun's avatar
Roger Braun committed
62
    Create the file `config/dev.secret.exs`, add these lines at the end of the file:
63
64
65

    ```elixir
    config :pleroma, Pleroma.Web.Endpoint,
lain's avatar
lain committed
66
    url: [host: "example.tld", scheme: "https", port: 443]
67
68
69
    ```

    replacing `example.tld` with your (sub)domain
lain's avatar
lain committed
70

Roger Braun's avatar
Roger Braun committed
71
72
73
74
75
76
77
78
  * You should also setup your site name and admin email address. Look at config.exs for more available options.

    ```elixir
    config :pleroma, :instance,
      name: "My great instance",
      email: "someone@example.com"
    ```

HJ's avatar
HJ committed
79
80
  * 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.
81

HJ's avatar
HJ committed
82
  * [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/`.
83

HJ's avatar
HJ committed
84
## Running
lain's avatar
lain committed
85

HJ's avatar
fix    
HJ committed
86
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
87

HJ's avatar
HJ committed
88
89
90
### 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
91

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