New
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>
- Have a look at the new command's docs
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
- The new command's docs
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>
- The new command's docs
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
Improved
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
Notes
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