Deploy the Upstash Rate Limit Template

The Upstash Rate Limit template helps you to implement rate limiting in a serverless environment, without requiring extensive manual setup. This template includes configurations for limiting requests and window limit.

It works in conjunction with Azion Functions, being possible to adjust the initial setup based on the args. Additionally, this template creates a new GitHub repository that allows a continuous deployment workflow. This way, you’re able to further configure and customize the setup to attend to your needs, obtaining easy management and delivery of your personalized content.

Requirements

To start using this template, you need to:

• Create an Upstash account.
• Create a Global Database for the best available edge latency in the Upstash Console.
• Have a GitHub account to connect with Azion and create your new repository.
  • Every push will be deployed automatically to this repository to keep your project updated.
• This template uses Functions, and it may generate usage-related costs. Check the pricing page for more information.

Deploying the template

You can obtain and configure your template through the Azion Console. To easily deploy it at the edge, click the button below.

Setting up the template

In the configuration form, you must provide the information to configure your application. Fill in the presented fields.

1. Connect Azion with your GitHub account.

• A pop-up window will open to confirm the installation of the Azion GitHub App, a tool that connects your GitHub account with Azion’s platform.
• Define your permissions and repository access as desired.

2. Select the Git Scope to work with.
3. Define a name for your application.

• The bucket for storage and the function will use the same name.
• Use a unique and easy-to-remember name. If the name has already been used, the platform returns an error message.

4. Enter the following information:

• Upstash Redis Rest URL *: the URL to access your Upstash database using REST.
  • Go to your Upstash Console and copy the UPSTASH_REDIS_REST_URL in your database page.
• Upstash Redis Rest Token *: the token to authorize access to your Upstash database using REST.
  • Go to your Upstash Console and copy the UPSTASH_REDIS_REST_TOKEN in your database page.
• Request Limit: the maximum number of requests. Example: 6.
• Window Limit: the time window for new requests. Example: 10 s (can be used: “ms” | “s” | “m” | “h” | “d”).

5. Click the Deploy button to start the deployment process.

During the deployment, you’ll be able to follow the process through a window showing the logs. When it’s complete, the page shows information about the application and some options to continue your journey.

Key configurations

The Upstash Rate Limit template creates a new Azion application and its domain. It also creates a function, to provide the arguments for the rate limiting, and a new repository in your GitHub account based on a public template, including a GitHub Action to enable continuous deployment.

In this function, the upstash/redis and upstash/ratelimit libraries are integrated, connecting to your Upstash Global Database and checking in the /login route if it’s within the configured Window and Limit. The key for limits is metadata ["remote_addr"].

Rate limiting behavior

When a client exceeds the configured Request Limit within the defined Window Limit, the function returns an HTTP 429 Too Many Requests response. The client isn’t permanently blocked — the limitation is temporary and tied directly to the Window Limit you set.

Once the time window resets, the request counter clears and the client can make requests again up to the configured limit. For example, if you set a limit of 6 requests per 10 s, a client that exceeds 6 requests within any 10-second window will receive 429 responses until that window expires. After the window resets, requests are served normally.

Managing your project

Considering the initial setup may not be optimal for your specific web application, all settings can be customized any time you need using Azion Console. Once the template is deployed, you also have full control over customizing your Upstash account and database.

To manage and edit your application’s settings on Azion, follow these steps:

1. Access Console.
2. On the upper-left corner, select Products menu > Applications.

• You’ll be redirected to the Applications page. It lists all the applications you’ve created.

3. Find the application by the name you defined during the template execution and select it.

• The list is organized alphabetically. You can also use the search bar located in the upper-left corner of the list; currently, it filters only by Application Name.

After selecting the application you’ll work on, you’ll be directed to a page containing all the settings you can configure.

Adding a custom domain

The application created during the deployment has an assigned Azion Workload domain to make it accessible through the browser. The domain has the following format: xxxxxxxxxx.map.azionedge.net/. However, you can add a custom domain for users to access your application through it.