From d296d8dd20e8be85e323f928c6397be0df15a68b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Christian=20Gr=C3=BCnhage?= Date: Mon, 10 Aug 2020 11:40:58 +0200 Subject: [PATCH] docs: add README for collection --- CODEOWNERS | 2 ++ README.md | 22 +++++++++++++++++++++- galaxy.yml | 1 + 3 files changed, 24 insertions(+), 1 deletion(-) diff --git a/CODEOWNERS b/CODEOWNERS index 8ca5458..7f7f246 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -1 +1,3 @@ * @jcgruenhage +roles @jcgruenhage @madonius +plugins/modules/matrix_signing_key.py @madonius diff --git a/README.md b/README.md index 75fbd1d..70ec1c7 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,23 @@ # Ansible Collection - famedly.matrix -Documentation for the collection. \ No newline at end of file +## 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. diff --git a/galaxy.yml b/galaxy.yml index 1d7a73a..147bad3 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -4,6 +4,7 @@ version: 0.1.0 readme: README.md authors: - Jan Christian Grünhage +- Emmanouil Kampitakis description: roles and modules for managing a matrix.org deployment license: - AGPL-3.0-only