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/docker-self-hosting.Back to doc

Rendered doc

Docker Self-Hosting

Build and deploy your CamelMind documentation site using Docker.

CamelMind includes a production-ready Dockerfile and docker-compose.yml, making it easy to deploy your documentation site on your own infrastructure.

Docker deployments are ideal for on-premises environments, private clouds, Kubernetes clusters, and air-gapped networks.

Build and run the Docker image

To build and run the Docker image for your documentation site, execute the following command from your project root:

bash
docker build -t my-docs .

Run the container:

bash
docker run --rm \
  --env-file .env \
  -p 3000:3000 \
  my-docs

Open your documentation site at:

text
http://localhost:3000
Tip

Copy .env.example to .env and update it with your site's configuration before starting the container.

Using Docker Compose

Start the site with Docker Compose:

bash
docker compose up --build

CamelMind automatically reads environment variables from .env.

Configure your site

Configure authentication, your public site URL, and other runtime settings in .env.

For a complete list of supported variables, see Environment Variables.

Update documentation without rebuilding

During development, you can mount your documentation files into the container to see changes without rebuilding the image.

bash
docker run --rm \
  -p 3000:3000 \
  --env-file .env \
  -v "$(pwd)/content:/app/content" \
  -v "$(pwd)/nav:/app/nav" \
  my-docs

If you're using Docker Compose, uncomment the volumes section in docker-compose.yml to enable the same behavior.

Deploy Docker to production

To deploy your Docker container to production, place a reverse proxy such as Nginx, Caddy, or Traefik in front of the CamelMind container to provide HTTPS and TLS termination. Also ensure that:

  • Set CAMELMIND_URL to your public HTTPS URL.
  • Your reverse proxy forwards requests to the CamelMind container.
  • Container health checks target /home.

Next steps for Docker self-hosting

After you deploy your container, you can complete these next steps:

  • Configure your site's Environment Variables.
  • Set up Authentication for protected documentation sites.
  • Deploy the container to your preferred hosting platform or Kubernetes cluster.

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 
3CamelMind includes a production-ready `Dockerfile` and `docker-compose.yml`, making it easy to deploy your documentation site on your own infrastructure.
4 
5Docker deployments are ideal for on-premises environments, private clouds, Kubernetes clusters, and air-gapped networks.
6 
7---
8 
9## Build and run the Docker image
10 
11To build and run the Docker image for your documentation site, execute the following command from your project root:
12```bash
13docker build -t my-docs .
14```
15 
16Run the container:
17 
18```bash
19docker run --rm \
20 --env-file .env \
21 -p 3000:3000 \
22 my-docs
23```
24 
25Open your documentation site at:
26 
27```text
28http://localhost:3000
29```
30 
31<Callout type="tip">
32Copy `.env.example` to `.env` and update it with your site's configuration before starting the container.
33</Callout>
34 
35---
36 
37## Using Docker Compose
38 
39Start the site with Docker Compose:
40 
41```bash
42docker compose up --build
43```
44 
45CamelMind automatically reads environment variables from `.env`.
46 
47---
48 
49## Configure your site
50 
51Configure authentication, your public site URL, and other runtime settings in `.env`.
52 
53For a complete list of supported variables, see **Environment Variables**.
54 
55---
56 
57## Update documentation without rebuilding
58 
59During development, you can mount your documentation files into the container to see changes without rebuilding the image.
60 
61```bash
62docker run --rm \
63 -p 3000:3000 \
64 --env-file .env \
65 -v "$(pwd)/content:/app/content" \
66 -v "$(pwd)/nav:/app/nav" \
67 my-docs
68```
69 
70If you're using Docker Compose, uncomment the `volumes` section in `docker-compose.yml` to enable the same behavior.
71 
72---
73 
74## Deploy Docker to production
75 
76To deploy your Docker container to production, place a reverse proxy such as **Nginx**, **Caddy**, or **Traefik** in front of the CamelMind container to provide HTTPS and TLS termination.
77Also ensure that:
78 
79- Set `CAMELMIND_URL` to your public HTTPS URL.
80- Your reverse proxy forwards requests to the CamelMind container.
81- Container health checks target `/home`.
82 
83---
84 
85## Next steps for Docker self-hosting
86 
87After you deploy your container, you can complete these next steps:
88 
89- Configure your site's [Environment Variables](/deployment/environment-variables).
90- Set up [Authentication](/features/auth-rbac) for protected documentation sites.
91- Deploy the container to your preferred hosting platform or Kubernetes cluster.

Issues (0)

No AI-friendliness issues found.