Skip to main content


The #OpenTalk backend services are lacking technical documentation for administrators. This is being addressed by the backend team, we started working on an administration guide for the opentalk-controller service. Still far from complete, but you can take a first look into the contents. You will find lots of contruction site signs, for now, but some sections have useful content such as Configuration, HTTP Server, Command-Line usage, or Execution of maintenance jobs. https://gitlab.opencode.de/opentalk/controller/-/blob/main/docs/admin/README.md
We have some command-line help outputs as well as an example configuration file included in the documentation. In order to prevent these from becoming outdated, we addad a small #RustLang binary crate that updates marked sections in the markdown file. A CI job fails whenever the generated files differ from what is found in the git repository, so the devs are notified about the need to update the documentation in these places. https://gitlab.opencode.de/opentalk/controller/-/tree/main/crates/ci-doc-updater #OpenTalk
This entry was edited (1 year ago)