CacheBox: Enterprise Caching
6.x
6.x
  • Introduction
  • Intro
    • Release History
      • What's New With 6.8.0
      • What's New With 6.7.0
      • What's New With 6.6.1
      • What's New With 6.6.0
      • What's New With 6.5.0
      • What's New With 6.3.0
      • What's New With 6.2.0
      • What's New With 6.1.0
      • What's New With 6.0.0
    • About This Book
      • Author
  • Getting Started
    • Overview
      • CacheBox RefCard
      • Useful Resources
      • Features at a Glance
    • Installing CacheBox
    • Creating CacheBox
      • Common CacheFactory Methods
      • Cache Cleanup/Reaping
  • For The Geeks
    • Caching Concepts
      • Caching Considerations
      • Cache Loading
      • Definitions
      • Java Soft References
    • Cache Topologies
      • Single Instance/In-Process
      • Single Instance/Out-Process
      • Replicated
      • Distributed
    • CacheBox Architecture
      • CacheFactory
      • CacheBoxConfig
      • EventManager
      • ColdBox
      • LogBox
      • ICacheProvider
      • ICacheStats
      • IObjectStore
      • IEvictionPolicy
      • AbstractEvictionPolicy
      • IColdboxApplicationCache
  • Configuration
    • CacheBox Configuration
      • CacheBox DSL
        • LogBoxConfig
        • Scope Registration
        • Default Cache
        • Caches
        • Listeners
      • CacheBox Config Object
      • ColdBox Configuration
  • Usage
    • Cache Providers
      • CF Providers
      • Lucee Providers
      • Mock Provider
      • CacheBox Provider
      • Couchbase Providers
    • CacheBox Object Stores
      • ConcurrentStore
      • ConcurrentSoftReferenceStore
      • DiskStore
      • JDBCStore
      • BlackholeStore
  • Advanced Usage
    • CacheBox Eviction Policies
      • Using Your Own Policy
    • CacheBox Event Model
      • CacheBox Events
      • Provider Events
      • Cache Listeners
    • Cache Reporting
      • Creating Your Own Skins
        • Skin Templates
        • ReportHandler
          • Action Commands
Powered by GitBook
On this page
  • System Requirements
  • Manual Installation
  • CommandBox Installation
  • Namespaces
  • Standalone
  • ColdBox

Was this helpful?

Edit on Git
Export as PDF
  1. Getting Started

Installing CacheBox

PreviousFeatures at a GlanceNextCreating CacheBox

Last updated 3 years ago

Was this helpful?

CacheBox has been designed to work either as a standalone framework or within the ColdBox Platform. So if you are building ColdBox applications, you do not have to do anything; CacheBox is already part of the platform. The main difference between both versions is the instantiation and usage namespace, the rest is the same.

The best way to install CacheBox is using CommandBox CLI and package manager.

System Requirements

CacheBox has been designed to work under the following CFML Engines:

  • Adobe ColdFusion 2016+

  • Lucee 4.5+

Manual Installation

If you are using CacheBox within a ColdBox application context, then CacheBox is part of the platform. Just install ColdBox normally. If you are using CacheBox standalone, just drop CacheBox in your application root or create a mapping called cachebox that points to the installation folder. If you can run the following snippet, then CacheBox is installed correctly:

cachebox = new cachebox.system.cache.CacheFactory();

Note Please remember that if you use the standalone version the namespace is cachebox.system.cache and if you use the ColdBox application version it is coldbox.system.cache. From this point on, we will use the standalone namespace for simplicity.

CommandBox Installation

You can leverage to install the standalone version of CacheBox

# Latest CacheBox
box install cachebox

# Bleeding Edge
box install cachebox@be

Namespaces

Standalone

cachebox.system.cache

ColdBox

coldbox.system.cache

Note All examples in this book are based on the standalone namespace.

Download CacheBox Standalone
CommandBox