> 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/configuration/visualizer.md).
# Visualizer
Configuring the CBSecurity Visualizer
The CBSecurity visualizer is a tool that will allow you to visualize all of your configuration settings, firewall logs, and much more. By default, the visualizer is **disabled**.
Visualizer
{% hint style="danger" %}
If you enable the visualizer, we highly suggest you **secure** it.
{% endhint %}
If enabled, you can visit the `/cbsecurity` entry point, and you will get the visualizer rendered.
## Configuration
Here are the configuration settings for the visualizer:
```javascript
/**
* --------------------------------------------------------------------------
* Security Visualizer
* --------------------------------------------------------------------------
* This is a debugging panel that when active, a developer can visualize security settings and more.
* You can use the `securityRule` to define what rule you want to use to secure the visualizer but make sure the `secured` flag is turned to true.
* You don't have to specify the `secureList` key, we will do that for you.
*/
visualizer : {
"enabled" : false,
"secured" : false,
"securityRule" : {}
},
```
### enabled
If `false` then no visualizer, if `true` then you get a visualizer :tada:
### secured
We highly encourage you to ensure the visualizer is ONLY accessible if you have authenticated into your system. By using a `secured=true` then CBSecurity will incorporate a rule to secure the visualizer for ONLY authenticated users. If you want to be picky, use the `securityRule` setting.
### securityRule
We also recommend that ONLY certain users have access to the visualizer. You can accomplish this by adding the keys to the security rule created for the visualizer. For example, I only want `admins` or users with the `cbsecurity-visualizer` permission to access it.
```javascript
visualizer : {
"enabled" : true,
"secured" : true,
"securityRule" : {
"roles" : "admins",
"permissions" : "cbsecurity-visualizer"
}
}
```
## Requirements
Please note that the security visualizer can ONLY visualize if you have [firewall logs enabled](/get-started/configuration/firewall.md#logs). If no logs are enabled or configured, then the visualizer WILL NOT WORK. Here is a simple logs configuration in the firewall
```javascript
firewall : {
"logs" : {
"enabled" : true,
"dsn" : "myapp",
"schema" : "",
"table" : "cbsecurity_logs",
"autoCreate" : true
}
}
```
{% hint style="warning" %}
The `dsn` key is optional, and CBSecurity will inspect the Application.cfc settings for a default datasource: `this.datasource`
{% endhint %}
---
# 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/configuration/visualizer.md?ask=&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.
