README.md
author Luke Hoersten <luke@hoersten.org>
Sun, 19 Jan 2020 13:41:08 -0600
changeset 84 d0c40727e6ff
parent 70 2cfe2fb975a8
child 128 b1cab99990c6
permissions -rw-r--r--
Added WIP pleroma OTP role.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
70
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     1
# Pleroma Ansible Roles
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     2
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     3
This project is a collection of [Ansible](http://ansible.com) roles designed to install one or
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     4
more [Pleroma](https://pleroma.social) instances behind an [Nginx](http://nginx.org) reverse proxy.
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     5
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     6
## Example Playbook
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     7
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     8
The following example configures two Pleroma instances on one host and uses an Nginx reverse proxy to route based on
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     9
domain name. The second site is optional.
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    10
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    11
```yaml
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    12
- hosts: pleroma
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    13
  roles:
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    14
    - role: pleroma
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    15
      pleroma_user: "pleroma_example"
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    16
      pleroma_link_host: "example.social"
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    17
      pleroma_port: 4000
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    18
      pleroma_signup_open: "true"
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    19
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    20
- hosts: pleroma
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    21
  roles:
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    22
    - role: pleroma
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    23
      pleroma_user: "pleroma_test"
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    24
      pleroma_link_host: "test.social"
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    25
      pleroma_port: 4001
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    26
      pleroma_signup_open: "true"
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    27
```
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    28
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    29
## Example Ansible Vars
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    30
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    31
The following variables would go into Ansible `group_vars`, for example, and connects to an AWS RDS PostgreSQL database.
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    32
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    33
```yaml
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    34
nginx_conf_src:    "roles/pleroma/templates/pleroma.nginx.conf.j2"
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    35
nginx_enable_ssl:  Yes
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    36
nginx_server_name: "{{pleroma_link_host}}"
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    37
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    38
pleroma_link_scheme: "https"
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    39
pleroma_db_host: "pleroma.123123.us-east-1.rds.amazonaws.com"
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    40
pleroma_db_passwd: "pleDbPass123"
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    41
pleroma_db_superpass: "dbpass123"
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    42
pleroma_secret_key: "secret123"
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    43
```