# BigBlueButton REST API command-line client
This is a small but useful command-line client for controlling meetings and recordings on a [BigBlueButton](https://docs.bigbluebutton.org/) server or cluster directly via the [REST API](https://docs.bigbluebutton.org/dev/api.html). It allows administrators to bypass front-end applications ([greenlight](https://github.com/bigbluebutton/greenlight), [moodle](https://moodle.com/certified-integrations/bigbluebutton/) or alternatives) and directly access the backing BBB servers for administrative tasks, monitoring or testing.
The module can also be imported as a python library, but please note that this project is not yet considered stable in any way. A stable and more usable API for python scripting might follow.
## Install
```sh
# Install via pip
sudo pip install -U bbbctl
# or manually:
sudo curl -L https://raw.githubusercontent.com/defnull/bbbctl/master/src/bbbctl.py -o /usr/local/bin/bbbctl
sudo chmod +x /usr/local/bin/bbbctl
```
## Usage
```sh
# Only required for external BBB servers:
export BBBCTL_SERVER="https://bbb.example.com/"
export BBBCTL_SECRET="..."
bbbctl meeting list # Test your secret by listing current meetings
bbbctl -h # Print help for a list of commands
```
If run directly on a BBB server with sufficient permissions, server URL and secret will be fetched from local BBB config files automatically.
## Command overview
You can get detailed help and a list of all parameters with `bbbctl -h` or `bbbctl <command> -h`.
- `meeting` Create, list, join, inspect or end meetings
- `list` List all meetings
- `info <meetingID>` Show info about a meeting
- `create <meetingID> <title>` Create a new meeting
- `join <meetingID> <displayName>` Generate join links
- `end <meetingID>` Forcefully end a meeting
- `nuke` Forcefully end ALL meetings (be careful)
- `record` Work with recordings
- `list` List all recordings
- `info <recordID>` Show info about a recording
- `publish <recordID>` Publish an unpublished recording
- `unpublish <recordID>` Unpublish (hide) recording)
- `delete <recordID>` Delete a recording (be careful)
## Output format
The default output format is a human readable plain text format. You can switch to a more compact version with `--format=compact`. Other formats that are better suited for scripted usage are also supported: `json`, `jsonline` or `xml`
# License
Copyright (c) 2020-2022, Marcel Hellkamp.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
Raw data
{
"_id": null,
"home_page": "https://github.com/defnull/bbbctl",
"name": "bbbctl",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Marcel Hellkamp",
"author_email": "marc@gsites.de",
"download_url": "https://files.pythonhosted.org/packages/07/27/2cb301735fa738d3a2e44428f2f79b0d5220201670cb4715b0faac59acb3/bbbctl-0.3.0.tar.gz",
"platform": null,
"description": "# BigBlueButton REST API command-line client\n\nThis is a small but useful command-line client for controlling meetings and recordings on a [BigBlueButton](https://docs.bigbluebutton.org/) server or cluster directly via the [REST API](https://docs.bigbluebutton.org/dev/api.html). It allows administrators to bypass front-end applications ([greenlight](https://github.com/bigbluebutton/greenlight), [moodle](https://moodle.com/certified-integrations/bigbluebutton/) or alternatives) and directly access the backing BBB servers for administrative tasks, monitoring or testing.\n\nThe module can also be imported as a python library, but please note that this project is not yet considered stable in any way. A stable and more usable API for python scripting might follow.\n\n## Install\n\n```sh\n# Install via pip\nsudo pip install -U bbbctl\n# or manually:\nsudo curl -L https://raw.githubusercontent.com/defnull/bbbctl/master/src/bbbctl.py -o /usr/local/bin/bbbctl\nsudo chmod +x /usr/local/bin/bbbctl\n```\n\n## Usage\n\n```sh\n# Only required for external BBB servers:\nexport BBBCTL_SERVER=\"https://bbb.example.com/\"\nexport BBBCTL_SECRET=\"...\"\n\nbbbctl meeting list # Test your secret by listing current meetings\nbbbctl -h # Print help for a list of commands\n```\n\nIf run directly on a BBB server with sufficient permissions, server URL and secret will be fetched from local BBB config files automatically.\n\n## Command overview\n\nYou can get detailed help and a list of all parameters with `bbbctl -h` or `bbbctl <command> -h`.\n\n- `meeting` Create, list, join, inspect or end meetings\n - `list` List all meetings\n - `info <meetingID>` Show info about a meeting\n - `create <meetingID> <title>` Create a new meeting\n - `join <meetingID> <displayName>` Generate join links\n - `end <meetingID>` Forcefully end a meeting\n - `nuke` Forcefully end ALL meetings (be careful)\n- `record` Work with recordings\n - `list` List all recordings\n - `info <recordID>` Show info about a recording\n - `publish <recordID>` Publish an unpublished recording\n - `unpublish <recordID>` Unpublish (hide) recording)\n - `delete <recordID>` Delete a recording (be careful)\n\n## Output format\n\nThe default output format is a human readable plain text format. You can switch to a more compact version with `--format=compact`. Other formats that are better suited for scripted usage are also supported: `json`, `jsonline` or `xml`\n\n# License\n\nCopyright (c) 2020-2022, Marcel Hellkamp.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n",
"bugtrack_url": null,
"license": null,
"summary": "BigBlueButton API command-line client",
"version": "0.3.0",
"project_urls": {
"Bug Tracker": "https://github.com/defnull/bbbctl/issues",
"Homepage": "https://github.com/defnull/bbbctl"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "77c0ad200c4306d8bb9d866ab2246eea8623d2267f0d63a24d10134da32766ae",
"md5": "9a9a2b6ff8e1c85c3167c06e59008407",
"sha256": "46a2343ec2bff4fca11953ccc2d9d87794bd2012c9908790575ddae42d7d2cd3"
},
"downloads": -1,
"filename": "bbbctl-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9a9a2b6ff8e1c85c3167c06e59008407",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 7563,
"upload_time": "2024-12-12T16:09:20",
"upload_time_iso_8601": "2024-12-12T16:09:20.446173Z",
"url": "https://files.pythonhosted.org/packages/77/c0/ad200c4306d8bb9d866ab2246eea8623d2267f0d63a24d10134da32766ae/bbbctl-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "07272cb301735fa738d3a2e44428f2f79b0d5220201670cb4715b0faac59acb3",
"md5": "b5849296d42c517a744d0da0b0fc13fb",
"sha256": "9d7c8c625643e75f4a48a5160df3c31b737371e87e3da04719dffb373ac5b19e"
},
"downloads": -1,
"filename": "bbbctl-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "b5849296d42c517a744d0da0b0fc13fb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 6730,
"upload_time": "2024-12-12T16:09:22",
"upload_time_iso_8601": "2024-12-12T16:09:22.176689Z",
"url": "https://files.pythonhosted.org/packages/07/27/2cb301735fa738d3a2e44428f2f79b0d5220201670cb4715b0faac59acb3/bbbctl-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-12 16:09:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "defnull",
"github_project": "bbbctl",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "bbbctl"
}
JSON
