How to install the Upstash Waiting Room integration through Azion Marketplace

Upstash Waiting Room is an integration that helps you manage traffic surges and prevent overload on your websites and applications. The integration uses a First-In, First-Out (FIFO) approach and leverages on Azion Edge Firewall, creating a waiting room to control and redirect access according to your parameters.

When a request is received by your website, Edge Firewall executes the integration. Then, the integration verifies if there’s available space and moves the request from the waiting queue to the release queue. If there isn’t availability, the request is redirected to the waiting room, receiving a number in the row to access.

Requirements

To start using this integration, you need to:

Create an Upstash account.
Create a Global Database for the best available edge latency in the Upstash Console.

Getting the integration

To install this integration:

Access Azion Console > Marketplace.
On the Marketplace homepage, select the Upstash Waiting Room card.
On the integration page, click the Install button.

You’ll see a message indicating that your integration was successfully installed.

Configuring the integration

Once you’ve installed the Upstash Waiting Room integration, you’ll need to complete the steps explained below to configure it.

Setting up an edge firewall

Follow the steps:

On the upper-left corner, open the Products menu and select Edge Firewall in the Secure section.
Click the + Edge Firewall button.
Give an easy-to-remember name to your edge firewall.
Turn the Edge Functions switch on.
Click the Save button.

Done. Now you’ve instantiated the edge firewall for your function and have access to edge functions on your edge firewall.

Setting up the Edge Firewall function

While still on the Edge Firewall page:

Select the Functions Instances tab.
Click the + Function Instance button.
Give an easy-to-remember name to your instance.
On the dropdown menu, select the Upstash Waiting Room function.
In the Arguments box, you’ll pass your Upstash credentials and your variables:

{ "url": "https://region-database.upstash.io", "token": "YourUpstashToken", "ttl": 10, "ttl_wait": 180, "capacity": 2
}

Where:

Variable	Mandatory	Description
`url`	Yes	URL string to connect on Upstash Redis. Go to your Upstash Console and copy the `UPSTASH_REDIS_REST_URL` in your database page
`token`	Yes	Token to access the Upstash Redis database. Go to your Upstash Console and copy the `UPSTASH_REDIS_REST_TOKEN` in your database page
`ttl`	Yes	Maximum time, in seconds, a user can stay on your website. Example: `180`
`ttl_wait`	Yes	Maximum time, in seconds, a user can remain inactive in the waiting room (for example, by closing the tab/window of the site) without losing their place. Example: `180`
`capacity`	Yes	Maximum number of simultaneous connections allowed on your website. Example: `10`

Click the Save button.

Select the Functions tab.
Click the Add Function button.
Give an easy-to-remember name to your instance.
On the dropdown menu, select the Upstash Waiting Room function.

This action will load the function, showing a form with the function’s source code and two tabs: Code and Args. By clicking on the Code tab, you’ll be able to navigate through the source code, but won’t be able to change it.

In the Args tab, you’ll pass your Upstash credentials and your variables:

{ "url": "https://region-database.upstash.io", "token": "YourUpstashToken", "ttl": 10, "ttl_wait": 180, "capacity": 2
}

Where:

Variable	Mandatory	Description
`url`	Yes	URL string to connect on Upstash Redis. Go to your Upstash Console and copy the `UPSTASH_REDIS_REST_URL` in your database page
`token`	Yes	Token to access the Upstash Redis database. Go to your Upstash Console and copy the `UPSTASH_REDIS_REST_TOKEN` in your database page
`ttl`	Yes	Maximum time, in seconds, a user can stay on your website. Example: `180`
`ttl_wait`	Yes	Maximum time, in seconds, a user can remain inactive in the waiting room (for example, by closing the tab/window of the site) without losing their place. Example: `180`
`capacity`	Yes	Maximum number of simultaneous connections allowed on your website. Example: `10`

Click the Save button.

Setting up the Rules Engine

To finish, you must set up a rule in Rules Engine to configure the criteria and the behavior to run the function.

Still in the Edge Firewall page:

Select the Rules Engine tab.
Click the + Rule Engine button.
Give a name to the rule.
Select a criteria to run and catch the domains that you want to run the integration on.

Example: if Host matches yourdomain.com.

Below, select a behavior to the criteria. In this case, it’ll be Run Function.
- Select the adequate function according to the name you gave it in the instantiate step.
Click the Save button.

On the Console, you must now configure your domain so your edge firewall protects it.

On the Products menu, select Domains.
Click on the domain you want to protect with your Upstash Waiting Room function.
In the Settings section, click on the Edge Firewall selector and choose the edge firewall you created.
Click the Save button.

Done. Now the Upstash Waiting Room integration is running.

Select the Rules Engine tab.
Click the New Rule button.
Give an easy-to-remember name to the rule.
Select a criteria to run and catch the domains that you want to run the integration on.

Example: if Request URI starts with ./.

Below, select the Run Function behavior to the criteria.
Select the Upstash Waiting Room function according to the name you gave it before.
Click the Save button.

Done. Now the Upstash Waiting Room integration is running.