synadm

Improved / Changed

• Display room aliases instead of room ID's in synadm room list, as requested in issue #25
• Several commands now by default display human readable dates and times instead of UNIX epoch in ms. For scripting purposes the old behaviour can still be forced by passing option --ts (--timestamp):
  • synadm media list
  • synadm user media
• Options --datetime/--timestamp in synadm regtok list command streamlined to shortform options --dt/--ts

New

• Translate a room ID to room aliases and vice versa, new command: synadm room resolve, contributed by @MacLemon
• Cleanup abandoned sessions/devices, new command synadm user prune-devices as requested in issue #44, contributed by @nemobis

Fixed

• Activating a user without a password is now a valid use case, contributed by @andir PR #39
• Add missing synadm config command to readthedocs commmands reference.
• Streamline help texts: Always start with a capital letter.

Notes

• Check https://synadm.readthedocs.org for details on the new commands.
• Update instructions: https://github.com/JOJ0/synadm#update

Improved / Changed

• Admin token is never shown in console or file log
• media delete command: Automatically retrieve local server name via Matrix API
• media quarantine command: Automatically retrieve local server name via Matrix API
• In human output mode use tabulate plain format for displaying results that are simple dicts. Removes rather pointless dashed lines on top and bottom of output.

New

• Registration token management, new subcommand regtok, contributed by @govynnus

Fixed

• matrix subcommand added to readthedocs CLI reference
• Some english grammar fixes, contributed by @neunenak
• room delete command: Replace deprecated post with delete method

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 matrixsupporting 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

Improved / Changed

• synadm media ... commands changed option --days to --before-days (streamlining options with history purge command)
• More automation and helpers code to make releasing "small but often" a habbit.

New

• Purge history admin API support, new commands:
  • synadm history purge <room id>
  • synadm history purge-status <purge id>

Notes

• This is the first synadm release to be available on PyPI. Just pip install synadm
  https://pypi.org/project/synadm/

Improved / Changed

• Tiny improvements in help output of synadm user modify command
• Internal changes in click-contrib/option-group extension handling
• synadm media list <room id> command changed to synadm media list -r <room id>

New

• synadm user media <user id> command (also available as synadm media list -u <user id> ), thanks to @bubu for the draft
• First steps for auto-generated releases via github actions

Notes

• Upgrade using git pull; python setup.py install and make sure dependency click-option-group was updated to version 0.5.2 (check with pip list)

Improved

• Massive internal overhaul, linting, tidying up and refactoring, contributed by @kaiyou
• Improvements and fixes to README.md, contributed by @schwindp, @aaronraimist and @rht
• Output format "table" is now called "human" and decision on how the data responded by the API is best to be displayed is done much smarter, contributed by @kaiyou
• original "raw" (--raw) output format was renamed to "pprint", contributed by @kaiyou
• Configuration and defaults handling

New

• Batch mode deactivating all interactive prompts for better usage in scripts and command pipelines (–batch), contributed by @kaiyou
• HTTP timeout of API requests configurable
• Media Admin API support
• Make Room Admin API support, contributed by @rht
• Delete Group (community) API support, contributed by @aaronraimist
• Two new output formats available: yaml and json (pure unprettified json), contributed by @kaiyou
• All output formats now selectable via a single CLI switch "--output/-o" (-o json, -o yaml, -o pprint, -o human), contributed by @kaiyou
• Abbreviation of output formats using first letter of format name (-o j, -o y, -o p, -o h)
• Enable "Python requests" debugging via CLI switch (-vvv)

Fixed

• Textual Error responses of Synapse now showing in output, contributed by @rht
• Permission of config file on Posix compatible systems grants access to the current user/admin only

7 new commands and 7 other new features makes this release number 0.13+0.14=0.27 :-)

This release incorporates some security related patches:

• never state token in debug log file (~/.local/synadm/debug.log)
• or in debug console output (synadm -vv ...)
• leave a note about permission of config file (~/.config/synadm.yaml) in README

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!