> For the complete documentation index, see [llms.txt](https://qubit.deadbits.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://qubit.deadbits.ai/getting-started/quickstart.md).

# Quickstart

### Prerequisites

* Docker compose

If you prefer to run without Docker, follow the [Manual Install ](broken://pages/JjjojIyKxaiBPzzLwvtg)steps.

***

{% stepper %}
{% step %}

### Clone the repository

```bash
git clone https://github.com/deadbits/qubit
cd qubit
```

{% endstep %}

{% step %}

#### Create a `.env` file in the `docker` directory

```bash
DB_PASSWORD=your_secure_password_here
AUTH_SECRET_KEY=your_secret_key_here
OPENAI_API_KEY=your_openai_key_here
ADMIN_USERNAME=admin
ADMIN_EMAIL=admin@example.com
ADMIN_PASSWORD=your_admin_password
```

{% endstep %}

{% step %}

#### Configure your author details in `data/config.yaml`

The `data/config.yaml` file controls your blog's author details and bio on the `About` page.

```yaml
author:
  name: Adam Swanda
  short_name: adam
  bio: >
    Security researcher and developer focused on AI/ML security, threat intelligence, and building tools that help people research and create.
  github: deadbits
  website: https://www.deadbits.org
  linkedin: https://www.linkedin.com/in/adamswanda/
```

{% endstep %}

{% step %}

#### Start the application with Docker

```bash
docker compose up -d --build
```

{% endstep %}
{% endstepper %}

That's it! 

You can login to Qubit with your admin account at <http://localhost:8000/login>.


---

# 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://qubit.deadbits.ai/getting-started/quickstart.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.