README.md 1.57 KB
Newer Older
Johannes Barthel's avatar
Johannes Barthel committed
1
2
3
4
5
6
7
8
9
10
11
12
# senfi

Tool and Rust library to access the BigBlueButton API.

## setup
* [Install Rust](https://www.rust-lang.org/learn/get-started#installing-rust) if you haven't already.
* Copy the file `.env.sample` to `.env` and adjust the values to those of your BBB server.

## subcommands
* `cargo run --bin senfi-stats`: show number of meetings, number of attendees, largest meeting size and number of active webcams
* `cargo run --bin senfi-list`: show list of all currently running meetings and participants
* `cargo run --bin senfi-get-default-config-xml`: [get the default config.xml](https://docs.bigbluebutton.org/dev/api.html#getdefaultconfigxml) from the API
Stephan Voeth's avatar
Stephan Voeth committed
13
* `cargo run --bin senfi-cancel <meeting_id>`: Cancel the meeting with specified `meeting_id` (not the name, not the internal ID). A user called "senfbot" will appear in the meeting's chat and announce the shutdown, which will happen five seconds later.
14
15
16
17
18
* `cargo run --bin senfi-broadcast "hi everyone"`: send chat message to every meeting on the server.

## using as library
To use senfi as a library, add the following line to your `Cargo.toml` file:
```toml
19
senfi = { git = "https://gitlab.senfcall.de/senfcall-public/senfi.git", rev = "v0.1.9" }
20
21
22
23
24
25
26
```
You can depend on a specific tag or git commit using the `tag` or `rev` attributes, respectively (see the [Cargo book](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies-from-git-repositories) for details).

Note that the library is called `bbb_api`, so to use to instantiate an API handle, use
```rust
let api = bbb_api::BbbApi::from_bbbconf()?;
```