Command line admin tool for Synapse (the Matrix reference homeserver)
GPL-3.0 License
Bot releases are visible (Hide)
Published by github-actions[bot] almost 3 years ago
synadm room list
, as requested in issue #25synadm media list
synadm user media
--datetime/--timestamp
in synadm regtok list
command streamlined to shortform options --dt/--ts
synadm room resolve
, contributed by @MacLemonsynadm user prune-devices
as requested in issue #44, contributed by @nemobissynadm config
command to readthedocs commmands reference.Published by github-actions[bot] about 3 years ago
media delete
command: Automatically retrieve local server name via Matrix APImedia quarantine
command: Automatically retrieve local server name via Matrix APIregtok
, contributed by @govynnusmatrix
subcommand added to readthedocs CLI referenceroom delete
command: Replace deprecated post with delete methodPublished by github-actions[bot] over 3 years ago
synadm
finally got some nicely rendered documentation pages hosted at https://synadm.readthedocs.io.
"Login as a user" admin API support:
synadm user login <user id>
New subcommand matrix
supporting execution of regular Matrix commands. As a first shot a command to issue any Matrix API call has been implemented:
synadm matrix raw endpoint/url -m post -f data.json
synadm matrix raw endpoint/url -m put -d '{"key1": "value1"}' --prompt
Note that this is ment to be a convenience function in case a Synapse homeserver admin wants to quickly help users e.g set specific settings available via regular Matrix calls and not the Synapse admin API directly. Also note that it is not ment to replace the awesome Matrix CLI tools that are already out there. matrix-commander, matrixcli to mention just a few.
The second command below matrix
is:
synadm matrix login <user id>
It implements a plain login on a Matrix server using username and password. It can even be used to retrieve a token for an admin user, e.g helpful for setting up fresh synadm
installations. Read about it here
The README has been updated to point to the nicely rendered docs recently published at https://matrix-org.github.io/synapse/develop/usage/administration/admin_api/index.html
Update via PyPI or git as described in the update chapter: https://github.com/JOJ0/synadm#update
Thanks to the friendly people in #synadm:peek-a-boo.at for reviewing, testing, discussing functionality and giving advice. And for this release, a special thanks to @hpd:hpdeifel.de
@hpdeifel
Published by github-actions[bot] over 3 years ago
synadm media ...
commands changed option --days
to --before-days
(streamlining options with history purge command)synadm history purge <room id>
synadm history purge-status <purge id>
pip install synadm
Published by github-actions[bot] over 3 years ago
synadm user modify
commandsynadm media list <room id>
command changed to synadm media list -r <room id>
synadm user media <user id>
command (also available as synadm media list -u <user id>
), thanks to @bubu for the draftgit pull; python setup.py install
and make sure dependency click-option-group was updated to version 0.5.2 (check with pip list
)Published by JOJ0 over 3 years ago
7 new commands and 7 other new features makes this release number 0.13+0.14=0.27 :-)
Published by JOJ0 almost 4 years ago
Full implementation of rooms API (https://github.com/matrix-org/synapse/blob/master/docs/admin_api/rooms.md) and user admin API (https://github.com/matrix-org/synapse/blob/master/docs/admin_api/rooms.md) is done - this is worth a release tag - 13 available commands makes v0.13 :-)
Find installation and usage instructions here: https://github.com/JOJ0/synadm
Catch me on #synadm:peek-a-boo.at or #matrix-dev:matrix.org for feedback and support. Thanks!