README.txt 1.2 KB

123456789101112131415
  1. How to use files in this directory:
  2. - Files with .ps1 extension can be run with PowerShell[.exe] in Windows. Powershell needs to be started as Administrator to run setup.ps1 so it can run installation / installation check steps;
  3. - Run .\setup.bat to automatically install all required dependencies for your operating system. Note that .\setup.bat is called from every script designed to run;
  4. - Run a local instance of the Cirrus server by using the .\run_local.ps1 script;
  5. - Use the following scripts to run locally or on your cloud instance (note that TURN server is not expected to work locally due to the nature of its application):
  6. - Start_SignallingServer.ps1 - start only the Signalling (STUN) server;
  7. - Start_TURNServer.ps1 - start only the TURN server;
  8. - Start_WithTURN_SignallingServer.ps1 - start a TURN server and the Cirrus server together;
  9. Tips:
  10. - The Start_Common.ps1 file contains shared functions for other Start_*.ps1 scripts and it is not supposed to run alone.
  11. - The local/cloud Start_*.ps1 powershell scripts can be invoked with the --help command line option to see how those can be configured. The following options can be supplied: --publicip, --turn, --stun. Please read the --help.