This is what an AI/RAG pipeline sees when it indexes this page — the same output served at https://camelmind-docs.vercel.app/api/llms/deployment/deploy-to-vercel.Back to doc

Rendered doc

Deploy to Vercel

Deploy your CamelMind documentation site to Vercel in minutes.

Vercel makes it easy to deploy your CamelMind documentation site. It automatically builds and deploys your site on every Git push, provides HTTPS out of the box, and creates preview deployments for pull requests.


Before you begin

You'll need:

  • A CamelMind documentation project
  • A GitHub repository containing your project
  • A Vercel account

Deploy your CamelMind site to Vercel

Follow these steps to build, configure, and deploy your CamelMind site to Vercel:

1

Push your project to GitHub

Commit your project and push it to a GitHub repository.

bash
git add .
git commit -m "Initial commit"
git push
Note

If you haven't created a repository yet, create one on GitHub first, then push your project.

2

Import the repository into Vercel

  1. Sign in to Vercel.
  2. Select Add New → Project.
  3. Choose your GitHub repository.
  4. Click Import.

CamelMind is built on Next.js, so Vercel automatically detects the project and configures the build settings.

3

Configure environment variables

Before deploying, configure your project's environment variables.

VariableDescription
CAMELMIND_URLThe public URL of your documentation site.
SESSION_SECRETRequired when authentication is enabled.

If you're using OpenID Connect (OIDC), also configure:

  • OIDC_ISSUER
  • OIDC_CLIENT_ID
  • OIDC_CLIENT_SECRET

See Environment Variables for the complete list of supported variables.

4

Deploy

Click Deploy.

Vercel builds and publishes your documentation site. Once deployment completes, your site is available at its public URL.

Every future push to your default branch automatically triggers a new deployment.


Use a custom domain on Vercel

To set up a custom domain for your Vercel deployment, follow these steps:

  1. Open your Vercel project.
  2. Go to Settings → Domains.
  3. Add your domain and follow the DNS instructions.
  4. Update CAMELMIND_URL to match your new HTTPS URL.

Preview deployments for pull requests on Vercel

When you create or update a pull request, Vercel automatically builds and assigns a unique preview deployment URL to test your CamelMind changes.


Troubleshooting Vercel deployments

If you encounter issues when deploying your site to Vercel, refer to these common troubleshooting solutions:

The build fails

Verify that all project dependencies are committed to your repository.

If you've recently installed new packages:

bash
npm install
git add package.json package-lock.json
git commit -m "Update dependencies"
git push
Authentication redirects to the wrong URL

Verify that CAMELMIND_URL exactly matches your site's public HTTPS URL, without a trailing slash.

Environment variables aren't available

Environment variables must be configured in your Vercel project settings.

After adding or updating variables, redeploy your project.

What the AI sees

1> For a complete documentation index, see /llms.txt. To read any public page as Markdown, append .md to the URL.
2 
3Vercel makes it easy to deploy your CamelMind documentation site. It automatically builds and deploys your site on every Git push, provides HTTPS out of the box, and creates preview deployments for pull requests.
4 
5---
6 
7<Callout type="important" title="Before you begin">
8 
9You'll need:
10 
11- A CamelMind documentation project
12- A GitHub repository containing your project
13- A Vercel account
14 
15</Callout>
16 
17---
18 
19## Deploy your CamelMind site to Vercel
20 
21Follow these steps to build, configure, and deploy your CamelMind site to Vercel:
22 
23<Steps>
24 
25<Step n={1} title="Push your project to GitHub">
26 
27Commit your project and push it to a GitHub repository.
28 
29```bash
30git add .
31git commit -m "Initial commit"
32git push
33```
34 
35<Callout type="note">
36If you haven't created a repository yet, create one on GitHub first, then push your project.
37</Callout>
38 
39</Step>
40 
41<Step n={2} title="Import the repository into Vercel">
42 
431. Sign in to Vercel.
442. Select **Add New → Project**.
453. Choose your GitHub repository.
464. Click **Import**.
47 
48CamelMind is built on Next.js, so Vercel automatically detects the project and configures the build settings.
49 
50</Step>
51 
52<Step n={3} title="Configure environment variables">
53 
54Before deploying, configure your project's environment variables.
55 
56| Variable | Description |
57| --- | --- |
58| `CAMELMIND_URL` | The public URL of your documentation site. |
59| `SESSION_SECRET` | Required when authentication is enabled. |
60 
61If you're using OpenID Connect (OIDC), also configure:
62 
63- `OIDC_ISSUER`
64- `OIDC_CLIENT_ID`
65- `OIDC_CLIENT_SECRET`
66 
67See [Environment Variables](/deployment/environment-variables) for the complete list of supported variables.
68 
69</Step>
70 
71<Step n={4} title="Deploy">
72 
73Click **Deploy**.
74 
75Vercel builds and publishes your documentation site. Once deployment completes, your site is available at its public URL.
76 
77Every future push to your default branch automatically triggers a new deployment.
78 
79</Step>
80 
81</Steps>
82 
83---
84 
85## Use a custom domain on Vercel
86 
87To set up a custom domain for your Vercel deployment, follow these steps:
88 
891. Open your Vercel project.
902. Go to **Settings → Domains**.
913. Add your domain and follow the DNS instructions.
924. Update `CAMELMIND_URL` to match your new HTTPS URL.
93 
94---
95 
96## Preview deployments for pull requests on Vercel
97 
98When you create or update a pull request, Vercel automatically builds and assigns a unique preview deployment URL to test your CamelMind changes.
99 
100---
101 
102## Troubleshooting Vercel deployments
103 
104If you encounter issues when deploying your site to Vercel, refer to these common troubleshooting solutions:
105 
106<Details summary="The build fails" id="build-failed">
107 
108Verify that all project dependencies are committed to your repository.
109 
110If you've recently installed new packages:
111 
112```bash
113npm install
114git add package.json package-lock.json
115git commit -m "Update dependencies"
116git push
117```
118 
119</Details>
120 
121<Details summary="Authentication redirects to the wrong URL" id="wrong-url-redirection">
122 
123Verify that `CAMELMIND_URL` exactly matches your site's public HTTPS URL, without a trailing slash.
124 
125</Details>
126 
127<Details summary="Environment variables aren't available" id="env-variables-unavailable">
128 
129Environment variables must be configured in your Vercel project settings.
130 
131After adding or updating variables, redeploy your project.
132 
133</Details>

Issues (1)

Notes (1)