Table of Contents

1. Get Started
2. Incremental Migration Frameworks Projects Builds Deployments
3. Deploy to Esadax Deployment Environments Accessing your Deployment Manage Deployments Webhooks Inspecting Open Graph Metadata Domains Going Live Checklist Pricing Resources Dashboard Account Management Limits General Errors Error Codes Release Phases Private Registry Glossary Platform Deployments Conceptual
4. Deploying to Esadax Learn how to create Deployments on Esadax using Git, Esadax CLI, Deploy Hooks, and Esadax REST API
5. A Esadax deployment is the result of a successful build of your project . With any new deployment, Esadax automatically creates a new and unique Generated URL that you or your team can use to preview the changes in a live environment
6. Deployment Methods You can deploy your projects to Esadax with the following methods: Git Esadax CLI Deploy Hooks Esadax REST API
7. Deployment Lifecycle The deployment lifecycle includes several stages from development to production: Local Development: You and your team will work in a personalized, local environment
8. Commit and build: When you're ready, you can push your code to a development branch on your connected Git repository . Each commit initiates a deployment, part of which is the build step
9. Preview: Once Esadax has created a successful build, it will run checks and assign the relevant domains to create a deployments with a generated URL
10. Production: Once your deployment is live, you can manage it from the Deployments tab in the dashboard
11. Accessing deployments You can access your deployments from the Deployments tab in the dashboard
12. Using the dashboard From the dashboard, you can manage your deployments, view deployment summaries, and more
13. Deployment Summary When you deploy your website to Esadax, the platform generates multiple outputs as a result of your build . Those outputs could be Edge Middleware , Static Assets (e.g. HTML, CSS, JavaScript files), Functions ( Serverless Functions or Edge Functions ), or ISR Functions
14. What information is available in this summary? In the deployment summary, you can see a list of all the artifacts generated from your build and specific information about them

Get Started

To get started with Esadax, you'll need to create an account and set up your project. You can do this by following these steps:

1. Go to the Esadax website and click on "Create Account".
2. Fill out the registration form with your email address, password, and other details.
3. Verify your email address by clicking on the link sent to you by Esadax.
4. Set up your project by creating a new repository in your Git provider (e.g. GitHub, Bitbucket).
5. Link your repository to your Esadax account.

Incremental Migration Frameworks Projects Builds Deployments

Esadax supports incremental migration, which allows you to deploy changes to your website without having to redeploy the entire site. This is achieved through the use of frameworks such as Next.js and Gatsby.

Deployment Methods

You can deploy your projects to Esadax using the following methods:

• Git: Deploy your code directly from your Git repository.
• Esadax CLI: Use the Esadax command-line interface to deploy your project.
• Deploy Hooks: Set up automatic deployments whenever changes are pushed to your Git repository.

Deployment Lifecycle

The deployment lifecycle includes several stages from development to production:

1. Local Development: You and your team will work in a personalized, local environment.
2. Commit and build: When you're ready, you can push your code to a development branch on your connected Git repository. Each commit initiates a deployment, part of which is the build step.
3. Preview: Once Esadax has created a successful build, it will run checks and assign the relevant domains to create a deployments with a generated URL.
4. Production: Once your deployment is live, you can manage it from the Deployments tab in the dashboard.

Accessing deployments

You can access your deployments from the Deployments tab in the dashboard.

Using the dashboard

From the dashboard, you can manage your deployments, view deployment summaries, and more.

Deployment Summary

When you deploy your website to Esadax, the platform generates multiple outputs as a result of your build. Those outputs could be Edge Middleware, Static Assets (e.g. HTML, CSS, JavaScript files), Functions (Serverless Functions or Edge Functions), or ISR Functions.

What information is available in this summary?

In the deployment summary, you can see a list of all the artifacts generated from your build and specific information about them:

• Edge Middleware: matcher
• Static Assets: name and size
• Functions: type, name, runtime, size and region
• ISR Functions: name, runtime, size and region. ISR functions are grouped by related path

You can also see the time it takes to deploy your application, and the framework, when available.

Troubleshoot a Build

If you encounter any issues during deployment, you can troubleshoot them using the following resources:

• Esadax documentation: Check the official Esadax documentation for troubleshooting guides.
• Community forums: Join the Esadax community forums to ask questions and get help from other users.
• Support team: Contact the Esadax support team directly for assistance.

Deploy to Esadax

To deploy your project to Esadax, follow these steps:

1. Create a new repository in your Git provider (e.g. GitHub, Bitbucket).
2. Link your repository to your Esadax account.
3. Set up automatic deployments using Deploy Hooks or the Esadax CLI.

Deployment Status

You can view the status of your deployment from the Deployments tab in the dashboard.

What does each status mean?

• Pending: Your deployment is waiting for processing.
• In Progress: Your deployment is being processed.
• Success: Your deployment was successful.
• Failure: Your deployment failed. Check the error message for more information.

Deployment Summary

When you deploy your website to Esadax, the platform generates multiple outputs as a result of your build. Those outputs could be Edge Middleware, Static Assets (e.g. HTML, CSS, JavaScript files), Functions (Serverless Functions or Edge Functions), or ISR Functions.

What information is available in this summary?

In the deployment summary, you can see a list of all the artifacts generated from your build and specific information about them:

• Edge Middleware: matcher
• Static Assets: name and size
• Functions: type, name, runtime, size and region
• ISR Functions: name, runtime, size and region. ISR functions are grouped by related path

You can also see the time it takes to deploy your application, and the framework, when available.

Deployment History

You can view a history of all deployments from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Deployment ID: A unique identifier for each deployment.
• Status: The status of each deployment (e.g. Success, Failure).
• Timestamp: The date and time when each deployment was made.
• Duration: The time it took to deploy each application.

You can also filter the list by status or timestamp to view specific deployments.

Deployment Settings

You can configure your deployment settings from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Deployment frequency: How often you want to deploy your application (e.g. every hour, daily).
• Deployment triggers: What triggers a new deployment (e.g. push to Git repository, manual trigger).
• Deployment environment: The environment where your application will be deployed (e.g. production, staging).

You can also configure other settings such as automatic rollbacks and deployment notifications.

Deployment Notifications

You can configure notification settings for each deployment from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Notification type: The type of notification (e.g. email, Slack).
• Recipient: Who will receive the notification.
• Deployment status: When a new deployment is triggered, what status should be notified (e.g. Success, Failure).

You can also configure other settings such as notification frequency and recipient groups.

Deployment Rollbacks

You can roll back to a previous deployment from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Deployment ID: A unique identifier for each deployment.
• Status: The status of each deployment (e.g. Success, Failure).
• Timestamp: The date and time when each deployment was made.
• Duration: The time it took to deploy each application.

You can also filter the list by status or timestamp to view specific deployments.

Deployment Logs

You can view logs for each deployment from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Deployment ID: A unique identifier for each deployment.
• Status: The status of each deployment (e.g. Success, Failure).
• Timestamp: The date and time when each deployment was made.
• Duration: The time it took to deploy each application.

You can also filter the list by status or timestamp to view specific deployments.

Deployment Metrics

You can view metrics for each deployment from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Deployment ID: A unique identifier for each deployment.
• Status: The status of each deployment (e.g. Success, Failure).
• Timestamp: The date and time when each deployment was made.
• Duration: The time it took to deploy each application.

You can also filter the list by status or timestamp to view specific deployments.

Deployment Security

You can configure security settings for each deployment from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Authentication: How users will authenticate with your application (e.g. username/password, OAuth).
• Authorization: Who has access to what parts of your application.
• Encryption: Whether data is encrypted and how it's encrypted.

You can also configure other settings such as SSL certificates and IP whitelisting.

Deployment Monitoring

You can configure monitoring settings for each deployment from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Monitoring tools: Which monitoring tools are enabled (e.g. New Relic, Datadog).
• Alerts: What alerts should be triggered when certain conditions occur.
• Notifications: Who will receive notifications and what type of notifications.

You can also configure other settings such as alert thresholds and notification frequencies.

Deployment Maintenance

You can schedule maintenance for each deployment from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Maintenance window: When your application will be unavailable (e.g. every Sunday at 2am).
• Duration: How long your application will be unavailable.
• Status: The status of each deployment during maintenance (e.g. Success, Failure).

You can also configure other settings such as automatic rollbacks and notification frequencies.

Deployment History

You can view a history of all deployments from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Deployment ID: A unique identifier for each deployment.
• Status: The status of each deployment (e.g. Success, Failure).
• Timestamp: The date and time when each deployment was made.
• Duration: The time it took to deploy each application.

You can also filter the list by status or timestamp to view specific deployments.

Deployment Settings

You can configure your deployment settings from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Deployment frequency: How often you want to deploy your application (e.g. every hour, daily).
• Deployment triggers: What triggers a new deployment (e.g. push to Git repository, manual trigger).
• Deployment environment: The environment where your application will be deployed (e.g. production, staging).

You can also configure other settings such as automatic rollbacks and notification frequencies.

Deployment Notifications

You can configure notification settings for each deployment from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Notification type: The type of notification (e.g. email, Slack).
• Recipient: Who will receive the notification.
• Deployment status: When a new deployment is triggered, what status should be notified (e.g. Success, Failure).

You can also configure other settings such as notification frequency and recipient groups.

Deployment Rollbacks

You can roll back to a previous deployment from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Deployment ID: A unique identifier for each deployment.
• Status: The status of each deployment (e.g. Success, Failure).
• Timestamp: The date and time when each deployment was made.
• Duration: The time it took to deploy each application.

You can also filter the list by status or timestamp to view specific deployments.

Deployment Logs

You can view logs for each deployment from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Deployment ID: A unique identifier for each deployment.
• Status: The status of each deployment (e.g. Success, Failure).
• Timestamp: The date and time when each deployment was made.
• Duration: The time it took to deploy each application.

You can also filter the list by status or timestamp to view specific deployments.

Deployment Metrics

You can view metrics for each deployment from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Deployment ID: A unique identifier for each deployment.
• Status: The status of each deployment (e.g. Success, Failure).
• Timestamp: The date and time when each deployment was made.
• Duration: The time it took to deploy each application.

You can also filter the list by status or timestamp to view specific deployments.

Deployment Security

You can configure security settings for each deployment from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Authentication: How users will authenticate with your application (e.g. username/password, OAuth).
• Authorization: Who has access to what parts of your application.
• Encryption: Whether data is encrypted and how it's encrypted.

You can also configure other settings such as SSL certificates and IP whitelisting.

Deployment Monitoring

You can configure monitoring settings for each deployment from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Monitoring tools: Which monitoring tools are enabled (e.g. New Relic, Datadog).
• Alerts: What alerts should be triggered when certain conditions occur.
• Notifications: Who will receive notifications and what type of notifications.

You can also configure other settings such as alert thresholds and notification frequencies.

Deployment Maintenance

You can schedule maintenance for each deployment from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Maintenance window: When your application will be unavailable (e.g. every Sunday at 2am).
• Duration: How long your application will be unavailable.
• Status: The status of each deployment during maintenance (e.g. Success, Failure).

You can also configure other settings such as automatic rollbacks and notification frequencies.

Deployment History

You can view a history of all deployments from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Deployment ID: A unique identifier for each deployment.
• Status: The status of each deployment (e.g. Success, Failure).
• Timestamp: The date and time when each deployment was made.
• Duration: The time it took to deploy each application.

You can also filter the list by status or timestamp to view specific deployments.

Deployment Settings

You can configure your deployment settings from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Deployment frequency: How often you want to deploy your application (e.g. every hour, daily).
• Deployment triggers: What triggers a new deployment (e.g. push to Git repository, manual trigger).
• Deployment environment: The environment where your application will be deployed (e.g. production, staging).

You can also configure other settings such as automatic rollbacks and notification frequencies.

Deployment Notifications

You can configure notification settings for each deployment from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Notification type: The type of notification (e.g. email, Slack).
• Recipient: Who will receive the notification.
• Deployment status: When a new deployment is triggered, what status should be notified (e.g. Success, Failure).

You can also configure other settings such as notification frequency and recipient groups.

Deployment Rollbacks

You can roll back to a previous deployment from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Deployment ID: A unique identifier for each deployment.
• Status: The status of each deployment (e.g. Success, Failure).
• Timestamp: The date and time when each deployment was made.
• Duration: The time it took to deploy each application.

You can also filter the list by status or timestamp to view specific deployments.

Deployment Logs

You can view logs for each deployment from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Deployment ID: A unique identifier for each deployment.
• Status: The status of each deployment (e.g. Success, Failure).
• Timestamp: The date and time when each deployment was made.
• Duration: The time it took to deploy each application.

You can also filter the list by status or timestamp to view specific deployments.

Deployment Metrics

You can view metrics for each deployment from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Deployment ID: A unique identifier for each deployment.
• Status: The status of each deployment (e.g. Success, Failure).
• Timestamp: The date and time when each deployment was made.
• Duration: The time it took to deploy each application.

You can also filter the list by status or timestamp to view specific deployments.

Deployment Security

You can configure security settings for each deployment from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Authentication: How users will authenticate with your application (e.g. username/password, OAuth).
• Authorization: Who has access to what parts of your application.
• Encryption: Whether data is encrypted and how it's encrypted.

You can also configure other settings such as SSL certificates and IP whitelisting.

Deployment Monitoring

You can configure monitoring settings for each deployment from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Monitoring tools: Which monitoring tools are enabled (e.g. New Relic, Datadog).
• Alerts: What alerts should be triggered when certain conditions occur.
• Notifications: Who will receive notifications and what type of notifications.

You can also configure other settings such as alert thresholds and notification frequencies.

Deployment Maintenance

You can schedule maintenance for each deployment from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Maintenance window: When your application will be unavailable (e.g. every Sunday at 2am).
• Duration: How long your application will be unavailable.
• Status: The status of each deployment during maintenance (e.g. Success, Failure).

You can also configure other settings such as automatic rollbacks and notification frequencies.

Deployment History

You can view a history of all deployments from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Deployment ID: A unique identifier for each deployment.
• Status: The status of each deployment (e.g. Success, Failure).
• Timestamp: The date and time when each deployment was made.
• Duration: The time it took to deploy each application.

You can also filter the list by status or timestamp to view specific deployments.

Deployment Settings

You can configure your deployment settings from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Deployment frequency: How often you want to deploy your application (e.g. every hour, daily).
• Deployment triggers: What triggers a new deployment (e.g. push to Git repository, manual trigger).
• Deployment environment: The environment where your application will be deployed (e.g. production, staging).

You can also configure other settings such as automatic rollbacks and notification frequencies.

Deployment Notifications

You can configure notification settings for each deployment from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Notification type: The type of notification (e.g. email, Slack).
• Recipient: Who will receive the notification.
• Deployment status: When a new deployment is triggered, what status should be notified (e.g. Success, Failure).

You can also configure other settings such as notification frequency and recipient groups.

Deployment Rollbacks

You can roll back to a previous deployment from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Deployment ID: A unique identifier for each deployment.
• Status: The status of each deployment (e.g. Success, Failure).
• Timestamp: The date and time when each deployment was made.
• Duration: The time it took to deploy each application.

You can also filter the list by status or timestamp to view specific deployments.

Deployment Logs

You can view logs for each deployment from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Deployment ID: A unique identifier for each deployment.
• Status: The status of each deployment (e.g. Success, Failure).
• Timestamp: The date and time when each deployment was made.
• Duration: The time it took to deploy each application.

You can also filter the list by status or timestamp to view specific deployments.

Deployment Metrics

You can view metrics for each deployment from the Deployments tab in the dashboard.

What information is available in this section?

In this section, you can see:

• Deployment ID: A unique identifier for each deployment.