NavigationContentFooter
Jump toSuggest an edit

How to configure a custom domain for Edge Services

Reviewed on 15 October 2024Published on 24 July 2024

If you already own a domain, you can customize an Edge Services pipeline endpoint with a subdomain of your choice. This means you can access your Object Storage bucket or Load Balancer origin through Edge Services via your own subdomain rather than the standardized Edge Services endpoint.

For example, if you own beautiful-domain.com, you can customize the endpoint to be whatever-i-want.beautiful-domain.com. You must also add an SSL/TLS certificate so that Edge Services can securely serve your content via HTTPS.

You cannot customize your endpoint with a primary domain directly (e.g. beautiful-domain.com), only with a subdomain of it.

How to configure a custom domain

The procedure for adding a customized endpoint is as follows:

  1. In the Scaleway console, navigate to the Edge Services dashboard for the Object Storage or Load Balancer pipeline whose domain you want to customize:

  2. In the Endpoint panel, click Configure domain. The following screen displays:

  3. Set a subdomain from which your Object Storage bucket or Load Balancer origin will be accessible via its Edge Services pipeline. You must already own the primary domain. For example, if you own beautiful-domain.com, choose any subdomain you like and enter my-chosen-subdomain.beautiful-domain.com into the box.

    Important

    It is not possible to use only a root domain (aka primary domain or apex domain), you must use a subdomain. This is because CNAME records, essential to point your domain to your Edge Services endpoint, cannot by definition be created for root domains, only for subdomains. ✅ blog.example.com ❌ example.com

  4. This step depends on whether the domain used in the previous step is managed with Scaleway Domains and DNS, or an external domain provider. Choose the appropriate tab below.

    The domain you are using for Edge Services is considered to be managed with Scaleway Domains and DNS if:

    • You registered the domain with Domains and DNS, or
    • You transferred an externally-registered domain to Domains and DNS

    If either of the above is true, Scaleway will auto-detect that the domain is managed by Domains and DNS, and a message will display confirming that you do not need to create a CNAME record. We will auto-generate the appropriate CNAME record in your domain’s DNS records, to point your subdomain to the Edge Services endpoint. This record is generated when you click Customize domain in step 6.

    You should not attempt to modify or delete the CNAME record, which will be visible among your DNS records in the Scaleway console.

  5. Provide an SSL/TLS certificate for your subdomain so that Edge Services can serve traffic for it over HTTPS. You have three options for this:

    • Generate a free Let’s Encrypt certificate, managed by Scaleway, including automatic renewals.
    • Select an existing certificate that you have stored in Scaleway Secret Manager.
    • Manually import a certificate into Scaleway Secret Manager:
      • Enter a name for your certificate (alphanumeric characters only)
      • Optionally, add tags by typing each tag and then pressing enter
      • Copy and paste the full PEM-formatted certificate chain into the box. Your certificate will be automatically stored in Secret Manager and billed accordingly.
    Tip

    For help with SSL/TLS certificates for Edge Services, and/or dealing with any errors you encounter importing a certificate into Secret Manager, see our dedicated documentation.

  6. Click Customize domain to finish.

Your customized domain is set up, and you are returned to the Edge Services dashboard. The customized domain displays in the Endpoint panel. When you access your Object Storage or Load Balancer origin through this domain, its content will be served via Edge Services.

Note

If you chose to generate a managed Let’s Encrypt certificate, allow a few minutes for the certificate to finish creating. When the process is complete and the certificate is ready, you will see a green status light for SSL/TLS certificate on your endpoint dashboard.

How to edit your customized domain or its certificate

After customizing your domain, you can edit it (or its certificate) at any time as follows:

  1. In the Scaleway console, navigate to the Edge Services dashboard for the Object Storage bucket or Load Balancer pipeline whose domain you want to customize:

  2. In the Endpoint panel, click Edit. The Edit Domain screen displays.

  3. Edit the subdomain as desired - do not forget to also set up a new CNAME record, if necessary.

  4. Edit your certificate options as required - choose to generate a managed Let’s Encrypt certificate, managed by Scaleway including automatic renewals, or select a different certificate from Secret Manager, or manually import a new certificate for your custom domain.

  5. Click Edit domain to finish.

How to reset your customized domain

Even though the original Edge Services endpoint (e.g. https://pipeline-id-or-bucket-name.svc.edge.scw.cloud) will continue to work after you add a customized domain, you can choose to remove your customized domain completely and go back to the original Edge Services endpoint only. This is done via the reset function:

  1. In the Scaleway console, navigate to the Edge Services dashboard for the Object Storage bucket or Load Balancer pipeline whose domain you want to reset:

  2. In the Endpoint panel, click Reset.

    A screen displays, warning you that this will reset the pipeline’s domain back to the default Edge Services endpoint. Edge Services will consider your customized subdomain as unknown. You should also remember to:

    • Delete your CNAME record from your domain provider, unless your domain is managed with Scaleway Domains and DNS, in which case we take care of deletion for you.
    • Delete any SSL/TLS certificates you imported into Secret Manager (if no longer required elsewhere, so that you are no longer billed for it). If you generated a managed Let’s Encrypt certificate however, Scaleway takes care of the deletion for you.
  3. Click Reset domain to finish.

See also
How to create a Load Balancer pipelineHow to configure a cache
API DocsScaleway consoleDedibox consoleScaleway LearningScaleway.comPricingBlogCareers
© 2023-2024 – Scaleway