The echo module is used for connectivity checks. When a client sends a Ping command, the module responds with a Pong event.

OpenTalk RoomServer

This project contains the crates that implement the OpenTalk RoomServer.

• OpenTalk RoomServer – The crate which produces the actual RoomServer executable
• OpenTalk RoomServer Common – Types that are shared between the OpenTalk RoomServer and Signaling Modules
• OpenTalk RoomServer Client – HTTP-Client which can be used to communicate with the OpenTalk RoomServer using the OpenTalk RoomServer Web API
• OpenTalk RoomServer Types – Types that are send over the wire. These types are used in the HTTP-API and used in both the RoomServer-Client and RoomServer-Web-API.
• OpenTalk RoomServer Web API – HTTP-API endpoints written with Axum. This crate defines the API but does not implement any logic. All requests are forwarded to trait implementations.
• OpenTalk RoomServer Signaling – This crate contains types required by signaling modules. Most prominently the SignalingModule trait.

Developer UI

The RoomServer DUI is used to debug the signaling interface.

You can execute it using:

just run-dui

Typst Packages

Some modules require the linguify typst package for localized report generation. This package is included in the container of the RoomServer. For some tests, it is also necessary to have this package present locally. It can be obtained/updated by running just install-latest-typst-packages.

Documentation

Documentation for the RoomServer is build in the unified documentation project. The content is copied from <roomserver-project-root>/docs and placed in the documentation project automatically.

Copy files outside of docs/

The documentation contains verbatim copies of files outside the docs/ folder (e.g. examples/roomserver.toml). The ci-docs-updater is used to ensure that the documentation stays in sync with the original files.

You can update the documentation running:

just update-docs