> For the complete documentation index, see [llms.txt](https://intuitem.gitbook.io/ciso-assistant/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://intuitem.gitbook.io/ciso-assistant/installation.md).

# Installation

- [Overview](https://intuitem.gitbook.io/ciso-assistant/installation/installation.md)
- [Quick start](https://intuitem.gitbook.io/ciso-assistant/installation/quick-start.md): Docker Compose or Helm for Kubernetes
- [Prerequisites](https://intuitem.gitbook.io/ciso-assistant/installation/prerequisites.md)
- [Deployment methods](https://intuitem.gitbook.io/ciso-assistant/installation/deployment-methods.md)
- [Local](https://intuitem.gitbook.io/ciso-assistant/installation/deployment-methods/local.md): Basic setup for local deployment and experimentation
- [Docker rootless configuration](https://intuitem.gitbook.io/ciso-assistant/installation/deployment-methods/docker-rootless.md): Deployment documentation for rootless containers
- [Remote/Virtualization](https://intuitem.gitbook.io/ciso-assistant/installation/deployment-methods/remote-virtualization.md): Experimenting CISO Assistant through remote server or hypervisor
- [Deploy on a VPS](https://intuitem.gitbook.io/ciso-assistant/installation/deployment-methods/vps.md): Virtual Private Server - Remote internet-facing VM
- [Windows](https://intuitem.gitbook.io/ciso-assistant/installation/deployment-methods/windows.md): Draft
- [Helm Chart](https://intuitem.gitbook.io/ciso-assistant/installation/deployment-methods/helm-chart.md): Kubernetes installation with the official Helm chart
- [Post-install setup](https://intuitem.gitbook.io/ciso-assistant/installation/post-install-setup.md)
- [Custom certificates](https://intuitem.gitbook.io/ciso-assistant/installation/post-install-setup/custom-certificates.md): How to add custom certificates for your remote installation
- [Managing secrets](https://intuitem.gitbook.io/ciso-assistant/installation/post-install-setup/managing-secrets.md): This guide covers how to keep sensitive configuration (database credentials, mailer passwords, API keys) out of your docker-compose.yml.
- [Setting up S3](https://intuitem.gitbook.io/ciso-assistant/installation/post-install-setup/s3.md): How to connect your S3 block storage for your installation
- [Setting up mailer](https://intuitem.gitbook.io/ciso-assistant/installation/post-install-setup/mailer.md): CISO Assistant uses SMTP to send transactional emails (password reset, superuser creation, notifications). This page covers configuration and the TLS specifics introduced in 3.16.
- [Prometheus metrics](https://intuitem.gitbook.io/ciso-assistant/installation/post-install-setup/prometheus-metrics.md): CISO Assistant exposes a /metrics endpoint in the Prometheus exposition format. This page explains how to enable it and how to access it safely from Prometheus without exposing it publicly.
- [Structured logging](https://intuitem.gitbook.io/ciso-assistant/installation/post-install-setup/structured-logging.md): CISO Assistant can emit its operational logs as line-delimited JSON so a SIEM (Microsoft Sentinel, Azure Data Explorer, Splunk, Elastic) can ingest them without custom parsing. This page explains how
- [Maintenance](https://intuitem.gitbook.io/ciso-assistant/installation/maintenance.md)
- [Updating your local instance](https://intuitem.gitbook.io/ciso-assistant/installation/maintenance/updating.md): How to update your local instance. All docker images are available on ghcr with the specific versions matching the repo tags. The latest tag points to the most recent release for both back and front.
- [Special cases](https://intuitem.gitbook.io/ciso-assistant/installation/maintenance/special-cases.md): Tips and tricks regarding specific cases
- [Migrate between different databases](https://intuitem.gitbook.io/ciso-assistant/installation/maintenance/migrate-database.md): You think it is time to change or try a new database on CISO Assistant? You were using SQLite and now want to switch to PostgreSQL, or the other way around? This guide is for you.
- [Frequent questions](https://intuitem.gitbook.io/ciso-assistant/installation/faq.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://intuitem.gitbook.io/ciso-assistant/installation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.