# Slate ## Help Components -------------------------------------------------------------------------------- title: "Introduction" description: "Learn more about Calayst Slate service that allows you to deploy, preview and launch front-end web applications." last_updated: "2026-03-18T07:41:08.656Z" source: "https://docs.catalyst.zoho.com/en/slate/help/introduction/" service: "Slate" related: - Deploy from Private Git Repository (/en/slate/help/git-integration/deploy-from-private-repository) - Deploy from Public Git Repository (/en/slate/help/git-integration/deploy-from-public-repository) - Deploy Slate Templates (/en/slate/help/git-integration/deploy-template) - Deploy by Direct Upload (/en/slate/help/direct-upload) - Deploy from CLI (/en/slate/help/deploy-from-cli) -------------------------------------------------------------------------------- # Slate ## Introduction Slate is a robust front-end development service offered by Catalyst that enables you to seamlessly **deploy**, **preview**, and **launch** your web applications. It offers native support for the following popular JavaScript frameworks, while seamlessly accommodating other frontend frameworks for hassle-free deployment: **{{%link href="https://nextjs.org/" %}}Next.js{{%/link%}}**, **{{%link href="https://angular.dev/" %}}Angular{{%/link%}}**, **{{%link href="https://astro.build/" %}}Astro{{%/link%}}**, **{{%link href="https://react.dev/" %}}React{{%/link%}}**, **{{%link href="https://www.solidjs.com/" %}}SolidJS{{%/link%}}**, **{{%link href="https://preactjs.com/" %}}Preact{{%/link%}}**, **{{%link href="https://svelte.dev/" %}}Svelte{{%/link%}}**, **{{%link href="https://vuejs.org/" %}}Vue{{%/link%}}**, **{{%link href="https://vitejs.dev/" %}}Vite{{%/link%}}**, and **{{%link href="https://nuxt.com/" %}}Nuxt{{%/link%}}**. You can deploy multiple front-end applications within a single {{%link href="/en/getting-started/catalyst-projects/" %}}Catalyst project{{%/link%}} using Slate. For enabling instant and automated deployments, you can integrate with popular version control systems, such as {{%link href="https://github.com/" %}}GitHub{{%/link%}}, {{%link href="https://about.gitlab.com/" %}}GitLab{{%/link%}}, or {{%link href="https://bitbucket.org/product/" %}}Bitbucket{{%/link%}}, ensuring your code is deployed directly from your repositories to Slate. In Slate, the entire build to deployment process is streamlined and automated internally using {{%link href="/en/pipelines/getting-started/introduction/" %}}Catalyst Pipelines{{%/link%}}. {{%link href="/en/getting-started/set-up-a-catalyst-project/integrations-settings/#github-integration" %}}Learn more about supported Git integrations{{%/link%}}. Slate ensures lightning-fast load times and superior performance for your front-end web applications. Besides hosting your applications, Slate offers additional perks including **free SSL provision**, **{{%link href="/en/slate/help/custom-domains" %}}custom domain mapping{{%/link%}}**, and the ability to **{{%link href="/en/slate/help/deployment-previews" %}}preview every deployment{{%/link%}}** instantly without having to verify the full application in production every time. Slate provides robust security and fosters streamlined collaboration among developers as well. This efficient deployment management enhances productivity and enables effortless scaling of your applications. <br> ### Slate Deployments Before getting started, let's brush up on the common terms in Slate: * A **deployment** is a result of a successful build of an application. * In Slate, an **app** can be deployed either through a Git repository or by uploading files. Each app can also have multiple deployments within Slate. In Slate, you can choose to trigger a deployment manually or enable automated deployments by integrating with any of the supported Git providers. You can deploy your web client applications built with any of the above frameworks using any of the deployment methods supported by Slate below. 1. **Integrating with a Git provider**: To deploy your web application using this method, you must mandatorily integrate any of your Git accounts ({{%link href="https://github.com/" %}}GitHub{{%/link%}}, {{%link href="https://about.gitlab.com/" %}}GitLab{{%/link%}}, or {{%link href="https://bitbucket.org/product/" %}}Bitbucket{{%/link%}}) with Catalyst. After you have integrated, you can choose any of the below deployment methods in Slate: * **Deploy a Starter template**: To get started with Slate, we highly recommend this method. Slate offers a variety of free starter templates for common use cases across multiple client frameworks. Simply choose a template and deploy it in Slate. The template code will be pushed to your connected Git repository and deployed from there. {{%link href="/en/slate/help/git-integration/deploy-template" %}}Learn more about deploying a starter template{{%/link%}}. * **Deploy from your private repository**: When you choose to deploy an application directly from your Git repository to Catalyst, Slate automatically detects your application's framework and handles the entire build and deployment process from its end. You can also enable the Auto Deploy feature, so that whenever changes are pushed to the connected repository.{{%link href="/en/slate/help/git-integration/deploy-from-private-repository" %}}Learn more about deploying from your private repository{{%/link%}}. * **Deploy from any public repository**: This method allows you to deploy quickly and view any application live, using the source code from public repositories developed by others or from your own public repos. This method requires Git authentication from your end. {{%link href="/en/slate/help/git-integration/deploy-from-public-repository" %}}Learn more about deploying from your public repository{{%/link%}}. 2. **Direct Upload to the console**: This method lets you instantly deploy your application by simply dragging and dropping your client files in a zip format, enabling deployment in minutes. {{%link href="/en/slate/help/direct-upload" %}}Learn more about this method{{%/link%}}. 3. **Deploy using Catalyst CLI**: This method requires you to install the Catalyst CLI and deploy the application by executing a series of pre-configured commands in the terminal. {{%link href="/en/slate/help/deploy-from-cli" %}}Learn more about this method{{%/link%}}. After you deploy your application in Catalyst, Slate automatically generates an {{%link href="/en/slate/help/slate-access-url" %}}access URL{{%/link%}} for your deployment. This URL points to a sandboxed environment where team members can preview their changes live without deploying to production. You can also map your own custom domains with the generated access URLs, based on your specific needs. {{%link href="/en/slate/help/custom-domains" %}}Learn more about Slate custom domain mapping{{%/link%}}. Catalyst provides free SSL certificates for all your client applications hosted using Slate. It also enables secured environment variables management, thereby providing high security to protect your data and applications.{{%link href="/en/slate/help/environment-variables" %}}Learn more about how environment variables are handled in Catalyst Slate{{%/link%}}. To get started, we will first delve into the end-to-end architecture of Catalyst Slate to understand its workflow and functionalities better. <br> ### Slate Deployment Flow The Catalyst Slate workflow employs the following processes: 1. **Creating a deployment**: You can choose to deploy your application's source code to Catalyst using any of the below methods: * Access code from private or public Git repositories and deploy using Slate. * Deploy application source code by directly uploading them to the Catalyst console. * Deploy application using pre-defined commands in the Catalyst CLI. 2. When the deployment is created, Slate automatically handles the application build process and hosts the application in the Catalyst cloud. 3. Slate instantly generates an {{%link href="/en/slate/help/slate-access-url" %}}access URL{{%/link%}} for your deployment. 4. Slate facilitates automatic deployments in case the deployment has been initiated from a Git repository. Whenever any changes are pushed to the linked repository by anyone, individual deployments are triggered in Slate. This enables every developer to view the changes live in no time. Unique access URLs will be generated automatically for each deployment. -------------------------------------------------------------------------------- title: "Quick Start Guide" description: "Get Started with the Catalyst Slate service by following the step-by-step processess involved in deployment and monitoring the deployment." last_updated: "2026-03-18T07:41:08.656Z" source: "https://docs.catalyst.zoho.com/en/slate/help/quick-start-guide/" service: "Slate" related: - Create Catalyst Project (/en/getting-started/catalyst-projects/#create-a-catalyst-project) - Deploy from Private Git Repository (/en/slate/help/git-integration/deploy-from-private-repository) - Deploy from Public Git Repository (/en/slate/help/git-integration/deploy-from-public-repository) - Deploy Slate Templates (/en/slate/help/git-integration/deploy-template) - Deploy by Direct Upload (/en/slate/help/direct-upload) - Deploy from CLI (/en/slate/help/deploy-from-cli) -------------------------------------------------------------------------------- # Quick Start Guide 1. **Create a Catalyst project**: Access the {{%link href="https://console.catalyst.zoho.com/baas/index" %}}Catalyst console{{%/link%}} to {{%link href="/en/getting-started/catalyst-projects/#create-a-catalyst-project" %}}create a new project{{%/link%}}. After the project creation is done, you will be able to access the {{%link href="/en/slate" %}}Catalyst Slate service{{%/link%}} in the console. {{%link href="/en/" %}}Learn more about other Catalyst services{{%/link%}}. 2. **Create a Deployment**: You can initiate a deployment in Slate using any of the following methods: **Integrate with Git repository**: You can integrate your Git accounts ({{%link href="https://github.com/" %}}GitHub{{%/link%}}, {{%link href="https://about.gitlab.com/" %}}GitLab{{%/link%}}, or {{%link href="https://bitbucket.org/product/" %}}Bitbucket{{%/link%}}) with Catalyst to deploy source code directly from your private repository to Slate, and you can also enable the **Auto-Deploy** feature from the console, so that any changes pushed to the connected repository will trigger an automatic deployment in Slate. {{%link href="/en/slate/help/git-integration/deploy-from-private-repository" %}}Learn more about this deployment method{{%/link%}}. You can also deploy from any public Git repository by simply providing the repository link in the Catalyst console. {{%link href="/en/slate/help/git-integration/deploy-from-public-repository" %}}Learn more about this deployment method{{%/link%}}. {{%note%}}{{%bold%}}Note:{{%/bold%}} To test the waters instantly, you can choose a ready-made template from our Starter template library, push the code to your private repository, and then deploy the application in Slate. {{%link href="/en/slate/help/git-integration/deploy-template" %}}Learn more about this deployment method{{%/link%}}{{%/note%}} **Direct upload**: You can upload your client application directly with all the necessary files compressed as a zip to the Catalyst console. You can learn more about this deployment method from {{%link href="/en/slate/help/direct-upload" %}}this help page{{%/link%}}. **Deploy via CLI**: You can also deploy your application by executing commands from the Catalyst CLI. {{%link href="/en/slate/help/deploy-from-cli" %}}Learn more about deploying via CLI{{%/link%}}. 3. **Monitor and Manage Deployments** : After you have created a deployment using Slate, you can view the live build logs of the deployment in the Catalyst console. You can also collectively view all the deployments of an application in the **Deployment History** section. {{%link href="/en/slate/help/monitor-deployment" %}}Learn more about monitoring and managing deployments{{%/link%}}. You can also {{%link href="/en/slate/help/rollback-deployment" %}}rollback to a previous deployment{{%/link%}} and or manually {{%link href="/en/slate/help/fix-failed-deployment" %}}sync the latest commit{{%/link%}} in case of failed deployments, directly from the Catalyst console. -------------------------------------------------------------------------------- title: "Deploy by Direct Upload" description: "Learn about deploying a front-end web application by directly uploading the build zip file to the Catalyst console." last_updated: "2026-03-18T07:41:08.657Z" source: "https://docs.catalyst.zoho.com/en/slate/help/direct-upload/" service: "Slate" related: - Preview a Deployment (/en/slate/help/deployment-previews) - Cache a Deployment (/en/slate/help/cache) - Configure Environment Variables (/en/slate/help/environment-variables) - Custom Domain Mapping (/en/slate/help/custom-domains) - Monitor Deployments (/en/slate/help/monitor-deployment) - Fix a Failed Deployment (/en/slate/help/fix-failed-deployment) - Rollback a Deployment (/en/slate/help/rollback-deployment) -------------------------------------------------------------------------------- # Deploy by Direct Upload To deploy the application using this method, you can simply upload the application files compressed as a zip to the {{%link href="https://console.catalyst.zoho.com/" %}}Catalyst console{{%/link%}}. After you upload your application, your application will be hosted in the Catalyst cloud, and an access URL will be automatically generated for your application. You can instantly share the URL with end-users to start accessing your application. To deploy your application using Direct Upload, please follow the below steps: 1. In the **Direct Upload** section, simply drag your application's file as a zip. Click **Proceed**. 2. The app name will be automatically populated with the name of the uploaded zip file. You can edit it if needed. 3. Select the front-end framework used in the application. 4. Provide a commit message for the deployment. Click **Deploy**. The application will be deployed successfully, and the **Deployment Overview** screen will be displayed. You can fetch the access URL as shown in the screenshot below. You can also edit it, if required, by clicking **Edit URL**. {{%note%}}{{%bold%}}Note:{{%/bold%}} You can refer to the{{%link href="/en/slate/help/slate-access-url" %}}Slate Access URL{{%/link%}} help page to learn more about its structure.{{%/note%}} Edit the URL and click **Save**. The application will now be deployed in Catalyst's development environment by default. You can map a {{%link href="/en/slate/help/custom-domains" %}}custom domain{{%/link%}} with the generated Slate URL using our Domain Mapping feature. <br> ### Re-Upload Application You can re-upload a newer version of the application by clicking **Re-Upload** in the **Deployment Overview** screen. Drag and drop your application's updated build again and enter a commit message. Click **Upload**. This operation will replace the existing build of the application with a newer build. You can view the list of all deployments made to an application and also check the status of it from the **Deployment History** section in the console. {{%link href="/en/slate/help/monitor-deployment" %}}Learn more{{%/link%}}. You can also {{%link href="/en/slate/help/cache" %}}enable cache{{%/link%}} for your deployments, if required. {{%note%}}{{%bold%}}Note:{{%/bold%}} You can deploy any number of versions directly from the console.{{%/note%}} -------------------------------------------------------------------------------- title: "Deploy from CLI" description: "Learn about deploying a Slate application from the Catalyst CLI." last_updated: "2026-03-18T07:41:08.657Z" source: "https://docs.catalyst.zoho.com/en/slate/help/deploy-from-cli/" service: "Slate" related: - Deploy from Private Git Repository (/en/slate/help/git-integration/deploy-from-private-repository) - Deploy from Public Git Repository (/en/slate/help/git-integration/deploy-from-public-repository) - Deploy Slate Templates (/en/slate/help/git-integration/deploy-template) -------------------------------------------------------------------------------- # Deploy from CLI Catalyst Slate enables you to deploy applications using the {{%link href="/en/getting-started/installing-catalyst-cli/" %}}Catalyst CLI{{%/link%}}. You can execute pre-defined Catalyst commands in the terminal to initialize Slate, set up a Slate template, link or unlink local Slate apps to and from your Catalyst project in the console, and deploy a Slate app. This section provides step-by-step instructions for performing these operations. ### Initialize Slate **Prerequisite** : You need to login to the Catalyst CLI using your Catalyst account and then proceed with project and Slate initialization. Refer to {{%link href="/en/cli/v1/login/login-from-cli/" %}}this CLI help documentation{{%/link%}} to know the steps to login. You can initialize a Slate service directly in your app’s directory, or from a new directory. If you had selected Slate during the {{%link href="/en/cli/v1/initialize-resources/initialize-new-project/" %}}project initialization{{%/link%}}, you can follow the below listed steps: You can also use the below command to initialize the Slate service directly: {{%cli%}} catalyst init slate {{%/cli%}} 1. Select the client framework of the application you wish to deploy in Slate. Press Enter to confirm. {{%note%}}{{%bold%}}Note:{{%/bold%}} This process automatically downloads a boilerplate template based on your chosen framework into your project directory, allowing you to customize and deploy it to Slate.{{%/note%}} 2. Provide a name for your application and press Enter. The CLI will set the default configuration for your Slate application based on the chosen framework. This configuration includes the install and build commands, as well as the build path of the respective framework. If you wish to proceed with the default configuration, enter N. Otherwise, enter Y to make the necessary updates. {{%note%}} {{%bold%}}Note:{{%/bold%}} * The install command instals the required dependencies, typically using a package manager. * The build command is the script that transforms your development code into production code. * The build path is the directory where the production-ready, optimized files are generated after running the build process.{{%/note%}} By default, these commands are executed with the npm package manager, i.e., **npm install** or **npm run build**. If you would like to change the package manager, you can do so by entering N and providing the required command. Once you confirm the configuration, the Slate template code of the chosen framework will be downloaded to the project directory, and an entry will be added to the {{%link href="/en/cli/v1/project-directory-structure/catalyst-json/" %}}catalyst.json{{%/link%}} file, which serves as a connection between your project directory and the Catalyst Slate service. You can provide specific commands to be executed when serving the app locally by entering them as development commands and pressing Enter. <br> ### Create an Additional Slate App If your project directory is already linked to a Catalyst project and Slate is initialized, you can add a new Slate app to your project directory directly using the steps below. This operation will automatically add the Slate template code based on the chosen front-end framework to your project directory. 1. Execute the following command in the terminal from the Slate service's project directory: {{%cli%}} catalyst slate:create{{%/cli%}} 2. Select the required framework for your Slate application and provide a name for your application. 3. Based on the chosen framework, the install and build commands, the build path of the framework will be detected automatically. If you wish to proceed with the default configuration, enter **N**. Otherwise, enter **Y** to make the necessary updates. You can provide specific commands to be executed when serving the app locally by entering them as development commands and pressing Enter. After all the configurations are updated, the Slate app will be created in your project directory. The **{{%badge%}}catalyst.json{{%/badge%}}** file will be updated with the details of the newly created Slate app. You can also create a Slate application by directly providing a name for your application and the required framework. Execute the following command in your terminal: {{%cli%}} catalyst slate:create --name &lt;name&gt; --framework &lt;framework_name&gt;{{%/cli%}} <br> ### Link a Slate App In order to deploy an existing project to Slate, you must link the project's root path with the Slate service. For this you will have to initialize the Slate service first. This linking establishes a connection between your project directory and the Slate service locally and in order to deploy to the console, you must use the deploy command. This option can be used when an application of a supported framework by Slate was not originally initialized as a Slate service, but you later prefer to deploy it as a Slate service. To link the directory with Slate: 1. Execute the below command in the terminal from the app's project directory: {{%cli%}}catalyst slate:link{{%/cli%}} 2. Select the source path that has to be linked to the Slate service and press **Enter**. 3. Provide a name for your application as required and press **Enter**. The framework of the application will be detected automatically and listed along with its **install**, **build** commands, and the **build path**. Otherwise, you will be able to select the framework manually from the terminal. 4. If you wish to proceed with the default configuration, enter **N**. Otherwise, enter **Y** to make the necessary updates. You can provide specific commands to be executed when serving the app locally by entering them as development commands and pressing Enter. After the configurations are set, an entry will be made in the {{%badge%}}catalyst.json{{%/badge%}} file to establish a connection between the project directory's path and the Slate service. <br> ### Unlink a Slate App You can remove the connection between your project directory and the Slate service by using the steps listed below. This operation will only remove the Slate configuration in your project directory and not in the Catalyst console, if you have already deployed the application. 1. Execute the following command in the terminal from the app's project directory: {{%cli%}}catalyst slate:unlink{{%/cli%}} 2. Navigate using the arrow keys to choose the application and click **Enter** to confirm. 3. Enter **Yes** to remove the Slate configuration from your application, its entry in the {{%badge%}}catalyst.json{{%/badge%}} file and the source code of the application. Enter **No** to remove only the entry in the {{%badge%}}catalyst.json{{%/badge%}} file while retaining the source code of your application. For the same operation, you can also use the below command by directly providing the name of the application: {{%cli%}}catalyst slate:unlink --name &lt;&lt;app_name&gt;&gt;{{%/cli%}} <br> ### Serve a Slate App Locally You can host the Slate application in your Catalyst project locally by navigating to your project directory in local and executing the following command: {{%cli%}}catalyst serve --only slate{{%/cli%}} This catalyst serve command launches your Slate app locally by executing the {{%badge%}}dev_command{{%/badge%}} defined in your {{%badge%}}cli-config.json{{%/badge%}} file. This {{%badge%}}dev_command{{%/badge%}} will be configured in the file when you {{%link href="/en/slate/help/deploy-from-cli/#link-a-slate-app" %}}link{{%/link%}} or {{%link href="/en/slate/help/deploy-from-cli/#create-an-additional-slate-app" %}}create a Slate app{{%/link%}}. Before running the catalyst serve command, you must update the ensure that the {{%badge%}}dev_command{{%/badge%}} to include the start command of your application with the {{%badge%}}ZC_SLATE_PORT{{%/badge%}}. For example, if you're working with a React app, update the command to: {{%badge%}}PORT=$ZC_SLATE_PORT npm start{{%/badge%}} You will have to configure your start command here based on the framework of your application. You can refer to the below table for the default start commands of the frameworks supported by Catalyst Slate. You can modify the start command based on your application's needs, if required. <table class="content-table"> <thead> <tr> <th class="w25p">Framework</th> <th class="w75p">Default Start Command</th> </tr> </thead> <tbody> <tr> <td>Create React App</td> <td>{{%badge%}}PORT=$ZC_SLATE_PORT npm start{{%/badge%}}</td> </tr> <tr> <td>Solid JS(Vite)</td> <td>{{%badge%}}npm run dev -\- -\-port $ZC_SLATE_PORT{{%/badge%}}</td> </tr> <tr> <td>React + Vite</td> <td>{{%badge%}}npm run dev -\- -\-port $ZC_SLATE_PORT{{%/badge%}}</td> </tr> <tr> <td>Next.js</td> <td>{{%badge%}}npm run dev -\- -\-port $ZC_SLATE_PORT{{%/badge%}}</td> </tr> <tr> <td>Astro</td> <td>{{%badge%}}npm run dev -\- -\-port $ZC_SLATE_PORT{{%/badge%}}</td> </tr> <tr> <td>Angular</td> <td>{{%badge%}}npm start -\- -\-port $ZC_SLATE_PORT{{%/badge%}}</td> </tr> <tr> <td>Vue (Vite)</td> <td>{{%badge%}}npm run dev -\- -\-port $ZC_SLATE_PORT{{%/badge%}}</td> </tr> <tr> <td>Preact</td> <td>{{%badge%}}npm run dev -\- -\-port $ZC_SLATE_PORT{{%/badge%}}</td> </tr> <tr> <td>Svelte</td> <td>{{%badge%}}npm run dev -\- -\-port $ZC_SLATE_PORT{{%/badge%}}</td> </tr> </tbody> </table> When you serve the slate app, the start command mentioned in the cli-config.json file runs the application on a local server and the CLI will display the URL from which you can access your Slate application. After you have finished testing your application locally, you can proceed to deploy it to the remote console. We will discuss about the deployment commands in the next section. ### Deploy to Slate You can deploy your front-end web application in Catalyst Slate using the steps below. Before you deploy any application in Slate, please make sure the project directory has been linked to the Slate service. For this, you can use the {{%link href="/en/cli/v1/working-with-slate/link-slate-app" %}}{{%badge%}}catalyst slate:link{{%/badge%}}{{%/link%}} command. Execute the following command in your terminal from the Slate service's project directory: {{%cli%}}catalyst deploy slate{{%/cli%}} This deploys all the Slate components present in your project directory to the {{%link href="/en/deployment-and-billing/environments/development-environment/" %}}Catalyst development environment{{%/link%}}. You can use the below option to provide a deployment message for the Slate deployment. {{%cli%}}catalyst deploy slate -m "deployment message"{{%/cli%}} To deploy a specific app from the project directory to Slate, you can use the following command: {{%cli%}}catalyst deploy --only slate:appname{{%/cli%}} If you wish to deploy the application to the production environment, use the below command. Ensure you have accessed the production environment in the console before initiating a production deployment. {{%cli%}} catalyst deploy slate --production {{%/cli%}} -------------------------------------------------------------------------------- title: "Web Caching" description: "Learn more about enabling and disabling cache for your Catalyst Slate deployments." last_updated: "2026-03-18T07:41:08.658Z" source: "https://docs.catalyst.zoho.com/en/slate/help/cache/" service: "Slate" related: - Deploy from Private Git Repository (/en/slate/help/git-integration/deploy-from-private-repository) - Deploy from Public Git Repository (/en/slate/help/git-integration/deploy-from-public-repository) - Deploy Slate Templates (/en/slate/help/git-integration/deploy-template) - Deploy by Direct Upload (/en/slate/help/direct-upload) -------------------------------------------------------------------------------- # Web Caching in Slate Web caching is the process of storing copies of deployed code temporarily at various edge servers in a network after the first hit to the {{%link href="/en/slate/help/slate-access-url" %}}Slate URL{{%/link%}}. The subsequent requests to the same URL will be fulfilled from the cached edge server rather than fetching the data again from the origin. This process of serving content from a cache instead of fetching it each time from the web server significantly improves your web application's performance, leading to faster loading times and reduced server load. ### Enable Web Cache You can enable web cache for your application by following the below steps: 1. Click on any deployment and navigate to the **Configuration** tab in the left pane. 2. Expand **General Settings** and click on the ellipsis icon in the **Cache** section. The cache will be enabled by default for your deployment. <br> ### Disable Web Cache 1. You can disable it, if not required by clicking **Disable**. 2. Click **Disable** to confirm the operation. Cache will now be disabled for your current deployment. {{%note%}}{{%bold%}}Note:{{%/bold%}} You can enable the cache at any time when you need it again.{{%/note%}} -------------------------------------------------------------------------------- title: "Memory" description: "Explore memory configuration options for Slate deployments, with a focus on Next.js frameworks." last_updated: "2026-03-18T07:41:08.658Z" source: "https://docs.catalyst.zoho.com/en/slate/help/memory/" service: "Slate" related: - Deploy from Private Git Repository (/en/slate/help/git-integration/deploy-from-private-repository) - Deploy from Public Git Repository (/en/slate/help/git-integration/deploy-from-public-repository) - Deploy Slate Templates (/en/slate/help/git-integration/deploy-template) - Deploy by Direct Upload (/en/slate/help/direct-upload) -------------------------------------------------------------------------------- # Memory Memory allocation is crucial for your application because it determines how efficiently it can handle processes, data storage, and user requests. With sufficient memory, your application can manage tasks faster and accommodate higher loads, enhancing overall performance and stability. Allocating the right amount of memory helps avoid bottlenecks and ensures the app runs smoothly, even during peak usage. {{%note%}}{{%bold%}}Note:{{%/bold%}} This configuration is applicable only for applications built in the Next.js framework.{{%/note%}} You can allocate memory for your application's deployment based on its load and performance requirements. You can choose to allocate any of the following from the supported memory configurations listed below: * **128 MB** * **256 MB** * **512 MB** * **1024 MB** * **2048 MB** If you do not specifically configure a memory for your application, the default memory of **256 MB** will be allocated for its deployment. Please follow the below steps to configure the memory required for your deployment: 1. Click on any deployment and navigate to the **Configuration** tab in the left menu. Under **General Settings**, you can click on the edit memory option as shown in the screenshot below. 2. Choose the required memory space and click the tick icon. The memory space for your application's execution has now been successfully allocated. You can always edit the default or previously configured memory after analyzing its requirements, and optimize its performance and cost by selecting an optimal value. -------------------------------------------------------------------------------- title: "Environment Variables" description: "Learn about configuring environment variables for app deployments in Catalyst Slate." last_updated: "2026-03-18T07:41:08.658Z" source: "https://docs.catalyst.zoho.com/en/slate/help/environment-variables/" service: "Slate" related: - Deploy from Private Git Repository (/en/slate/help/git-integration/deploy-from-private-repository) - Deploy from Public Git Repository (/en/slate/help/git-integrationdeploy-from-public-repository) - Deploy Slate Templates (/en/slate/help/git-integrationdeploy-template) - Deploy by Direct Upload (/en/slate/help/direct-upload) - Catalyst Production Environment (/en/deployment-and-billing/environments/production-environment/) -------------------------------------------------------------------------------- # Environment Variables ### Introduction Environment variables are key-value pairs that can be defined outside your application's source code. These variables give the following advantages : * **Security** : Environment variables help keep sensitive information safe. Things like API keys, tokens, and database credentials should never be stored directly in your code, as anyone with access to your code could see them. Instead, environment variables store these secrets securely, keeping them out of your codebase. * **Configuration Flexibility** : By using environment variables, you can easily switch settings based on the deployment environment. For example, you might use a different API endpoint for local development than for production, or toggle debugging tools on and off. This flexibility lets you control how your app behaves in different scenarios without modifying the code. * **Scalability** : Environment variables allow you to create reusable configurations. If you have multiple projects that share similar settings (like API keys or endpoints), you can define those settings once as environment variables and use them across projects, making your setup much easier to manage. <br> #### Where to Use Environment Variables Environment variables are typically used in these areas: 1. **API Keys and Endpoints**: Store keys and endpoints to external services, like third-party APIs (e.g., {{%badge%}}REACT_APP_API_KEY{{%/badge%}}, {{%badge%}}REACT_APP_BASE_URL{{%/badge%}}). This way, sensitive information is kept secure, and you can swap out endpoints based on the deployment environment. 2. **Feature Flags**: If you want to enable conditionally or disable certain features, environment variables can act as feature flags. For example, setting {{%badge%}}REACT_APP_ENABLE_NEW_FEATURE{{%/badge%}} to {{%badge%}}true{{%/badge%}} or {{%badge%}}false{{%/badge%}} allows you to toggle features without changing the code. #### Best practices Here are two key practices you can follow to ensure your application remains secure throughout its lifecycle: * Regularly review and rotate your API keys and other secrets to maintain security. * Configure different values for variables in development, preview, and production environments to ensure proper isolation and security. <br> ### Create Environment Variables You can create environment variables for your applications directly from the Catalyst console. The environment variables of applications deployed using {{%link href="/en/slate/help/git-integration/deploy-from-private-repository" %}}private Git Integration{{%/link%}}, {{%link href="/en/slate/help/git-integration/deploy-template" %}}Slate templates{{%/link%}}, or {{%link href="/en/slate/help/git-integration/deploy-from-public-repository" %}}public repository{{%/link%}} integration will be created in Catalyst's development environment by default. Follow the below steps to create environment variables in Slate: 1. Click on any deployment, and navigate to the **Configuration** tab in the left pane and expand **Environment Variables**. 2. Click **Add Variable**. 3. Click **Save**. You can add any number of variables as required for your application. {{%note%}}{{%bold%}}Note:{{%/bold%}} To call the environment variables during your application deployment, make sure to use the following syntax:{{%badge%}}process.env.[variable_name]{{%/badge%}}{{%/note%}} <br> ### Create Variables in Production If you have {{%link href="/en/deployment-and-billing/environments/production-environment/" %}}deployed your Catalyst project to production{{%/link%}}, you can create environment variables specific to the production environment, if required. You can use the same above mentioned steps to create variables in production. {{%note%}}{{%bold%}}Note:{{%/bold%}} You will not be able to access production variables in your application if your production environment is disabled.{{%/note%}} -------------------------------------------------------------------------------- title: "Custom Domains" description: "Learn how to map custom domains with Slate deployments." last_updated: "2026-03-18T07:41:08.658Z" source: "https://docs.catalyst.zoho.com/en/slate/help/custom-domains/" service: "Slate" related: - Deploy from Private Git Repository (/en/slate/help/git-integration/deploy-from-private-repository) - Deploy from Public Git Repository (/en/slate/help/git-integration/deploy-from-public-repository) - Deploy Slate Templates (/en/slate/help/git-integration/deploy-template) - Deploy by Direct Upload (/en/slate/help/direct-upload) -------------------------------------------------------------------------------- # Custom Domains ### Introduction Catalyst Slate allows you to host your applications under your own domain name instead of the default Catalyst subdomain. This is useful for branding and providing a more professional appearance for your application. Slate makes it easy to add, configure, and manage custom domains. After you have mapped your custom domain to the {{%link href="/en/slate/help/slate-access-url" %}}Slate Access URL{{%/link%}}, you will be able to access your application directly from your custom domain URL and share it with end-users. You can learn about how Catalyst Domain Mapping works from {{%link href="/en/slate/help/custom-domains" %}}this help page{{%/link%}}. Here are some key points to remember while enabling custom domains: You must already have the domain hosted live to map it with the deployed application using Slate. * The Slate Access URL provided by Catalyst will still be active after you map it with an external domain. You can access the client endpoint with both the development or production Access URLs, based on your preferred environment. * You can associate only one unique domain with an application. You will not be able to add the same domain address for another application in Slate simultaneously. * You can disable or delete the mapping at any point of time and access the application using the default access URL generated for the application. <br> ### Map a Custom Domain Follow the below steps to map your custom domain with the application deployed using Slate: 1. After you have deployed your application using Slate, the **Deployment Overview** screen will be displayed. In the **Domain Mapping** section, click **Add Domain**. 2. Enter your custom domain URL and click **Next**. {{%note%}}{{%bold%}}Note:{{%/bold%}}{{%badge%}}catalystslate.zylker.com{{%/badge%}} is an example used for demonstration purposes only. You can map any domain of your choice to the deployed application in Slate.{{%/note%}} 3. In this step, you will need to create a CNAME record for your custom domain and associate the entries with Catalyst using your hosting provider’s administrative console. When you host your custom domain, your domain provider will give you access to an administrative console where you can configure and manage your domain. The consoles may vary depending on the domain provider, but you must create the records shown below and map them with Catalyst. * **Step 1:** Configure the value provided under Step 1 in the console in your DNS settings as a CNAME record. This step is primarily for Catalyst to ensure that the DNS service is valid. Click **Verify** to initiate the verification. <br> The changes might take some time to be reflected on the DNS server, based on the DNS register and the domain provider that you are using. After the first console shows the verified badge for the first CNAME record, follow Step 2. <br> * **Step 2:** Configure the new value shown under Step 2 in the console in your DNS settings as a new CNAME record. This will include the host name you provided previously. Click **Verify** again. After both the records are verified, click **Next**. 4. You must now request a Group SSL certificate from Catalyst for your domain and have it installed through Zoho. Catalyst will provide the certificate and activate it within 48 hours. You can then install it for your domain. Click **Request**. {{%note%}}{{%bold%}}Note:{{%/bold%}} * Catalyst provides this security certificate for your domain free of charge. * This is a mandatory procedure, as your Catalyst application will not be accessible at that domain without an SSL certificate from Zoho. Even if you already have an SSL certificate enabled for your domain, you must use only Zoho’s SSL certificate for the domain to be mapped successfully. * Catalyst will auto-renew the SSL certificate each time automatically before it expires. * If you have edited your access URL after enabling a custom domain, then you must mandatorily map the new access URL with your domain again.{{%/note%}} 5. The domain mapping has been initiated successfully. Check your email for notifications about the mapping process. The custom domain is mapped successfully now and is listed here. You can now access the application using the mapped custom domain URL. -------------------------------------------------------------------------------- title: "Slate Access URL" last_updated: "2026-03-18T07:41:08.658Z" source: "https://docs.catalyst.zoho.com/en/slate/help/slate-access-url/" service: "Slate" -------------------------------------------------------------------------------- # Slate Access URL An Access URL is auto-generated whenever any application is deployed using Slate. This URL can be used to access the hosted application instantly or can be mapped with your preferred custom domain as well. You can check out {{%link href="/en/slate/help/custom-domains" %}}this help section{{%/link%}} to know how to map custom domains in Slate. The default Slate URL structure looks like this: {{%badge%}}yourdomain.onslate.com{{%/badge%}} You can customize the subdomain portion of the URL. If your chosen subdomain is unavailable, you'll be prompted to enter a unique one. By default, this URL can be used to access the application hosted in Catalyst Slate. Here's a list of supported DCs and the access URL structure in each of them: <table class="content-table"> <thead> <tr> <th>Supported DC</th> <th>Slate Access URL </th> </tr> </thead> <tbody> <tr> <td>{{%badge%}}US{{%/badge%}}</td> <td>yourdomain.onslate.com</td> </tr> <tr> <td>{{%badge%}}EU{{%/badge%}}</td> <td>yourdomain.onslate.eu</td> </tr> <tr> <td>{{%badge%}}IN{{%/badge%}}</td> <td>yourdomain.onslate.in</td> </tr> <tr> <td>{{%badge%}}AU{{%/badge%}}</td> <td>yourdomain.onslate.au</td> </tr> <tr> <td>{{%badge%}}CA{{%/badge%}}</td> <td>yourdomain.onslate.ca</td> </tr> </tbody> </table> -------------------------------------------------------------------------------- title: "Deployment Previews" last_updated: "2026-03-18T07:41:08.659Z" source: "https://docs.catalyst.zoho.com/en/slate/help/deployment-previews/" service: "Slate" -------------------------------------------------------------------------------- # Deployment Previews Deployment previews let you and your team experience changes from each deployment in a sandboxed environment without pushing them to production. This allows you to view, test, and validate updates safely before they go live. When a deployment is triggered in Slate, a unique preview URL is automatically generated. This URL provides access to the deployed version of your application and serves as a live preview. The preview remains accessible until the deployment is manually deleted from the Catalyst console. Slate creates a new URL by default every time any of the following takes place: 1. You manually initiate a deployment from the Catalyst console either by integrating and deploying code from your {{%link href="/en/slate/help/git-integration/deploy-from-private-repository" %}}private Git repository{{%/link%}} or providing any {{%link href="/en/slate/help/git-integration/deploy-from-public-repository" %}}public repository URL{{%/link%}}. 2. An automated deployment is triggered in Slate when any changes are pushed to the integrated Git repository's branch or pull request. 3. You create a Slate deployment by executing commands in the {{%link href="/en/slate/help/deploy-from-cli" %}}Catalyst CLI{{%/link%}}. 4. You upload your application's files as zip directly in the Catalyst console using the {{%link href="/en/slate/help/direct-upload" %}}Direct Upload{{%/link%}} feature. The key advantages of deployment previews are: * **Enhanced collaboration**: Teams can share preview URLs with developers, designers, and non-technical stakeholders facilitating collaborative reviews. This ensures everyone is on the same page and can see the exact changes in real time. * **Early Bug Detection**: By providing a live environment for every code change, deployment previews help in catching bugs and issues early in the development cycle. This reduces the risk of deploying problematic code to production. * **Version Comparison**: Teams can compare different versions of the site side-by-side, using access URLs from different branches or pull requests to evaluate changes and decide on the best implementation. * **Immediate Feedback on Changes**: Deployment preview URLs provide an immediate, live version of changes made to your code, allowing developers and stakeholders to test and review new features, bug fixes, and updates in real time. You can view the Slate URLs of all your deployments from the Slate Home Page in the console. Alternatively, you can also fetch the access URL of a particular deployment from the **Deployment Overview** section of that deployment. -------------------------------------------------------------------------------- title: "Rollback Deployment" description: "Learn the procedure to rollback a current deployment to its previous version directly from the Catalyst console." last_updated: "2026-03-18T07:41:08.659Z" source: "https://docs.catalyst.zoho.com/en/slate/help/rollback-deployment/" service: "Slate" -------------------------------------------------------------------------------- # Rollback Deployment Rolling back deployments in Catalyst Slate is a simple process that allows you to revert to a previous version of your application if something goes wrong with the current deployment. This feature ensures stability and minimizes downtime, providing a safety net during the development and deployment cycles. Roll backing a deployment has two major advantages: * **Minimized Downtime**: Quickly revert to a stable version of your application, minimizing any downtime or disruption caused by a faulty deployment. * **Simplify Troubleshooting**: By rolling back to a known good state, you can troubleshoot and fix issues in the problematic deployment without the pressure of having a live issue affecting users. To rollback a particular deployment, please follow the below steps: 1. Navigate to the **Deployment Overview** tab of the deployment. In the **Live commit** details section, click **Rollback**. 2. Click **Confirm** to proceed with the rollback operation. {{%note%}}{{%bold%}}Note:{{%/bold%}} You can roll back the current deployment to the most recent previous version of the application. However, earlier versions cannot be rolled back to.{{%/note%}} -------------------------------------------------------------------------------- title: "Fix a Failed Deployment" description: "Learn more about syncing the latest commit changes to the current deployment in Slate directly from the Catalyst console." last_updated: "2026-03-18T07:41:08.659Z" source: "https://docs.catalyst.zoho.com/en/slate/help/fix-failed-deployment/" service: "Slate" related: - Deployments in Slate (/en/slate/help/deployment-overview) -------------------------------------------------------------------------------- # Fix a Failed Deployment When a deployment fails in Catalyst Slate, you can use the **Sync Now** feature to quickly merge the changes in the latest Git commit to the current deployment. This feature helps to troubleshoot and fix the failed deployment, ensuring the changes are fully pushed to Catalyst Slate and thus resolving any discrepancies causing the failure. The most common issues for deployment failure include build errors, missing environment variables, or misconfigured settings. To sync your latest changes with the current Slate deployment, you can follow the below steps: 1. Navigate to the Deployment Overview tab of the deployment. In the **Live commit details** section, click **Sync Now**. 2. Click **Confirm** to proceed with the sync. -------------------------------------------------------------------------------- title: "Monitor & Manage Deployment" description: "Learn more about the different aspects of Deployment History and the statuses associated with Catalyst Slate deployments." last_updated: "2026-03-18T07:41:08.659Z" source: "https://docs.catalyst.zoho.com/en/slate/help/monitor-deployment/" service: "Slate" -------------------------------------------------------------------------------- # Monitor and Manage Deployments ### Deployment History In Catalyst Slate, you can view the list of deployments made to a application by simply navigating to **Deployment History** in the left menu. This screen displays the list of deployments to the application. It also displays the following details about the deployment: * **Commit ID**: The commit ID issued by the Git provider * **Commit Message**: The commit message given to the particular commit when pushing changes in the Git provider. * **Build Time**: The total time taken for the build and deploy cycle to complete the deployment. * **Deployment Status**: The current status of the particular deployment. The deployment status can be any one of the following: * **Queued**: If a deployment is already in progress and another deployment is triggered simultaneously, the status of the second deployment will be marked as **"Queued"**. * **Running**: If the deployment is currently in progress, then the status will be marked as **"Running"**. * **Success**: When the deployment has been executed successfully, the status will be marked as **"Success"**. * **Failed**: While deploying the application, if there were any errors encountered that blocks the successful completion of the deployment, then the status will be marked as **"Failed"**. You can troubleshoot issues by examining the build logs of the particular deployment. * **Deployed On**: This denotes the time frame in which the particular deployment was executed. * **Build Logs**: You can click on the logs icon to view the detailed execution logs of the deployment. <br> ### Deployment Configuration In Catalyst Slate, you can configure specific settings for each deployment by simply navigating to **Configuration** tab in the left menu. * **Frameworks & Build Command** : In this section, you can rename or delete the deployment. You can also modify the root path, build path, as well as the install and build commands if needed. * **Cache** : You can enable or disable cache settings for the deployment. Refer to {{%link href="/en/slate/help/cache" %}}this section{{%/link%}} for more details. * **Environment Variable** : You can add environment variables required for the deployment here. Refer to {{%link href="/en/slate/help/environment-variables" %}}this section{{%/link%}} for more details. Similarly, you can configure the app level settings by simply navigating to the App Home page and click on **App Settings** of an app. Similar to deployment level settings, you can configure all the above settings for the entire app, which will be applicable to all deployments of the app by default. -------------------------------------------------------------------------------- title: "Delete Deployment" description: "Learn more about deleting deployments in Catalyst Slate and also disabling deployments directly from the Catalyst console." last_updated: "2026-03-18T07:41:08.659Z" source: "https://docs.catalyst.zoho.com/en/slate/help/delete-deployment/" service: "Slate" -------------------------------------------------------------------------------- # Delete Deployment Deleting deployments from Catalyst Slate simply removes the particular deployed version of the application permanently from your Catalyst project. The deleted deployment will no longer be accessible using the Slate Access URL and also the custom domain URL (if domain mapping is done), but you can deploy the same application as a newer version anytime required. You can use this feature to clean up old or unnecessary deployments. However, exercise caution to ensure that this action does not affect your current live application. You can delete any specific deployment in Catalyst Slate by following the below steps: 1. Navigate to the **Overview** tab in the left pane. This page displays details of the current deployment. Click on the ellipsis icon in the top-right corner and click **Delete**. 2. Enter the deployment name and click **Delete** to confirm deletion. The deployment will be deleted successfully. You can also disable a deployment temporarily, if required, by clicking on the **Disable** button as shown in the screenshot below. ### Git Integration -------------------------------------------------------------------------------- title: "Deploy a Slate Template" description: "Learn about deploying a front-end web application quickly by using the templates available in the Slate Starter Library." last_updated: "2026-03-18T07:41:08.660Z" source: "https://docs.catalyst.zoho.com/en/slate/help/git-integration/deploy-template/" service: "Slate" related: - Preview a Deployment (/en/slate/help/deployment-previews) - Cache a Deployment (/en/slate/help/cache) - Configure Environment Variables (/en/slate/help/environment-variables) - Custom Domain Mapping (/en/slate/help/custom-domains) - Monitor Deployments (/en/slate/help/monitor-deployment) - Fix a Failed Deployment (/en/slate/help/fix-failed-deployment) - Rollback a Deployment (/en/slate/help/rollback-deployment) -------------------------------------------------------------------------------- # Deploy a Slate Template ### Introduction Catalyst Slate provides ready-made application templates which can be used to get a project up and running with minimal setup efforts required from your end. There's a huge gallery of templates available for various use cases and configured using different client frameworks like {{%link href="https://nextjs.org/" %}}Next.js{{%/link%}}, {{%link href="https://angular.dev/" %}}Angular{{%/link%}}, {{%link href="https://astro.build/" %}}Astro{{%/link%}}, {{%link href="https://react.dev/" %}}React{{%/link%}}, {{%link href="https://www.solidjs.com/" %}}SolidJS{{%/link%}}, {{%link href="https://preactjs.com/" %}}Preact{{%/link%}}, {{%link href="https://svelte.dev/" %}}Svelte{{%/link%}}, {{%link href="https://vuejs.org/" %}}Vue{{%/link%}}, {{%link href="https://vitejs.dev/" %}}Vite{{%/link%}} and {{%link href="https://nuxt.com/" %}}Nuxt{{%/link%}}. You can simply select a pre-built template from Slate's Starter Template Gallery and deploy it to using Slate. The key benefits of Slate templates include: * **Reduced Setup Time and Focus on Development**: Slate templates allow you to save time by eliminating the need to set up boilerplate code for new projects repeatedly and eventually spend more time on developing unique features rather than configuring the initial project setup. * **Rapid Deployment and Minimal Learning Curve**: Slate templates allow you to deploy fully functional applications in just a few clicks. New developers can learn from well-structured, pre-built projects that demonstrate how to set up and configure different types of applications using varied frameworks. Experienced developers can use templates as reference implementations for best practices in Slate deployments. <br> ### Steps to Deploy You can leverage Slate templates by following the below steps: 1. Navigate to the **Catalyst Slate** service in the console. In the **Starter Templates** section, click **Browse Templates**. 2. You can browse through templates of varied use cases and frameworks and select the template of your choice. 3. In the **Create Deployment** pop-up, select the required Git provider and authenticate your account. The source code of the chosen Slate template will be pushed to a new repository in the integrated Git account. 4. The template name will be auto-populated as the repository name by Slate. You can edit it, if required. Provide a deployment name of your choice. 5. The framework and node runtime of the application will be automatically populated based on the chosen template. You can edit the node run time, if required. {{%note%}}{{%bold%}}Note:{{%/bold%}} The Node.js runtime lets you run JavaScript code outside a web browser, like on a server or your computer. It helps you build websites and apps by giving JavaScript access to files, networks, and other system tools. {{%/note%}} 6. In this deployment method, a new repository will be automatically created in your Git account, and the template code will be pushed into it. You can toggle the button to create a private repository as shown in the screenshot below. 7. Enable **Auto Deploy**, so that any code pushed to the repository will deployed automatically using Slate. The **Show Advanced Options** tab shows the output path, build command, and start command for the application deployment, and these fields will be auto-populated. 8. Click **Deploy** to deploy the application to Slate. {{%note%}}{{%bold%}}Note:{{%/bold%}} * The output path is the directory where your application gets compiled or built for production. * The build command is the script that transforms your development code into production code. * The install command fetches and installs all dependencies required for your project. For example, the install commands for various client-side frameworks are: * **React, Next.js, Vue, Angular, Svelte** → {{%badge%}}npm install{{%/badge%}} or {{%badge%}}yarn install{{%/badge%}} * **Astro** → {{%badge%}}npm install{{%/badge%}} or {{%badge%}}pnpm install{{%/badge%}} * **Vite** → {{%badge%}}npm install{{%/badge%}} or {{%badge%}}yarn install{{%/badge%}} * **SolidJS** → {{%badge%}}npm install{{%/badge%}} or {{%badge%}}pnpm install{{%/badge%}} {{%/note%}} The deployment has been successfully completed, and you can view the detailed logs of the deployment as shown in the screenshot below. <br> You can click **Go to Manage** to view the overview details of the deployment as shown in the screenshot below. Click **Preview** to view the deployed application. You can fetch the generated {{%link href="/en/slate/help/slate-access-url" %}} access URL{{%/link%}} of your application as shown in the screenshot above. You can edit the URL by clicking **Edit URL**. <br> 1. You can disable **Auto-Deploy** for this deployment by clicking **Change**. 2. Enter the deployment name and click **Disable**. <br> You can {{%link href="/en/slate/help/fix-failed-deployment" %}}sync the latest commit{{%/link%}} with the current deployment by clicking on the **Sync Now** button. You can also map the generated Slate URL with your {{%link href="/en/slate/help/custom-domains" %}}custom domain{{%/link%}} if required. You can view the list of deployments made to your application by switching to the **History** tab in the left pane. Refer to {{%link href="/en/slate/help/monitor-deployment" %}}this help section{{%/link%}} to learn more about it. You can {{%link href="/en/slate/help/cache" %}}enable cache{{%/link%}} for your deployment by navigating to the **Configuration** tab in the left pane. You also have the option to configure {{%link href="/en/slate/help/environment-variables" %}}environment variables{{%/link%}} required for your deployment, if required. -------------------------------------------------------------------------------- title: "Deploy from Private Repository" description: "Learn about deploying a front-end web application in Slate directly from a private repository by integarating with any of the supported Git providers." last_updated: "2026-03-18T07:41:08.660Z" source: "https://docs.catalyst.zoho.com/en/slate/help/git-integration/deploy-from-private-repository/" service: "Slate" related: - Preview a Deployment (/en/slate/help/deployment-previews) - Cache a Deployment (/en/slate/help/cache) - Configure Environment Variables (/en/slate/help/environment-variables) - Custom Domain Mapping (/en/slate/help/custom-domains) - Monitor Deployments (/en/slate/help/monitor-deployment) - Fix a Failed Deployment (/en/slate/help/fix-failed-deployment) - Rollback a Deployment (/en/slate/help/rollback-deployment) -------------------------------------------------------------------------------- # Git Integration Catalyst Slate allows you to {{%link href="/en/getting-started/set-up-a-catalyst-project/integrations-settings/#github-integration" %}}integrate with common Git providers{{%/link%}} and automatically deploy your applications. This enables seamless workflows and deployment management, enhancing developer productivity and deployment scalability to a greater extent. The supported Git providers include: * **{{%link href="https://github.com/" %}}GitHub{{%/link%}}** * **{{%link href="https://about.gitlab.com/" %}}GitLab{{%/link%}}** * **{{%link href="https://bitbucket.org/product/" %}}Bitbucket{{%/link%}}** You can deploy code built in any Node based client framework of your choice. Additionally, Slate provides native support for a wide range of frameworks as well. Refer to {{%link href="/en/slate/help/introduction" %}}this help page{{%/link%}} to know the full list of supported frameworks. We will now delve deeper into each deployment method in detail in the upcoming help sections. <br> ## Deploy from Private Repository Catalyst Slate allows you to integrate with your Git accounts seamlessly, access your private repositories, and directly deploy applications from those repositories. To deploy your web client application using the private repository integration method, please ensure to follow the below steps: 1. Navigate to the **Catalyst Slate** service in the console and click **Start Exploring**. 2. Select your preferred Git provider to integrate with Slate. 3. You will be redirected to **Catalyst Settings->Git Integration**. Click **Add Account**. 4. Click **Agree** to accept the terms and conditions of the Git provider. The Git account will now be integrated with Catalyst and listed here. You can simply close this tab and navigate back to Slate. The integrated Git account and its list of repositories will be displayed here. 5. You can click on the required repository to initiate a Slate deployment. In the **Create Deployment** pop-up, the repository name will automatically be considered as the application name as shown in the screenshot below. 6. Select the branch or commit of the repository that has to be deployed using Slate. 7. Provide a name for your deployment. 8. Choose the front-end framework of your application using the drop-down menu. 9. The Node runtime will be set to **Node 18** by default. You can change it if required from the supported runtimes in the drop-down menu. {{%note%}}{{%bold%}}Note:{{%/bold%}} * The Node.js runtime lets you run JavaScript code outside a web browser, like on a server or your computer. It helps you build websites and apps by giving JavaScript access to files, networks, and other system tools. * You should choose a runtime that matches the Node.js version your application is built with, as specified in your package.json file. {{%/note%}} {{%note%}}{{%bold%}}Note:{{%/bold%}} We now support **Node.js version 20** as well, which will be selected as the default option.{{%/note%}} 10. Set the root path of your application. {{%note%}}{{%bold%}}Note:{{%/bold%}} The root path (often written as "/") refers to the base directory where your client application's main files, including the source code, configuration files, and dependencies, are located.{{%/note%}} 11. Enable **Auto Deploy**, so that any code pushed to the specific branch will get automatically deployed using Slate. This option is not applicable to commits. This step is optional. 12. The output path, build command, and the start command will be auto-populated based on the detected framework. You can edit them, if required. {{%note%}}{{%bold%}}Note:{{%/bold%}} * The output path is the directory where your application gets compiled or built for production. * The build command is the script that transforms your development code into production code. * The install command fetches and installs all dependencies required for your project. For example, the install commands for various client-side frameworks are: * **React, Next.js, Vue, Angular, Svelte** → {{%badge%}}npm install{{%/badge%}} or {{%badge%}}yarn install{{%/badge%}} * **Astro** → {{%badge%}}npm install{{%/badge%}} or {{%badge%}}pnpm install{{%/badge%}} * **Vite** → {{%badge%}}npm install{{%/badge%}} or {{%badge%}}yarn install{{%/badge%}} * **SolidJS** → {{%badge%}}npm install{{%/badge%}} or {{%badge%}}pnpm install{{%/badge%}} {{%/note%}} 13. Set the required {{%link href="/en/slate/help/environment-variables" %}}environment variables{{%/link%}} for the deployment, if required. This step is optional. 14. Click **Deploy**. You can click on **Preview** to view your live application. Click on **View Deployment Summary** for more details and configurations about the deployment. You can fetch the generated {{%link href="/en/slate/help/manage-deployment/slate-access-url" %}}access URL{{%/link%}} of your application as shown in the screenshot below. You can edit the subdomain part of the URL by clicking on **Edit URL**. You can disable **Auto-Deploy** for this deployment by clicking on **Change**. 15. Enter the deployment name and click **Disable**. You can {{%link href="/en/slate/help/fix-failed-deployment" %}}sync the latest commit{{%/link%}} with the current deployment by clicking on the **Sync Now** button. You can also map the generated Slate URL with your {{%link href="/en/slate/help/custom-domains" %}}custom domain{{%/link%}} if required. You can view the list of deployments made to your application by switching to the **History** tab in the left pane. Refer to {{%link href="/en/slate/help/monitor-deployment" %}}this help section{{%/link%}} to learn more about it. You can {{%link href="/en/slate/help/cache" %}}enable cache{{%/link%}} for your deployment by navigating to the **Configuration** tab in the left pane. You also have the option to configure {{%link href="/en/slate/help/environment-variables" %}}environment variables{{%/link%}} required for your deployment, if required. In the next section, we will discuss how to deploy an application directly from a public repository using Slate. -------------------------------------------------------------------------------- title: "Deploy from Public Repository" description: "Learn about deploying a front-end web application in Slate directly from a public repository by integarating with any of the supported Git providers." last_updated: "2026-03-18T07:41:08.661Z" source: "https://docs.catalyst.zoho.com/en/slate/help/git-integration/deploy-from-public-repository/" service: "Slate" related: - Preview a Deployment (/en/slate/help/deployment-previews) - Cache a Deployment (/en/slate/help/cache) - Configure Environment Variables (/en/slate/help/environment-variables) - Custom Domain Mapping (/en/slate/help/custom-domains) - Monitor Deployments (/en/slate/help/monitor-deployment) - Fix a Failed Deployment (/en/slate/help/fix-failed-deployment) - Rollback a Deployment (/en/slate/help/rollback-deployment) -------------------------------------------------------------------------------- # Deploy from Public Repository To deploy code from any public Git repository to Slate, please ensure to follow the below-listed steps: 1. Navigate to the **Catalyst Slate** service in the console. Provide the repository link in the **Public Repository** section. Click **Proceed**. {{%note%}}{{%bold%}}Note:{{%/bold%}} Please make sure the repository link is in the {{%bold%}}.git{{%/bold%}} format.{{%/note%}} 2. In the **Create Deployment** popup, the app name will automatically be populated as the repository name. You can give any deployment name of your choice. {{%note%}}{{%bold%}}Note:{{%/bold%}} You can also edit the app name by clicking on the edit icon and saving it.{{%/note%}} 3. Connect with your preferred Git provider by simply clicking on the button, then authenticating your account. 4. After you integrate your account, a new repository will be automatically created with the app name in your Git account. Your new repository will be created by cloning the public one, and the deployment to Slate will happen from there. You can choose to create a private repository by enabling the toggle as shown in the screenshot below. {{%note%}}{{%bold%}}Note:{{%/bold%}} You can change the Git account by simply clicking on the drop-down menu.{{%/note%}} 5. You can enable the **Auto Deploy** toggle, so that any changes pushed to the connected repository will automatically trigger a new deployment in Slate. 6. The framework, node runtime, and the root path of the application will be automatically detected by Slate. You can also edit them, if required. {{%note%}}{{%bold%}}Note:{{%/bold%}} * The Node.js runtime lets you run JavaScript code outside a web browser, like on a server or your computer. It helps you build websites and apps by giving JavaScript access to files, networks, and other system tools. * You should choose a runtime that matches the Node.js version your application is built with, as specified in your package.json file. * The root path (often written as "/") refers to the base directory where your client application's main files, including the source code, configuration files, and dependencies, are located. {{%/note%}} 7. Click on **Show Advanced Options**. The output path, build command, and install command required for your application deployment will be auto-populated by Slate. {{%note%}}{{%bold%}}Note:{{%/bold%}} * The output path is the directory where your application gets compiled or built for production. * The build command is the script that transforms your development code into production code. * The install command fetches and installs all dependencies required for your project. For example, the install commands for various client-side frameworks are: * **React, Next.js, Vue, Angular, Svelte** → {{%badge%}}npm install{{%/badge%}} or {{%badge%}}yarn install{{%/badge%}} * **Astro** → {{%badge%}}npm install{{%/badge%}} or {{%badge%}}pnpm install{{%/badge%}} * **Vite** → {{%badge%}}npm install{{%/badge%}} or {{%badge%}}yarn install{{%/badge%}} * **SolidJS** → {{%badge%}}npm install{{%/badge%}} or {{%badge%}}pnpm install{{%/badge%}} {{%/note%}} You can also add the required {{%link href="/en/slate/help/environment-variables" %}}app variables{{%/link%}} required for the deployment as key-value pairs and click **Deploy**. 8. The deployment is now completed successfully. You will be able to view the live logs of the deployment as shown in the screenshot below. You can fetch the generated {{%link href="/en/slate/help/slate-access-url" %}}access URL{{%/link%}} of your application as shown in the screenshot below. You can edit subdomain part of the URL by clicking **Edit URL**. You can enable **Auto-Deploy** for this deployment by clicking **Change**. Enter the deployment name and click **Enable**. You can {{%link href="/en/slate/help/fix-failed-deployment" %}}sync the latest commit{{%/link%}} with the current deployment by clicking the **Sync Now** button. You can also map the generated Slate URL with your {{%link href="/en/slate/help/custom-domains" %}}custom domain{{%/link%}} if required. You can view the list of deployments made to your application by switching to the **History** tab in the left pane. Refer to {{%link href="/en/slate/help/monitor-deployment" %}}this help section{{%/link%}} to learn more about it. You can {{%link href="/en/slate/help/cache" %}}enable cache{{%/link%}} for your deployment by navigating to the **Configuration** tab in the left pane. You also have the option to configure {{%link href="/en/slate/help/environment-variables" %}}environment variables{{%/link%}} required for your deployment, if required. --- ## API Reference — Slate -------------------------------------------------------------------------------- title: "Redeploy App" description: "This API enables you to execute an existing Catalyst Pipeline from the Catalyst console." last_updated: "2026-03-18T07:41:08.667Z" source: "https://docs.catalyst.zoho.com/en/api/code-reference/slate/redeploy-app/" service: "Pipelines" -------------------------------------------------------------------------------- {{% section path="/en/api/code-reference/slate/redeploy-app/" id="RedeployApp" %}} {{%divtag class="LeftContent"%}} # Catalyst Slate {{%link href="/en/slate/help/introduction" %}}Slate{{%/link%}} is a robust front-end development service offered by Catalyst that enables you to seamlessly deploy, preview, and launch your web applications. It offers native support for the popular JavaScript frameworks, such as Next.js, Angular, and React, while seamlessly accommodating other frontend frameworks for hassle-free deployment. # Redeploy Application You can trigger a new build for an existing deployment in Slate by passing the unique Catalyst project ID, the specific Slate application name within the project, and the deployment ID to the API below. ### Request Details #### Request URL {{%request class="apiyellow" req="POST" %}}<p>{api-domain}/slate/v1/project/{project_id}/app/{app_id}/deployment/{deployment_id}/redeploy</p>{{%/request%}} {{%request_id id="api-domain" data="URL" %}}The domain URL of your DC{{%/request_id%}} {{%request_id id="project_id" data="Numerical" %}}The unique ID of the app in Slate{{%/request_id%}} {{%request_id id="deployment_id" data="Numerical" %}}The unique ID of the deployment in Slate{{%/request_id%}} {{%note%}}{{%bold%}}Note:{{%/bold%}} Open the Slate deployment in the console, and you can fetch the following values from the URL. <span style="pointer-events: none;word-break: break-all;">https://console.catalyst.zoho.com/baas/96403455/project/26879000000021001/slate/app/1860000000007114/deployment/1860000000007119</span> <br/> Here, {{%badge%}}26879000000021001{{%/badge%}} is the {{%badge%}}project_id{{%/badge%}}. {{%badge%}}1860000000007114{{%/badge%}} is the {{%badge%}}app_id{{%/badge%}} and {{%badge%}}1860000000007119{{%/badge%}} is the {{%badge%}}deployment_id{{%/badge%}}.{{%/note%}} #### Request Headers {{%scope%}} **Authorization:** Zoho-oauthtoken {oauth_token} <br> {{%bold%}}Content-Type:{{%/bold%}} application/json <br> {{%/scope%}} #### Request JSON Properties {{% nested_fields children="open" border="yes" expandable="no" title="Environment Variable" textformat="key-value pair" condition="optional" maxlength=" " %}}Pass environment variables as key-value pairs through the request body. For example: {"API_KEY": "xxxxxxxx2433"} {{% /nested_fields %}} #### Scope {{%scope%}} ZohoCatalyst.Slate.app.CREATE{{%/scope%}} ### Response Details The response will include the status of the new build deployment, detailed deployment information, the commit message, and the commit URL retrieved directly from the connected Git repository, along with additional metadata. {{%/divtag%}} {{%divtag class="RightContent"%}} {{% panel_without_adjustment header="Sample Request" class="language-bash" %}}curl -X POST \ 'https://api.catalyst.zoho.com/slate/v1/project/4000000006007/app/29810101101/deployment/1860000000007119/redeploy' -H 'Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57' \ -H 'Content-Type: application/json' \ -d ‘{ {"API_KEY": "xxxxxxx2433"} \ } {{% /panel_without_adjustment %}} {{% panel_without_adjustment header="Sample Response" class="language-json line-numbers"%}}{ "status": "success", "data": { "id": "2289000000006001", "status": "Queued", "created_time": "Feb 04, 2025 10:46 AM", "created_by": { "zuid": "92747509", "is_confirmed": false, "email_id": "amelia.b@zylker.com", "first_name": "Amelia", "last_name": "Burrows", "user_type": "SuperAdmin", "user_id": "28674000000016006" }, "deployment_id": "2289000000004006", "build_meta": { "event_type": "push", "commit_id": "18f6b8ef0d2586718a015be07701bd6ba486a18f", "commit_message": "Initial commit", "commit_url": "https://api.github.com/repos/ameliab-13966/nextjs-mongo-db/commits/18f6b8ef0d2586718a015be07701bd6ba486a18f", "timestamp": "2024-12-23T07:22:39Z", "author_name": "amelia-b-13966", "repo_id": "907257721", "repo_name": "nextjs-mongo-db", "web_url": "https://github.com/ameliab-13966/nextjs-mongo-db", "ssh_url": "git@github.com:ameliab-13966/nextjs-mongo-db.git", "http_url": "https://github.com/ameliab-13966/nextjs-mongo-db.git", "provider": "Github", "repo_slug": "nextjs-mongo-db" } } } {{% /panel_without_adjustment %}} {{%/divtag%}} {{%/section%}} --- ## FAQ — Slate # Slate {{% expand-container %}} {{% expand id="slate-faq" header="Can I map my custom domain to an application deployed with Catalyst Slate?" %}} Absolutely! Catalyst Slate allows you to easily map {{%link href="/en/slate/help/custom-domains"%}}custom domains{{%/link%}} to your deployed applications, giving you full control over your brand and online presence. {{%/expand%}} {{%/expand-container%}} {{% expand-container %}} {{% expand id="slate-faq" header="How can I manage environment variables for my applications on Catalyst Slate?" %}} Catalyst Slate allows you to manage {{%link href="/en/slate/help/environment-variables"%}}environment variables{{%/link%}} seamlessly. You can define environment variables directly in the Catalyst console, ensuring secure and easy access to different configurations for development, staging, and production environments. {{%/expand%}} {{%/expand-container%}} {{% expand-container %}} {{% expand id="slate-faq" header="Which front-end frameworks can I deploy in Catalyst Slate?" %}} Catalyst Slate provides native support for all popular JavaScript frameworks, including Next.js, React, Angular, Astro, Vue, SolidJS, Svelte, Vite and {{%link href="/en/slate/help/introduction"%}}more{{%/link%}}. Also, you can seamlessly deploy applications built with other front-end frameworks as well. {{%/expand%}} {{%/expand-container%}} {{% expand-container %}} {{% expand id="slate-faq" header="Can I preview my deployments on Catalyst Slate before making them live?" %}} Yes, Catalyst Slate allows you to preview every deployment in a sandboxed environment where you can view and test your application before it goes live. This ensures you can catch any issues early and maintain high-quality standards for your applications. {{%/expand%}} {{%/expand-container%}} {{% expand-container %}} {{% expand id="slate-faq" header="How does Catalyst Slate ensure the security of my applications?" %}} Catalyst Slate prioritizes security with features like automatic SSL provision and robust infrastructure. Your applications are protected with industry-leading security measures, ensuring peace of mind for you and your users. {{%/expand%}} {{%/expand-container%}} {{% expand-container %}} {{% expand id="slate-faq" header="Can I deploy my application to Slate using the CLI, just as I would with other applications?" %}} Yes, you can deploy your application to Slate using our CLI commands. Check out {{%link href="/en/slate/help/deploy-from-cli"%}}this help page{{%/link%}} to learn about the deploy commands and their usage in detail. {{%/expand%}} {{%/expand-container%}} {{% expand-container %}} {{% expand id="slate-faq" header="Can I deploy applications that are not hosted in my private Git repository using Slate?" %}} Yes, you will be able to pull code from any public Git repositories, deploy and preview the full working application live using Catalyst Slate. You can check out our public Git integration feature in {{%link href="/en/slate/help/git-integration/deploy-from-public-repository/"%}}Slate help documentation{{%/link%}}. {{%/expand%}} {{%/expand-container%}} {{% expand-container %}} {{% expand id="slate-faq" header="Why is my application hosted on a custom domain not accessible, and what could be the possible reason?" %}} If you have edited your {{%link href="/en/slate/help/slate-access-url"%}}Slate access URL{{%/link%}} after mapping your custom domain, make sure to redo the mapping with the updated access URL. Note that this may not be the only issue, but it should be verified before troubleshooting other potential problems. {{%/expand%}} {{%/expand-container%}}