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

lain's avatar
lain committed
3
4
5
6
7
8
## 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.

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.

9
## Installation
lain's avatar
lain committed
10

11
12
### Dependencies

HJ's avatar
HJ committed
13
* Postgresql version 9.6 or newer
14
* Elixir version 1.4 or newer
HJ's avatar
update    
HJ committed
15
* Build-essential tools
16
17

#### Installing dependencies on Debian system
HJ's avatar
HJ committed
18
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.
19
20
21

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
22
23
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`

24
25
### Preparation

HJ's avatar
update    
HJ committed
26
27
  * 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)
28
29
  * 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
30
### Database setup
31

lain's avatar
lain committed
32
  * Create a database user and database for pleroma
33
     * Open psql shell as postgres user: (as root) `su postgres -c psql`
lain's avatar
lain committed
34
     * Create a new PostgreSQL user:
HJ's avatar
HJ committed
35

36
37
38
     ```sql
     \c pleroma_dev
     CREATE user pleroma;
HJ's avatar
HJ committed
39
     ALTER user pleroma with encrypted password '<your password>';
40
41
42
     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
43

lain's avatar
lain committed
44
45
     * Change password in `config/dev.exs`, and change user to `"pleroma"` (line like `username: "postgres"`)
     * Create and update your database with `mix ecto.create && mix ecto.migrate`. If it gives errors, try running again, this is a known issue.
46
47
48

### Some additional configuration

lain's avatar
lain committed
49
  * 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_.
50
51
52
53
54

    In file `config/dev.exs`, add these lines at the end of the file:

    ```elixir
    config :pleroma, Pleroma.Web.Endpoint,
lain's avatar
lain committed
55
    url: [host: "example.tld", scheme: "https", port: 443]
56
57
58
    ```

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

HJ's avatar
HJ committed
60
61
  * 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.
62

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

HJ's avatar
HJ committed
65
## Running
lain's avatar
lain committed
66

HJ's avatar
fix    
HJ committed
67
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
68

HJ's avatar
HJ committed
69
70
71
### 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
72

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