Skip to content

Latest commit

 

History

History
13 lines (11 loc) · 1.16 KB

from_cirrus.md

File metadata and controls

13 lines (11 loc) · 1.16 KB

Cirrus to Wilbur Guide

This is just a small brief to describe the differences between the now deprecated cirrus signalling server and the new wilbur signalling server.

  • Configuration is handled by CLI options or the same options in a config.json
  • By default web serving is disabled but can be enabled by supplying --serve
  • Convenience scripts in platform_scripts will append --serve and try to reproduce the old cirrus.js behaviour.
  • The frontend will be placed in www instead of Public when using convenience scripts.
  • Messages are now described by protobufs in the Common library.
  • The server is built on top of the Common library which is provided as a tool for developers to build their own applications.
  • Logs from wilbur are now structured JSON so they can be easily ingested into external tools.
  • Messages sent and received are no longer echoed to the terminal by default. The --console_messages argument can control this behaviour.
  • The config.json file will not be created or recreated (if deleted), if you want the config.json to be generated based on current arguments use --save.