> For the complete documentation index, see [llms.txt](https://coldbox-security.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://coldbox-security.ortusbooks.com/get-started/installation.md).

# Installation

Get up and running with CBSecurity in no time!

Leverage [CommandBox](https://www.ortussolutions.com/products/commandbox) to install into your ColdBox app:

```bash
# Latest version
install cbsecurity

# Bleeding Edge
install cbsecurity@be
```

## System Requirements

### CFML Engines

* BoxLang 1+ (Preferred)
* Lucee 5+
* Adobe 2023+

### Additional Requirements

* A database for optional firewall logging
* ColdBox 7+ for delegates and basic auth support only

## Mixins

The following mixins are registered once the module is installed:

```javascript
/**
 * Retrieve the Jwt Auth Service
 */
function jwtAuth()

/**
 * Retrieve the CBSecurity Service Object
 */
function cbSecure()
```

## Configuration Settings

By default `cbsecurity` is configured to work with `cbauth` as the authentication service. You only need to provide a user service class that knows how to connect to your database to retrieve and validate credentials. You can also use the in-built basic authentication users as well.

{% hint style="success" %}
You can find much more information about cbauth here: <https://forgebox.io/view/cbauth>
{% endhint %}

{% content-ref url="/pages/-LA-UqLbEQoweJk3ZTf5" %}
[Configuration](https://coldbox-security.ortusbooks.com/get-started/configuration.md)
{% endcontent-ref %}


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://coldbox-security.ortusbooks.com/get-started/installation.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
