> For the complete documentation index, see [llms.txt](https://cachebox.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cachebox.ortusbooks.com/for-the-geeks/cachebox-architecture/cacheboxconfig.md).

# CacheBoxConfig

**class** : `cachebox.system.cache.config.CacheBoxConfig`

This is the required configuration object the `CacheFactory` object needs in order to start itself up. This configuration object can be created and then used to configure all your caches, listeners, scope registrations and logging. We will investigate all the types of configurations available but they all translate down to methods in this configuration object. Ways to configure CacheBox:

* Programmatically via method calls
* Programmatically via a CacheBox DSL or a CacheBox DSL Class

```javascript
config = new cachebox.system.cache.config.CacheBoxConfig();
cachebox = new cachebox.system.cache.CacheFactory( config );
```

## Configuration Methods

| Method                                                                                                                                                                                                           | Description                                                                |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| `scopeRegistration( [boolean enabled=true], [string scope="server"], [string key="cachebox"] )`                                                                                                                  | Configure scope-based persistence for the factory instance                 |
| `defaultCache( objectDefaultTimeout, objectDefaultLastAccessTimeout, reapFrequency, maxObjects, freeMemoryPercentageThreshold, useLastAccessTimeouts, evictionPolicy, evictCount, objectStore, coldboxEnabled )` | Set properties for the default cache region                                |
| `cache( required string name, [string provider="cachebox.system.cache.providers.CacheBoxProvider"], [struct properties={}] )`                                                                                    | Register a named cache with an optional provider class and properties      |
| `listener( required string class, [struct properties={}], [string name=""] )`                                                                                                                                    | Register a CacheBox event listener class                                   |
| `logBoxConfig( required string config )`                                                                                                                                                                         | Set a custom LogBox configuration class path                               |
| `reset()`                                                                                                                                                                                                        | Reset all configuration back to defaults                                   |
| `validate()`                                                                                                                                                                                                     | Validate the configuration object; throws a descriptive exception on error |


---

# 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://cachebox.ortusbooks.com/for-the-geeks/cachebox-architecture/cacheboxconfig.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.