diff --git a/doc/openapi/components/schemas/config/nodes/webrtc.yaml b/doc/openapi/components/schemas/config/nodes/webrtc.yaml index f8ebc9982..1b2d94229 100644 --- a/doc/openapi/components/schemas/config/nodes/webrtc.yaml +++ b/doc/openapi/components/schemas/config/nodes/webrtc.yaml @@ -7,11 +7,11 @@ allOf: format: $ref: ../format_spec.yaml - wait: - type: boolean - default: true + wait_seconds: + type: integer + default: 0 description: | - Suspend start-up of VILLASnode until the connection with the remote peer has been established. + Suspend start-up of VILLASnode for some seconds until the connection with the remote peer has been established. ordered: type: boolean @@ -47,26 +47,15 @@ allOf: description: A list of ICE servers used for connection establishment type: array items: - type: object - title: ICE Server - properties: - urls: - type: array - items: - type: string - format: uri - title: STUN/TURN URI - description: | - A valid Uniform Resource Identifier (URI) indentifying a STUN or TURN server. + type: string + format: uri + title: STUN & TURN server URI + description: | + A valid Uniform Resource Identifier (URI) identifying a STUN or TURN server. - See [RFC7064](https://datatracker.ietf.org/doc/html/rfc7064) and [RFC7065](https://datatracker.ietf.org/doc/html/rfc7065) for details. + See [RFC7064](https://datatracker.ietf.org/doc/html/rfc7064) and [RFC7065](https://datatracker.ietf.org/doc/html/rfc7065) for details. - password: - type: string - description: Password for used authentication against TURN servers. - username: - type: string - description: Username for used authentication against TURN servers. + As an extension to the URI format specified additional username & password can be specified as shown in the examples - $ref: ../node_signals.yaml - $ref: ../node.yaml diff --git a/etc/examples/nodes/webrtc.conf b/etc/examples/nodes/webrtc.conf index f587093ed..824e0a048 100644 --- a/etc/examples/nodes/webrtc.conf +++ b/etc/examples/nodes/webrtc.conf @@ -1,15 +1,35 @@ - nodes = { - webrtc = { - type = "webrtc" - # required session key. - session = "" - # optional signaling server. - server = "
" - # optional format. + webrtc_node = { + type = "webrtc", + format = "json" - # optional initial connect timeout. - wait_seconds = 120 + + # A unique session identifier which must be shared between two nodes + session = "my-session-name" + + # Address to the websocket signaling server + server = "wss://villas.k8s.eonerc.rwth-aachen.de/ws/signaling" + + # Limit the number of times a channel will retransmit data if not successfully delivered. + # This value may be clamped if it exceeds the maximum value supported. + max_retransmits = 0 + + # Number of seconds to wait for a WebRTC connection before proceeding the start + # of VILLASnode. Mainly used for testing + wait_seconds = 10 # in seconds + + # Indicates if data is allowed to be delivered out of order. + # The default value of false, does not make guarantees that data will be delivered in order. + ordered = false + + # Setting for Interactive Connectivity Establishment + ice = { + # List of STUN/TURN servers + servers = ( + "stun:stun.0l.de:3478", + "turn:villas:villas@turn.0l.de:3478?transport=udp", + "turn:villas:villas@turn.0l.de:3478?transport=tcp" + ) + } } } -