Create Deliveries

Updated 3 months ago

This page shows how to create and deploy Deliveries. A Delivery allows you to distribute your content no matter the cloud storage provider you use and connect with CDNs to minimizes page load times, improves performance, and reduces bandwidth and infrastructure costs.

After you have deployed your Delivery, you can distribute your content and integrate it with CDNs to serve your data.

There are four steps to deploy a new Delivery:

  1. Give the Delivery a name
  2. Configure the Store to serve master data
  3. Distribute your Delivery data through your domain (optional)
  4. Define the Delivery index URI (optional)
  5. Define the Delivery error URI (optional)
  6. Deploy your Delivery

Get started

On the Koyeb control panel navigation bar, click the "CREATE" button and select Delivery.

Koyeb home with create menu expanded

You land on the Delivery creation page.

Deliveries new

Give the Delivery a name

The Delivery name is an identifier to help you remember what the Delivery is used for.

Configure the Store to serve master data

The first step to create a Delivery is to configure the Store to server the master data. You can connect a Koyeb Managed Store or any supported cloud storage providers.

In this guide, I connect an AWS S3 bucket as my Delivery Store. This allows me to serve my AWS master data using a Koyeb Delivery. The procedure for other Store integrations is similar.

To connect a Store, click the edit icon in the store section.

Select a Store integration

Deliveries new with edit store open

A drawer opens listing the integration available as a Store, and I select the AWS S3 Store integration.

Configure the Store integration

Deliveries new with edit store s3 selected

To configure the Store, I need to define the bucket name and region to use. Parameters may vary depending on the integration you select.

Once the form completed, I validate the information.

Define the Delivery index URI (optional)

The index URI is an HTML document path in your Store that your Delivery returns when a request is made to the root of your Delivery. For instance, if a user enters https://mydelivery.eu-west-1.delivery.prod.koyeb.com in the browser, the user is not requesting any specific page. In that case, your Delivery serves up the index document, which is sometimes referred to as the default page.

Index URI is perfect if you want to serve a static website.

Define the Delivery error URI (optional)

The error URI is an HTML document path in your Store that your Delivery returned when a request failed in your Delivery. For instance, if a user enters https://mydelivery.eu-west-1.delivery.prod.koyeb.com/<file-doesnt-exist> in the browser, the user is requesting a page that doesn't exist. In that case, your Delivery serves up the error document.

Error URI is great to customize error message returns by a Delivery.

Distribute your Delivery content through your domain (optional)

By default, Koyeb generates a unique URL for your Delivery. You can additionally add your own domain to point on a delivery. This procedure requires that you own a domain and know how to add a CNAME record.

To add a domain, click the "ADD DOMAIN" button. Fill the input that appears with the domain you want to use.

On your DNS management service, create a new CNAME record for the domain you want to use and point it to delivery.prod.koyeb.com.

Deploy your Delivery

We are now ready to deploy our Delivery and start to distribute content. Click the "CREATE DELIVERY" button to provision the Delivery.

You land on the Delivery page where are displayed various information about your Delivery such as:

  • The Delivery endpoint to access your content: https://<ID>.delivery.prod.koyeb.com.
  • The Delivery index URI if configured.
  • The Delivery error URI if configured.
  • The Route information: Contains details about the Store configured.

You can now distribute your Store content via the delivery endpoint and integrate a CDN to minimizes page load times, improves performance, and reduces bandwidth and infrastructure costs.

If you configured a custom domain, you could also access your content through it.

footer-frame