Skip to content

The ColdBox File System Abstraction Module Documentation

Notifications You must be signed in to change notification settings

ortus-docs/cbfs-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

description
cbfs is a module for ColdBox that provides abstractions to any file system.

Introduction

ColdBox File System Abstraction = cbfs

The cbfs module will enable you to abstract ANY filesystem within your ColdBox applications with a human, fluent, and consistent API. You can configure as many disks as you wish to represent file systems in your application. Each disk is backed by a storage provider and configurable within your ColdBox application. Each ColdBox Module can also provide and consume disks in an HMVC fashion.

Never worry about hard-coded paths or how to interact with different file systems or tiers, as your API will remain the same for each system.

Storage Providers

The available storage providers are

  • Local - A local file system storage provider.
  • Ram - An in-memory file storage provider.
  • S3 - An Amazon S3, Rackspace, Digital Ocean, or Google Cloud Storage provider.

System Requirements

  • Lucee 5+
  • Adobe ColdFusion 2018+
  • Java 11+

Versioning

cbfs is maintained under the Semantic Versioning guidelines as much as possible. We number releases in the following format:

<major>.<minor>.<patch>

And constructed with the following guidelines:

  • Breaking backward compatibility bumps the major (and resets the minor and patch)
  • New additions without breaking backward compatibility bump the minor (and reset the patch)
  • Bug fixes and miscellaneous changes bump the patch

License

The ColdBox Platform, cbfs is open source and licensed under the Apache 2 License.

  • Copyright by Ortus Solutions, Corp
  • ColdBox, CacheBox, WireBox, and LogBox are registered trademarks of Ortus Solutions, Corp.

Important Links

Professional Open Source

Ortus Solutions, Corp

The ColdBox Security Module is a professional open-source software backed by Ortus Solutions, Corp offering services like:

  • Custom Development
  • Professional Support & Mentoring
  • Training
  • Server Tuning
  • Security Hardening
  • Code Reviews
  • Much More

Discussion & Help

The Box products and modules community for discussion and help can be found here:

https://community.ortussolutions.com/c/box-modules/

HONOR GOES TO GOD ABOVE ALL

Because of His grace, this project exists. If you don't like this, don't read it; it's not for you.

"Therefore being justified by faith, we have peace with God through our Lord Jesus Christ: By whom also we have access by faith into this grace wherein we stand, and rejoice in hope of the glory of God." Romans 5:5

About

The ColdBox File System Abstraction Module Documentation

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •