LogBox : Enterprise Logging & Messaging
7.x
7.x
  • Introduction
    • Contribution Guide
    • Release History
      • What's New With 7.2.0
      • What's New With 7.1.0
      • What's New With 7.0.0
    • Upgrading to LogBox 7
    • About This Book
      • Author
  • Getting Started
    • Features at a Glance
    • Installation
      • LogBox Refcard
    • Need For Logging
    • How Does LogBox Work?
      • LogBox
      • Appender
      • Logger
        • Logger Category Inheritance
        • Security Levels
        • Dynamic Appenders
      • Layout
  • Configuration
    • Configuring LogBox
      • LogBox DSL
      • Adding Appenders
      • Adding Categories to Specific Logging Levels
      • Adding Categories Granularly
      • Configuring The Root Logger
  • Usage
    • Using LogBox
    • Using a Logger Object
      • When To Log
      • ExtraInfo Serialization
    • Appender Properties
      • CFAppender
      • ConsoleAppender
      • DBAppender
      • EmailAppender
      • FileAppender
      • RollingFileAppender
      • ScopeAppender
      • SocketAppender
      • TraceAppender
    • LogBox in a ColdBox Application
      • Configuration Within ColdBox
      • Benefits of using LogBox in a ColdBox application
      • Where is LogBox stored in a ColdBox app?
      • LogBox from the ColdBox Proxy
      • The LogBox Injection DSL
  • Extending LogBox
    • Creating Custom Appenders
      • Helper Methods
      • Instance Members
      • Dealing With Custom Layouts
      • Registering Appenders at Runtime
    • Creating a Custom Layout
      • Instance Members
Powered by GitBook
On this page
  • System Requirements
  • ColdBox Installation
  • Standalone Installation
  • Namespaces

Was this helpful?

Edit on GitHub
Export as PDF
  1. Getting Started

Installation

PreviousFeatures at a GlanceNextLogBox Refcard

Last updated 1 year ago

Was this helpful?

LogBox can be downloaded as a standalone framework or included with the latest ColdBox Platform release. The main difference between both versions is the instantiation and usage namespace; the rest is the same.

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

System Requirements

  • ColdFusion 2018+

  • Lucee 5+

ColdBox Installation

If you are using LogBox within a ColdBox application context, then LogBox is part of the platform. Just configure it via the config/LogBox.cfc and you are ready to roll.

Standalone Installation

You can leverage to install the standalone version of LogBox

# Latest CommandBox
box install logbox

# Bleeding Edge
box install logbox@be

Mappings

You will need the following mappings that all point to the folder you installed logbox into:

this.mappings[ "/logbox" ] = "path.to.logbox";

This will ensure that the appropriate libraries can find each other.

Remember that this only applies to the standalone approach.

If you can run the following snippet, then LogBox is installed correctly:

logbox = new logbox.system.logging.LogBox();

Namespaces

Standalone

logbox.system.logging

ColdBox

coldbox.system.logging

Download LogBox Standalone
API Docs
CommandBox