docs: add README for collection

This commit is contained in:
Jan Christian Grünhage 2020-08-10 11:40:58 +02:00
parent e2fbaf67bf
commit d296d8dd20
3 changed files with 24 additions and 1 deletions

View file

@ -1 +1,3 @@
* @jcgruenhage
roles @jcgruenhage @madonius
plugins/modules/matrix_signing_key.py @madonius

View file

@ -1,3 +1,23 @@
# Ansible Collection - famedly.matrix
Documentation for the collection.
## Modules
This collection contains a few modules for managing matrix rooms and
servers, as well as sending notifications from ansible to matrix.
- **matrix\_login**: Create an access token for a matrix account.
- **matrix\_logout**: Invalidates an access token.
- **matrix\_notification**: Sends a message to a matrix room.
- **matrix\_room**: Idempotently joins/creates a room with a given
alias.
- **matrix\_state**: Ensures room state has a given content.
- **matrix\_signing\_key**: Creates a server signing key.
## Roles
In addition to the modules, this role *also* contains a few roles for
deploying commonly used matrix services:
- **synapse**: Homeserver, this is where your accounts live.
- **element**: Web client, for using your accounts.
For details on using these, look at the README.md in the respective
role directory.

View file

@ -4,6 +4,7 @@ version: 0.1.0
readme: README.md
authors:
- Jan Christian Grünhage <jan.christian@gruenhage.xyz>
- Emmanouil Kampitakis
description: roles and modules for managing a matrix.org deployment
license:
- AGPL-3.0-only