Installation
Get up and running with cbfs in no time!
Use CommandBox CLI to install:
To install the bleeding-edge version:
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.
Pre-Configured Disks
By default, cbfs, comes pre-configured with 3 disks:
Disk Name | Provider | Location | Description |
---|---|---|---|
|
|
| A private location for assets |
|
|
| A public accessible location inside of your application |
|
|
| The Java temp internal directory |
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 😂 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)
Please check out the providers section in order to see the properties and requirements for each one of them.
Last updated