Mirrors/ansible-collection-famedly-matrix

mirror of https://github.com/famedly/ansible-collection-matrix synced 2024-09-20 05:51:57 +00:00

No description

Find a file

Jan Christian Grünhage 45b4aa85b4 fix(matrix_token_login): fix regression in required module args `52785ab768` refactored required and mutually exclusive module parameters and meanwhile dropped some arguments required for our matrix_token_login module. The change made sense for most of our modules, but the matrix_token_login as the only one doesn't need token or password, but definitely needs a key.		2022-08-10 18:32:05 +02:00
playbooks	feat(hedwig): add generic playbook	2022-06-20 22:34:42 +02:00
plugins	fix(matrix_token_login): fix regression in required module args	2022-08-10 18:32:05 +02:00
roles	update(element): bump unstable version to 1.11.3-rc.1	2022-08-09 21:45:09 +02:00
tests/sanity	feat: Add ansible-test and refactor plugins	2022-07-29 10:50:14 +02:00
.editorconfig	Make the ansible linter happy	2019-02-18 00:27:45 +01:00
.gitignore	chore: ignore ansible test output in git	2022-08-10 18:32:05 +02:00
.gitlab-ci.yml	fix(ci): try and set ANSIBLE_VERSION explicitely	2022-08-10 07:09:00 +02:00
CHANGELOG.md	feat(ttbot): add timetracking bot role	2020-12-16 10:22:36 +00:00
CODEOWNERS	feat(synapse_ratelimit): add initial module	2021-06-02 13:25:25 +02:00
galaxy.yml	chore: bump version to 0.2.2 and update changelog	2020-11-18 22:37:43 +01:00
LICENSE.md	add README, LICENSE and CODEOWNER	2020-02-14 01:49:48 +01:00
README.md	chore: mark panopticon+sygnal roles as unmaintained	2021-10-26 11:15:15 +02:00
requirements.txt	feat: Add ansible-test and refactor plugins	2022-07-29 10:50:14 +02:00

README.md

Ansible Collection - `famedly.matrix`

Modules

This collection contains modules for managing matrix rooms and more via ansible. They can modify room membership, aliases, server signing keys and even send messages into rooms from within ansible.

matrix_login (source): Create an access token for a matrix account.
matrix_login (source): Create an access token for a matrix account. Logs in with user and password to obtain a matrix access token
matrix_uia_login (source): Logs in with user and password to obtain a matrix access token, while implementing user-interactive authentication on the _matrix/client/r0/login endpoint (see MSC2835).
matrix_logout (source): Invalidates an access token.
matrix_notification (source): Sends a message to a matrix room.
matrix_room (source): Idempotently joins/creates a room with a given alias.
matrix_state (source): Can be used to set matrix state events to a room.
matrix_member (source): Can be used to manipulate matrix room membership.
matrix_signing_key (source): Creates a server signing key.
synapse_register (source): Registers a user using synapse's admin API.
synapse_ratelimit (source): Gets / Sets / Deletes a (local) users ratelimits

For more information on how to use the modules to manage matrix rooms via ansible, the README in ./plugins/modules/ provides more detailed information and an example playbook.

Roles

In addition to the modules, this role also contains a few roles for deploying commonly used matrix services:

synapse: synapse, a reference matrix homeserver implementation in python, maintained mostly by element.
element: element-web, a reference matrix client implementation, able to run in the browser, maintained by element.
hedwig: Hedwig, a push-gateway server alternative to sygnal, developed by Famedly.
barad-dur: Barad-dûr, a matrix phone-home stats collector alternative, developed by Famedly.

Unmaintained roles

sygnal: reference implementation of a matrix push gateway, unmaintained and no longer in use
panopticon: matrix phone-home stats collector, created by element, role unmaintained

README.md

Ansible Collection - famedly.matrix

Modules

Roles

Unmaintained roles

Ansible Collection - `famedly.matrix`