ansible-collection-famedly-.../README.md

# Ansible Collection - famedly.matrix

## 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\_member**: Ensures room memberships are correct.
 - **matrix\_signing\_key**: Creates a server signing key.
 - **synapse\_register**: Registers a user using synapse's admin API.

You can find more information and a sample playbook for these modules in the
README in `./plugins/modules/`

## 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.
initial commit 2020-08-01 17:24:50 +00:00			`# Ansible Collection - famedly.matrix`

docs: add README for collection 2020-08-10 09:40:58 +00:00			`## 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.`
docs(modules): improve module documentation 2020-10-03 01:02:10 +00:00			`- matrix\_member: Ensures room memberships are correct.`
docs: add README for collection 2020-08-10 09:40:58 +00:00			`- matrix\_signing\_key: Creates a server signing key.`
feat(modules): add synapse_register module This module uses synapse's admin API to register users. It requires the registration shared secret from synapse's config, and allows creating admin users too. 2020-10-09 14:33:49 +00:00			`- synapse\_register: Registers a user using synapse's admin API.`
docs: add README for collection 2020-08-10 09:40:58 +00:00
docs(modules): improve module documentation 2020-10-03 01:02:10 +00:00			`You can find more information and a sample playbook for these modules in the`
			README in `./plugins/modules/`

docs: add README for collection 2020-08-10 09:40:58 +00:00			`## 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.`