# Installation

Use [CommandBox CLI](https://www.ortussolutions.com/products/commandbox) to install:

```bash
install cbfs
```

To install the bleeding-edge version:

```bash
install cbfs@be
```

### Configuration

You can configure the module by adding a `cbfs` structure to the `moduleSettings` in your `config/Coldbox.cfc` file or you can create your own `config/modules/cbfs.cfc` configuration file if you are using ColdBox 7.  Below you can see the default configuration for cbfs.

{% code title="config/modules/cbfs.cfc" %}

```json
function configure(){
    return {
    	// The default disk with a reserved name of 'default'
	"defaultDisk" : "default",
	// Register the disks on the system
	"disks"       : {
		// Your default application storage : non-web accessible
		"default" : {
			provider   : "Local",
			properties : {
				path : getSystemSetting( "CBFS_DEFAULT_DISK_PATH", "#controller.getAppRootPath()#.cbfs" )
			}
		},
		// A public web-accessible storage located at /includes/public
		"public" : {
			provider   : "Local",
			properties : {
				path : getSystemSetting(
					"CBFS_PUBLIC_DISK_PATH",
					"#controller.getAppRootPath()#includes/public"
				),
				diskUrl : function(){
					return variables.controller
						.getRequestService()
						.getContext()
						.getHtmlBaseUrl() & "includes/public"
				}
			}
		},
		// A disk that points to the CFML Engine's temp directory
		"temp" : {
			provider   : "Local",
			properties : { path : getSystemSetting( "CBFS_TEMP_DISK_PATH", getTempDirectory() ) }
		}
	}
   };
}
```

{% endcode %}

### Pre-Configured Disks

By default, cbfs, comes pre-configured with 3 disks:

<table><thead><tr><th width="148">Disk Name</th><th width="113">Provider</th><th>Location</th><th>Description</th></tr></thead><tbody><tr><td><code>default</code></td><td><code>Local</code></td><td><code>{app}/.cbfs</code></td><td>A private location for assets</td></tr><tr><td><code>public</code></td><td><code>Local</code></td><td><code>{app}/includes/public</code></td><td>A public accessible location inside of your application</td></tr><tr><td><code>temp</code></td><td><code>Local</code></td><td><code>{CF internal}</code></td><td>The Java temp internal directory</td></tr></tbody></table>

#### Environment Variables

Please note that you can change the location of these disks by adding the configuration or you can easily do so using the following environment variables:

* `CBFS_DEFAULT_DISK_PATH`
* `CBFS_PUBLIC_DISK_PATH`
* `CBFS_TEMP_DISK_PATH`

### Default Disk

You can use the `defaultDisk` key to specify which disk will be the `default` in your system.  By `default` it's the `default` one :joy: which is not web-accessible and stored as `.cbfs` in your root application.

### Registering Disks

The `disks` structure is used to register disks in your application.  The `key` is the name of the disk which is a structure that each disk needs in order to be configured:

* **provider** : The name of the provider (if core) or a full CFC path or WireBox ID
* **properties** : A structure of configuration properties the disk requires (if any)

{% hint style="info" %}
Please check out the [providers ](/getting-started/providers.md)section in order to see the properties and requirements for each one of them.
{% endhint %}


---

# Agent Instructions: 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:

```
GET https://cbfs.ortusbooks.com/getting-started/installation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.