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

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

shibayashi's avatar
shibayashi committed
5
6
7
Pleroma is a microblogging server software that can federate (= exchange messages with) other servers that support the same federation standards (OStatus and 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 either OStatus or ActivityPub, like Friendica, GNU Social, Hubzilla, Mastodon, Misskey, Peertube, and Pixelfed.

Pleroma is written in Elixir, high-performance and can run on small devices like a Raspberry Pi.
lain's avatar
lain committed
8

eal's avatar
eal committed
9
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
10

11
- [Client Applications for Pleroma](docs/Clients.md)
lain's avatar
lain committed
12

13
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
14

15
## Installation
lain's avatar
lain committed
16

lain's avatar
lain committed
17
18
### Docker

19
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://github.com/sn0w/pleroma-docker>.
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.7 or newer. If your distribution only has an old version available, check [Elixir’s install page](https://elixir-lang.org/install.html) or use a tool like [asdf](https://github.com/asdf-vm/asdf).
HJ's avatar
update    
HJ committed
25
* Build-essential tools
26

27
### Configuration
28

29
30
* Run `mix deps.get` to install elixir dependencies.
* Run `mix pleroma.instance gen`. This will ask you 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`. It will also create a `config/setup_db.psql`, which you should run as the PostgreSQL superuser (i.e., `sudo -u postgres psql -f config/setup_db.psql`). It will create the database, user, and password you gave `mix pleroma.gen.instance` earlier, as well as set up the necessary extensions in the database. PostgreSQL superuser privileges are only needed for this step.
rinpatch's avatar
rinpatch committed
31
* For these next steps, the default will be to run pleroma using the dev configuration file, `config/dev.secret.exs`. To run them using the prod config file, prefix each command at the shell with `MIX_ENV=prod`. For example: `MIX_ENV=prod mix phx.server`. Documentation for the config can be found at [`docs/config.md`](docs/config.md) in the repository, or at the "Configuration" page on <https://docs.pleroma.social>
32
33
34
* Run `mix ecto.migrate` to run the database migrations. You will have to do this again after certain updates.
* You can check if your instance is configured correctly by running it with `mix phx.server` 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.
* 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/>. The simplest way to obtain and install a certificate is to use [Certbot.](https://certbot.eff.org) Depending on your specific setup, certbot may be able to get a certificate and configure your web server automatically.
35

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

38
* 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
39

lain's avatar
lain committed
40
### Frontends
41

lain's avatar
lain committed
42
43
Pleroma comes with two frontends. The first one, Pleroma FE, can be reached by normally visiting the site. The other one, based on the Mastodon project, can be found by visiting the /web path of your site.

HJ's avatar
HJ committed
44
### As systemd service (with provided .service file)
45
46

Example .service file can be found in `installation/pleroma.service`. Copy this to `/etc/systemd/system/`. Running `systemctl enable --now pleroma.service` will run Pleroma and enable startup on boot. Logs can be watched by using `journalctl -fu pleroma.service`.
HJ's avatar
update    
HJ committed
47

Haelwenn's avatar
Haelwenn committed
48
### As OpenRC service (with provided RC file)
49
50

Copy `installation/init.d/pleroma` to `/etc/init.d/pleroma`. You can add it to the services ran by default with: `rc-update add pleroma`
Haelwenn's avatar
Haelwenn committed
51

HJ's avatar
HJ committed
52
### Standalone/run by other means
53
54

Run `mix phx.server` in repository’s root, it will output log into stdout/stderr.
jeff's avatar
docs    
jeff committed
55
56
57

### Using an upstream proxy for federation

58
Add the following to your `dev.secret.exs` or `prod.secret.exs` if you want to proxify all http requests that Pleroma makes to an upstream proxy server:
jeff's avatar
docs    
jeff committed
59

60
61
62
63
```elixir
config :pleroma, :http,
  proxy_url: "127.0.0.1:8123"
```
jeff's avatar
docs    
jeff committed
64

65
This is useful for running Pleroma inside Tor or I2P.
lain's avatar
lain committed
66

67
68
69
70
## Customization and contribution

The [Pleroma Wiki](https://git.pleroma.social/pleroma/pleroma/wikis/home) offers manuals and guides on how to further customize your instance to your liking and how you can contribute to the project.

lain's avatar
lain committed
71
72
73
74
## Troubleshooting

### No incoming federation

75
Check that you correctly forward the `host` header to the backend. It is needed to validate signatures.