Controls a synapse oci-container instance via ansible
Project description
MatrixCtl
MatrixCtl is a python program to control, manage, provision and deploy our matrix homeserver. I had a bunch of shell scripts doing that. Two weeks after using them I couldn't remember the order in which I have to use the arguments. It was a pain. So I decided I hack something together fast.
It is not the most elegant piece of software I wrote, but it should do the trick for now. I will continue to port the rest of the scripts. Maybe it is also useful for someone else.
# matrixctl
usage: matrixctl [-h] [--version] [-d] {adduser,list-users,deluser,deploy,update,maintainance} ...
positional arguments:
{adduser,list-users,deluser,deploy,update,maintainance}
adduser Add a user
list-users Lists users
deluser Deletes a user
deploy Provision and deploy
update Updates the ansible repo
maintainance Run Maintainance tasks
optional arguments:
-h, --help show this help message and exit
--version show program's version number and exit
-d, --debug Enables debugging mode.
Configuration File
To use this program you need to have this config file in "/etc/matrixctl/config" or in "~/.config/matrixctl/config".
[ANSIBLE]
# The absolute path to the fully configured matrix-docker-ansible-deploy
# playbook.
MatrixDockerAnsibleDeployPath="/absolut/path/to/matrix-docker-ansible-deploy"
[SERVER]
# If you have your own playbook, to provision your matrix server, you can
# fill out the server section. matrixctl will run it before the
# matrix-docker-ansible-deploy playbook.
# AnsibleCfg="/absolut/path/to/ansible.cfg"
# AnsiblePlaybook="/absolut/path/to/site.yml"
# AnsibleTags="MyTag,MyOtherTag"
[API]
# If your matrix server is deployed, you may want to fill out the API section.
# It enables matrixctl to run more and faster commands. You can deploy and
# provision your Server without this section. You also can cerate a user with
# "matrixctl adduser --ansible YourUsername" and add your privileges after
# that.
# Domain="domain.tld"
# Token="MyMatrixToken"
License
Copyright © 2020 Michael Sasser Info@MichaelSasser.org. Released under the GPLv3 license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for matrixctl-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f03ea2871c0c9ba256b254ad8a7086ff60849683677e5843762b8080615f43b7 |
|
MD5 | bd2429d8dee12f6ad30c4e221811adcc |
|
BLAKE2b-256 | 5fe29bd542afb817fc46fb34db6c1d74d9af3b85655725fc3c9eec2c013022d3 |