Question 1

How to secure Docat with password protection?

Accepted Answer

Docat supports HTTP basic auth by customizing the NGINX configuration inside the Docker container. You need to create a .htpasswd file and mount a custom default NGINX config, as detailed in the authentication example in the README, which involves several manual steps.

Question 2

Docat vs ReadTheDocs: which should I use?

Accepted Answer

Docat is a self-hosted, simpler tool ideal for internal projects or teams wanting full control, while ReadTheDocs is a managed service with features like automatic builds and a larger ecosystem. Choose Docat for versioned hosting with minimal fuss, but expect to handle setup and security yourself.

Question 3

How to deploy Docat on Kubernetes?

Accepted Answer

Since Docat is distributed as a Docker image, deploy it on Kubernetes by creating a deployment with persistent volumes for storage, similar to the Docker volume setup. Adapt the docker run command from the README to Kubernetes manifests, ensuring proper volume mounts and environment variables.

Question 4

What's the maximum file size for uploading docs?

Accepted Answer

The maximum upload size is configurable via the MAX_UPLOAD_SIZE environment variable, which defaults to 100M. You can adjust this when running the Docker container to accommodate larger documentation archives, as mentioned in the 'System Config' table.

Question 5

How to integrate Docat with GitHub Actions?

Accepted Answer

Use the docatl CLI tool in your GitHub Actions workflow to push documentation after builds. The README provides a basic push command that can be incorporated into CI/CD pipelines, automating documentation updates with version tagging.

Question 6

Can I use a custom domain with Docat?

Accepted Answer

Yes, but it requires manual configuration. Since Docat runs behind NGINX, you can set up a custom domain by modifying the NGINX server_name in the default config or using a reverse proxy, though this isn't documented out of the box.

DOCAT

What is DOCAT?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions