Code With Me Enterprise

Prerequisites

Before enabling the Code With Me Enterprise component on the Toolbox Enterprise Server, make sure the following prerequisites are met:

You have purchased a license for running Code With Me sessions with Toolbox Enterprise.
You have a deployed relay server that can be accessed from developer machines.
You have an ECDSA private key without any passphrase to prevent unauthorized access to the relay server.
An ECDSA private key file is 384-bit, the file format is PEM. You can generate such a file with OpenSSL.
Example:
openssl ecparam -name secp384r1 -genkey -noout -out lobby/lobby_private.pem openssl ec -in lobby/lobby_private.pem -pubout -out relay/lobby_public.pem
For security purposes, it is recommended to use your license and private key secretly. For more details, refer to Secrets.
You have checked that your Toolbox Enterprise Server functions without Code With Me Enterprise enabled.
(Optional) You have a STUN server hosted either inside your network or using a public service, such as Google, to prevent the IP address leakage.
You can use Coturn as a STUN server.

Enable the Code With Me functionality

When all the prerequisites are met, add the following parameters to your application.yaml file and provide values for them:

            cwm:
              lobby:
                enabled: true
                session-base-url: "https://TBE_SERVER_HOSTNAME"
                license-bundles:
                  # Keep private! Do not share anywhere
                  license1: |-
                     YOUR LICENSE GOES HERE
                # Keep private! Do not share anywhere
                relay-config: |
                  {
                    "stunTurnServers": [
                      {
                        "uri": "stun:stun.l.google.com:PORT"
                      },
                      {
                        "uri": "STUN_SERVER_HOSTNAME"
                      }
                    ],
                    "relays": [
                      {
                        "regionName": "region1",
                        "latitude": 0,
                        "longitude": 0,
                        "servers": [
                          "wss://RELAY_SERVER_HOSTNAME"
                        ]
                      }
                    ]
                  }
                # Keep private! Do not share anywhere
                relay-ecdsa-key: |-
                  -----BEGIN EC PRIVATE KEY-----
                PRIVATE KEY FROM PREREQUISITE 2
                  -----END EC PRIVATE KEY-----

                    session-base-url: '${tbe.deployment.url}/code-with-me'
        

Reference: Code With Me configuration parameters

cwm.lobby.enabled

Enables the Code With Me Enterprise component in Toolbox Enterprise.

cwm.lobby.license-bundles.license1

Specify your Code With Me Enterprise license as a value.

cwm.lobby.relay-config

Specify the relay server configuration.

cwm.lobby.relay-ecdsa-key

Specify your ECDSA private key without any passphrase to prevent unauthorized access to a relay server.

The length of the ECDSA private key file is 384-bit. The format of this file is PEM, and the file can be generated with OpenSSL.

cwm.lobby.session-base-url

Specify your session base URL.

Once you've provided the necessary configuration parameters, you can start the Toolbox Enterprise Server.

Last modified: 16 April 2024