# Deploy a Docusaurus Site from Git on xCloud

> Deploy a Docusaurus site from GitHub on xCloud. xCloud builds it with npm run build, serves the static build folder with Nginx and redeploys on every push.

You can host a **Docusaurus** site on **[xCloud](/)** straight from its Git repository. xCloud reads your `package.json`, finds `@docusaurus/core`, runs `npm run build` and serves the static files from the `build` folder with the web server. No Node.js process keeps running after the build. After the first deploy, every push to your branch can publish a new version.

This guide walks you through the first deploy, the settings to check, and how to add your own domain and turn on deploys from Git pushes.

## How xCloud sets up a Docusaurus site

xCloud fills in these settings from your `package.json`:

| Setting | Value for Docusaurus | Why |
|---|---|---|
| **App Type** | **Node.js** | Docusaurus builds with Node.js, even though the final site is static |
| **Serving mode** | **Static build** | The web server serves the files; nothing runs after the build |
| **Web root** | `build` | This is where `docusaurus build` writes your site |
| Build | `npm run build` | Runs the `build` script from your `package.json` |

Docusaurus doesn't have its own label on the setup screen yet. That's why xCloud shows the notice **"Framework not recognised — assuming a static build. Review the serving mode."** For Docusaurus, a static build is the right choice, so you only need to check the settings and deploy.

If your `package.json` has no `build` script, xCloud warns you to set the build command. New Docusaurus projects already have `"build": "docusaurus build"`.

## Before you begin

- An xCloud server with the **Nginx** or **OpenLiteSpeed** stack. You can also create one during these steps.
- Your Docusaurus project in a Git repository, with `package.json` at the root of the repository. Public repositories work without any setup. For a private repository, [connect your Git provider](/docs/how-to-integrate-a-git-provider-with-xcloud/) first.
- In `docusaurus.config.js` (or `.ts`), set `url` to your site's address and keep `baseUrl: '/'` when the site lives at the root of its domain.

## Step 1: Choose Deploy via Git

Open **Sites** and click **Add New Site**. On **What would you like to host today?**, click the **Deploy via Git** card.

![Click the Deploy via Git card on the "What would you like to host today?" screen in xCloud](/_landing/docs/deploy-docusaurus-site-on-xcloud-image-1.png)

You can also open a server first and pick the **Deploy via Git** tab. Both paths lead to the same setup screen.

## Step 2: Pick the server

Under **Where should it run?**, select the server for your site and click **Continue**. If you don't have an Nginx or OpenLiteSpeed server yet, choose **Deploy on a new server**.

## Step 3: Add your Docusaurus repository

In **Deploy Any App From Git**, paste your repository URL and press Enter. For a private repository, switch to **Private Repository** and pick it from your connected account.

xCloud reads the repository and selects **Node.js** as the **App Type**. Below it, you see the "Framework not recognised" notice. This is expected for Docusaurus.

![xCloud selects the Node.js app type for a Docusaurus repository and shows the framework not recognised notice](/_landing/docs/deploy-docusaurus-site-on-xcloud-image-2.png)

Keep **Node.js** selected. Don't switch to **Docker container**: your Docusaurus site doesn't need one.

## Step 4: Check domain and branch

Keep the free **Staging domain (no DNS)** to test first, or click **Use a live domain instead** to use your own domain right away. Check that **Branch** is the branch you want to publish. xCloud fills in the repository's default branch.

## Step 5: Check the build settings

Scroll to **Build & serving**. **Serving mode** should be **Static build** and **Web root** should be `build`.

![Build & serving shows Static build with build as the web root for a Docusaurus site](/_landing/docs/deploy-docusaurus-site-on-xcloud-image-3.png)

Change **Web root** only if you changed the output folder, for example with `docusaurus build --out-dir`. Leave **Serving mode** on **Static build**.

Open **Advance** if you need to change more:

- **Node.js Version**: pick the version your Docusaurus release needs. Check `engines` in your `package.json`.
- **Build & deploy script**: xCloud fills it with a step that installs your dependencies, then `npm run build`. Edit it here if your project builds another way.
- **Environment file (.env)**: add values your build reads. Docusaurus reads them while it builds, so deploy again after you change one.

## Step 6: Deploy

Check the **Summary** and click **Deploy**. xCloud pulls your code, installs dependencies, runs the build and sets up the web server for the `build` folder. When it is done, open **Deployments** on the site. The latest deployment shows **Deployed** and **LIVE**.

![The Deployments page shows the first Docusaurus deployment as Deployed and LIVE](/_landing/docs/deploy-docusaurus-site-on-xcloud-image-4.png)

Click **Visit Site** at the top to open your docs. If a deployment fails, open it on the same page and read **Build steps** or **Raw output** to see which step stopped. A successful Docusaurus build ends with `Generated static files in "build"`. If the build passed but the site doesn't load, check that **Web root** matches the folder in that line. See [How to View Git Deployments for Your Site in xCloud](/docs/view-git-deployments-in-xcloud/) for more on this page.

## Step 7: Publish changes with a Git push

After the first deploy, publishing a change can be a push:

- **Repository from a connected Git provider**: turn on **Auto-deploy on push (webhook)** during setup. xCloud can add the webhook for you when your account has admin access to the repository.
- **Any repository**: open the site's **Git** page, turn on **Enable push to deploy** and click **Generate URL**. Add the **Deployment URL** as a webhook in your Git provider. The URL is shown only once, so copy it right away.

![Turn on Enable push to deploy and click Generate URL on the site's Git page](/_landing/docs/deploy-docusaurus-site-on-xcloud-image-5.png)

From then on, each push to your branch rebuilds the site and publishes the new version. To deploy without a push, click **Deploy Now** at the top of the site.

## Add your own domain and SSL

If you started on a staging domain, add your own domain from the site's **Domain** menu, point its DNS to your server, and xCloud sets up a free SSL certificate. [How to Deploy Git Projects in One Click with xCloud](/docs/deploy-git-projects-in-one-click-with-xcloud/) shows the DNS options, including one-click verification for domains on Cloudflare.

Update `url` in your Docusaurus config to the new domain, then push, so links in your sitemap and social cards use it.

To change the Node.js version later, see [How to Change Node Version with xCloud](/docs/how-to-change-node-version-with-xcloud/). If a deployment is stuck or doesn't start on push, see [Troubleshooting Git Deployments](/docs/troubleshooting-git-deployments-stuck-failed-or-not-triggering/). Building with Astro instead? See [How to Deploy an Astro Site from Git on xCloud](/docs/deploy-astro-site-on-xcloud/).

## Frequently asked questions

### Does xCloud keep a Node.js process running for my Docusaurus site?

No. xCloud runs npm run build on each deploy and the web server serves the static files from the build folder. Node.js is only used while the site builds.

### Why does xCloud say "Framework not recognised" for my Docusaurus project?

Docusaurus has no label of its own on the setup screen yet, so xCloud shows this notice. It still reads @docusaurus/core from your package.json and fills in the right settings: Static build, with build as the web root. Check them and deploy.

### Which folder does xCloud serve for a Docusaurus site?

The build folder, which is where docusaurus build writes your site. You can change it in the Web root field before you deploy.

### How do I update my Docusaurus site after it is live?

Push to the branch you deployed. With push to deploy turned on, xCloud pulls the new code, rebuilds the site and publishes it. You can also click Deploy Now on the site.

That's it! Your Docusaurus site is live on xCloud and updates whenever you push.

Still stuck? Contact our **[dedicated support team](/docs/access-built-in-support-portal-in-xcloud/)** for any of your queries.
