--- name: azion-install-the-upstash-waiting-room-integration description: >- Install Upstash Waiting Room from Azion Marketplace and run it on a firewall to queue visitors when traffic surges past your site's capacity. --- # Install the Upstash Waiting Room integration You install the Upstash Waiting Room integration from Azion Marketplace and run it on a [Firewall](/en/documentation/platform/firewall/), from Azion Console. The integration manages traffic surges and prevents overload on your websites and applications. It creates a waiting room that controls and redirects access according to your parameters, with a First-In, First-Out (FIFO) approach. Five objects have to exist before a request is queued: the installed function, a firewall carrying the **Functions** module, a function instance holding the arguments, a Rules Engine rule with the **Run Function** behavior, and a workload deployment bound to the firewall. Each section below creates one of them. --- ## Prerequisites - An Azion account. To sign in, refer to [How to access Azion Console](/en/documentation/guides/platform/account-and-billing/how-to-access-azion-console/). - An application served by a [workload](/en/documentation/platform/workloads/), whose deployment you bind to the firewall in the last section. - An [Upstash account](https://console.upstash.com/). - A Global Database, created in the [Upstash Console](https://console.upstash.com/). Its URL and its token are arguments of the function instance. - The [Azion CLI](/en/documentation/devtools/cli/) installed and authorized, for the last section. - Turning on a product or a module can generate usage costs. For more information, refer to [Pricing](/en/documentation/fundamentals/pricing/). --- ## Install the integration The function is installed once per account. To install it: 1. **Open Marketplace** Access [Azion Console](https://console.azion.com/) > **Marketplace**. 2. **Find the integration** Enter `Upstash Waiting Room` in the **Search on Marketplace** field, then select the integration's card. Browsing the cards and the categories reaches the same page. 3. **Select Install** The card shows `Successfully installed!` and `Latest version installed!`, and the function appears in the **Function** list of the **Create Instance** drawer. --- ## Create the firewall The firewall is where the function is instanced and where the rule that runs it lives. To create one: 1. **Open the Firewalls page** Access [Azion Console](https://console.azion.com/) > **Firewalls**, then create a firewall. 2. **Name the firewall** In the **General** section, enter a **Name**. For example: `waiting-room-firewall`. 3. **Turn on the Functions module** In the **Modules** section, turn on the **Functions** switch. 4. **Save the firewall** The firewall shows a **Functions Instances** tab while the **Functions** module stays on. To use an existing firewall instead, turn on its **Functions** module and save it. For every setting on this form, refer to [Set a firewall's main settings](/en/documentation/guides/application-security/firewall-and-waf/firewall-configure-main-settings/). --- ## Create the function instance The instance holds your Upstash credentials and the capacity of your site. To create it: 1. **Open the Functions Instances tab** In **Firewalls**, select your firewall, then select the **Functions Instances** tab. 2. **Select + Function** A firewall that has no instance shows the same action as **Function Instance**. The **Create Instance** drawer opens. 3. **Name the instance** In **Name**, enter a name. For example: `upstash-waiting-room`. 4. **Select the installed function** In **Function**, select the Upstash Waiting Room function. The list holds only the functions that run on a firewall. 5. **Enter the arguments** In **Arguments**, the editor is prefilled with the integration's default arguments in JSON. Enter your Upstash credentials and your variables, as the next section describes. 6. **Select Save** The instance is listed in the **Functions Instances** tab. ### Arguments The instance takes your Upstash credentials and your variables: ```json { "url": "https://region-database.upstash.io", "token": "YourUpstashToken", "ttl": 10, "ttl_wait": 180, "capacity": 2 } ``` | Variable | Required | Description | | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `url` | Yes | The URL string that connects to Upstash Redis. In your Upstash Console, copy the `UPSTASH_REDIS_REST_URL` from your database page | | `token` | Yes | The token that accesses the Upstash Redis database. In your Upstash Console, copy the `UPSTASH_REDIS_REST_TOKEN` from your database page | | `ttl` | Yes | The maximum time, in seconds, a user can stay on your website. Example: `180` | | `ttl_wait` | Yes | The maximum time, in seconds, a user can stay inactive in the waiting room without losing their place, for example after closing the tab or window of the site. Example: `180` | | `capacity` | Yes | The maximum number of simultaneous connections allowed on your website. Example: `10` | --- ## Create the rule The instance queues nothing until a rule runs it. A [Rules Engine for Firewall](/en/documentation/platform/firewall/rules-engine/) rule selects the requests that reach the instance, through a **Run Function** behavior. To create the rule: 1. **Open the Rules Engine tab** In **Firewalls**, select your firewall, then select the **Rules Engine** tab. 2. **Select + Rule** 3. **Name the rule** In **Name**, enter a name. For example: `Run Upstash Waiting Room`. 4. **Set the criterion** In the **Criteria** section, select the domains that run the integration. For example: if `Host` *matches* `yourdomain.com`. 5. **Add the Run Function behavior** In the **Behaviors** section, select **Run Function**, then select the instance by the name you gave it. 6. **Select Save** The firewall runs the instance on every request to the domain in the criterion. --- ## Bind the firewall to the workload The binding is on the workload's deployment, so create a deployment that names both the application and the firewall: ```bash azion create workload-deployment --workload-id --name \ --application-id --firewall-id --strategy-type default \ --active true --current true ``` The command prints the id of the new deployment: ```text Created Workload Deployment with ID 123456 ``` Requests to the workload's domain reach the firewall, and the rule runs the Upstash Waiting Room instance on each one. --- ## How it works When your website receives a request, the firewall runs the integration. The integration checks whether there is space available: - If there is space, the integration moves the request from the waiting queue to the release queue. - If there is no space, the integration redirects the request to the waiting room, where it receives a number in the queue. --- ## Monitor the waiting room You can monitor the activity of the waiting room in the Upstash Dashboard. --- ## Next steps - [Marketplace integrations](/en/documentation/platform/marketplace/integrations.md): Every integration Azion Marketplace offers, and where each one runs. - [Rules Engine for Firewall](/en/documentation/platform/firewall/rules-engine.md): Every criterion and behavior a firewall rule accepts. - [Update an integration](/en/documentation/guides/application-development/integrations/update-an-integration.md): Move an installed integration to its latest version.