Skip to main content
Git Interface

Virtual Waiting Room

Learn how to use the Virtual Waiting Room module.

Deploy​

Submit a support request by clicking the Support link in the left sidebar to have the Virtual Waiting Room module deployed.

Manage​

Manage the Virtual Waiting Room module through the Git config.

tip

Check out the related Virtual Waiting Room reference to get started with customizing your Virtual Waiting Room module.

note

Submit a support request by clicking the Support link in the left sidebar if you need help managing this module.

Quick config​

Follow the steps below to quickly configure the Virtual Waiting Room module for an environment in your project:

  1. Go to the quick config of the environment you want to quickly configure the Virtual Waiting Room module for.

  2. Configure your waiting room page and visitor count control and then click Update:

    Upload HTML​

    Paste the full HTML document you want displayed for visitors in the virtual waiting room.

    Control visitor count​

    • Virtual Waiting Room toggle: Whether the Virtual Waiting Room should be enabled.
    • Visitor Count: The number of concurrent visitors allowed before new visitors are sent to the virtual waiting room.

Delete​

Follow the steps below to delete the Virtual Waiting Room module from your environment:

  1. Go to the Git config of the environment you want to delete the Virtual Waiting Room module from.

  2. In the top of the page, copy the URL next to Clone with HTTPS.

  3. Open a terminal and change the current working directory to the location where you want the cloned environment repository.

  4. Clone the environment repository to your local computer. Type git clone followed by the copied URL and then press Enter:

    git clone <copied_url>

  5. In the root directory of the environment repository, delete the Virtual Waiting Room module directory (typically named virtualwaitingroom).

    note

    Skip this step to disable the module instead of deleting it.

  6. In the environment's section.config.json file, delete the module object from the proxychain array, which will look like the following:

    section.config.json
    ...
    "proxychain": [
        ...
        {
            "name": "<module_directory_name>",
            "image": "<module_image>"
        },
        ...
    ],
    ...
    section.config.json
    ...
    "proxychain": [
        ...
        {
            "name": "virtualwaitingroom",
            "image": "virtualwaitingroom:latest"
        },
        ...
    ],
    ...

  7. Stage, commit, and push the changes to the environment's remote repository:

    git add .
    git commit -m "Delete the Virtual Waiting Room module"
    git push