README.md
author Luke Hoersten <luke@hoersten.org>
Fri, 09 Sep 2022 11:56:30 -0500
changeset 190 59bef6fbab49
parent 128 b1cab99990c6
permissions -rw-r--r--
Minor homebridge updates.
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
128
b1cab99990c6 Added canonical link to readme.
Luke Hoersten <luke@hoersten.org>
parents: 70
diff changeset
     3
https://src.nth.io/ansible-roles/file
b1cab99990c6 Added canonical link to readme.
Luke Hoersten <luke@hoersten.org>
parents: 70
diff changeset
     4
70
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     5
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
     6
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
     7
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     8
## Example Playbook
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     9
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    10
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
    11
domain name. The second site is optional.
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    12
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    13
```yaml
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    14
- hosts: pleroma
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    15
  roles:
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    16
    - role: pleroma
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    17
      pleroma_user: "pleroma_example"
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    18
      pleroma_link_host: "example.social"
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    19
      pleroma_port: 4000
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    20
      pleroma_signup_open: "true"
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    21
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    22
- hosts: pleroma
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    23
  roles:
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    24
    - role: pleroma
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    25
      pleroma_user: "pleroma_test"
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    26
      pleroma_link_host: "test.social"
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    27
      pleroma_port: 4001
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    28
      pleroma_signup_open: "true"
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    29
```
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    30
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    31
## Example Ansible Vars
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    32
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    33
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
    34
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    35
```yaml
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    36
nginx_conf_src:    "roles/pleroma/templates/pleroma.nginx.conf.j2"
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    37
nginx_enable_ssl:  Yes
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    38
nginx_server_name: "{{pleroma_link_host}}"
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    39
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    40
pleroma_link_scheme: "https"
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    41
pleroma_db_host: "pleroma.123123.us-east-1.rds.amazonaws.com"
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    42
pleroma_db_passwd: "pleDbPass123"
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    43
pleroma_db_superpass: "dbpass123"
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    44
pleroma_secret_key: "secret123"
2cfe2fb975a8 Added readme.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    45
```