A Matrix Synapse administration tool written in bash. Better than typing curl requests! #axon:matrix.thisisjoes.site
Go to file
Joe 00d62d6f88
revert change to event reports output formatting
2024-02-28 21:35:35 -06:00
src revert change to event reports output formatting 2024-02-28 21:35:35 -06:00
utils update provided linac 2022-11-18 03:02:49 -06:00
.drone.yml [ci] add gpg key passphrase to drone release pipeline 2023-09-24 18:40:24 -05:00
.gitignore initial commit 2021-04-05 08:11:39 -05:00
LICENSE initial commit 2021-04-05 08:11:39 -05:00
README.md explain project status in readme 2024-02-28 19:03:40 -06:00
axon.sh.build update build file 2023-01-12 07:47:21 -06:00
axon.sh.info bump version 2023-11-19 10:40:19 -06:00

README.md

axon.sh

License Latest Release

A Matrix Synapse administration tool written in bash. In early development, but works pretty well!

Project status

Due partly to a lack of interest from the wider homeserver admin community axon.sh's development has significantly slowed. The program does basically everything I personally need it to do to administrate my homeservers. Pull requests and issues are still welcome, but barring specific feature requests or contributions, axon.sh will likely never completely support Synapse's admin API.

Supported operations

Session management

  • logging in with username and password
  • homeserver discovery using '.well-known' files
  • logging out and invalidating session

Homeserver operations

  • getting server version information
  • getting event reports
  • sending server notices

Federation operations

  • getting details about federation destination
  • resetting the connection timeout for federation destination

Room operations

  • resolving room aliases
  • creating room aliases
  • deleting room aliases
  • purging room history
  • deleting and blocking rooms
  • getting details about forward extremities
  • deleting forward extremities

User operations

  • getting list of joined rooms for user
  • looking up user by third-party ID (3PID)
  • resetting password for user
  • creating new users
  • deactivating users
  • shadowbanning users
  • managing ratelimits for users

How to use

building

This project uses LINAC. To use the provided version of LINAC to build axon.sh, do ./utils/linac build axon.sh.build.

running

Invoke like any other bash script, e.g. bash build/axon.sh

using

Type help at the axon.sh prompt for builtin help. You will probably want to login first.