https://github.com/glimesh/janus-ftl-orchestrator
A service used to manage multiple instances of janus-ftl-plugin for use at scale.
https://github.com/glimesh/janus-ftl-orchestrator
Last synced: 5 months ago
JSON representation
A service used to manage multiple instances of janus-ftl-plugin for use at scale.
- Host: GitHub
- URL: https://github.com/glimesh/janus-ftl-orchestrator
- Owner: Glimesh
- License: agpl-3.0
- Created: 2020-10-18T00:38:25.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-09-23T20:58:28.000Z (over 2 years ago)
- Last Synced: 2024-10-30T16:04:21.389Z (7 months ago)
- Language: C++
- Size: 104 KB
- Stars: 15
- Watchers: 7
- Forks: 3
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Janus FTL Orchestrator
This is a work-in-progress service meant to manage multiple instances of [Janus](https://github.com/meetecho/janus-gateway) running the [Janus FTL Plugin](https://github.com/Glimesh/janus-ftl-plugin).
By orchestrating many Janus instances with this service, load from ingest and viewers can be distributed and greater scale can be achieved.
These are early days, so we're still in the process of standing up the architecture and establishing basic connections.
# Protocol
Please see [PROTOCOL.md](/docs/PROTOCOL.md)
# Dependencies
These are available in Ubuntu's package repos:
- `openssl`
# Building
```sh
meson build/
ninja -C build/
```
# Running
After building, you can fire up `janus-ftl-orchestrator` and connect to it with a pre-shared key using an openssl test client utility.
### Server
```sh
./build/janus-ftl-orchestrator
```
### OpenSSL Test Client
This command provides the default pre-shared key with the `-psk` flag. If you decide to set your own PSK with the `FTL_ORCHESTRATOR_PSK` env var, just provide the same one here.
```sh
openssl s_client -connect 127.0.0.1:8085 -psk 000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f -tls1_3 -ciphersuites TLS_AES_128_GCM_SHA256
```
After you connect, you can send arbitrary ASCII messages and see them reflected on the server. To gracefully disconnect, just type `Q` followed by a line break.
# Configuration
Configuration is achieved through environment variables.
| Environment Variable | Supported Values | Notes |
| :--------------------- | :--------------- | :---------------- |
| `FTL_ORCHESTRATOR_PSK` | String of arbitrary hex values (ex. `001122334455ff`) | This is the pre-shared key used to establish a secure TLS1.3 connection. |
# Dockering
docker build -t ftl-orchestrator
docker run --rm --env FTL_ORCHESTRATOR_PSK=001122334455ff ftl-orchestrator
# Testing
Tests are written with the help of [Catch2](https://github.com/catchorg/Catch2) and are located in the `test/` directory. They are built into the `janus-ftl-orchestrator-test` binary.
```sh
./build/janus-ftl-orchestrator-test
```