Skip to main content

Signaling Service

Introduction​

To communicate with another peer you simply need to exchange contact information and the rest will be done by WebRTC. The process of connecting to the other peers is also known as signaling.

note

Peers with different signaling address can not connect to each other.

Server Status Page​

https://status.swarmcloud.net:2083

Official Signaling Service​

Europe​

  • Germany
wss://signalcloud.swarmcloud.org
  • Russia
wss://ru.swarmcloud.org

South America​

  • Brazil
wss://br.swarmcloud.org

North America​

  • USA
wss://opensignal.swarmcloud.org

Africa​

  • South Africa
wss://za.swarmcloud.org

Asia-Pacific​

  • HongKong
wss://signal.swarmcloud.org
  • Singapore
wss://sg.swarmcloud.org
  • South Korea
wss://kr.swarmcloud.org
  • Australia
wss://au.swarmcloud.org
  • Vietnam
wss://vn.swarmcloud.org
  • United Arab Emirates
wss://ae.swarmcloud.org

Chinese Mainland​

  • Guangzhou
wss://gz.swarmcloud.net
  • Beijing
wss://pk.swarmcloud.net

Deploy by Yourself​

Deploy your own Signaling Service

Monitor Signal Server Status​

https://status.cdnbye.com

Change Signaling Address​

  • Log on Console
  • Click on the Signal Management button in the P2P Setting
  • Input your signaling address and conform

Via SDK Config​

Web SDK​

p2pConfig: {
    signalConfig: 'ws://your.signalservice.com',
    // Other p2pConfig options provided by cdnbye
}
// Pass p2pConfig to your P2PEngine ...

Android SDK​

val config = P2pConfig.Builder()
    .signalConfig("ws://your.signalservice.com")
    .build()
P2pEngine.init(ctx, YOUR_TOKEN, config)

iOS SDK​

let config = P2pConfig(
    trackerZone: .Europe,
    signalConfig: SignalConfig(mainAddr: "ws://your.signalservice.com")
)
P2pEngine.setup(token: YOUR_TOKEN, config: config)

Flutter SDK​

FlutterP2pEngine.init(
  YOUR_TOKEN,
  config: P2pConfig(
    signalConfig: 'ws://your.signalservice.com',
  )
);

React Native SDK​

initP2pEngine(YOUR_TOKEN, {
    signalConfig: 'ws://your.signalservice.com',
})

Enable Signaling Authentication​

The signaling connection authentication can be enabled to prevent unauthorized requests to your signaling server. The steps are as follows:

  • Setup authentication on config.yaml
security:
  enable: true               # Enable Authentication
  max_timestamp_age: 3600    # Timestamp expiration time in seconds
  token: YOUR_TOKEN          # Custom token, no more than 8 characters
  • Contact the official customer service to inform the signaling address and token
  • The tracker server will issue a token encrypted string to the authorized node for signaling service authentication
note

You need to setup signal address via console before enabling signaling authentication.