Table of contents

Kubernetes deployment

There is Helm chart, that you can use in order to install CodeX Docs to your Kubernetes cluster.

You can download, review and change values for installing CodeX Docs chart:

helm show values oci://ghcr.io/codex-team/codex.docs.chart/codex-docs --version < specify_latest_version_here > > values.yaml

And finally, you can run Helm install command in to install chart to your cluster:

helm upgrade codex-docs -n codex-docs oci://ghcr.io/codex-team/codex.docs.chart/codex-docs --version <specify_latest_version_here> --install -f values.yaml

By default, MongoDB database driver and S3 uploads driver are enabled. You need to set MongoDB and S3 credentials before deploying using environment variables to pass secrets. You can also enable local drivers. In that case, PVC will be created to store your data, but it's not recommended to use local drivers for production deployments.