ColdBox 102 Tips and Tricks by Luis Majano
Manage Multiple Environments in ColdBox
ColdBox offers a smart way to manage environments by auto-sensing an environment variable called ENVIRONMENT. This allows you to dynamically control the environment in which your application runs, streamlining your development, testing, and production workflows.
ENVIRONMENT Environment Variable
You can define the ENVIRONMENT variable in your .env file to specify which environment your ColdBox application should use. Here’s an example:
#.env file
ENVIRONMENT=development
Once ColdBox detects the ENVIRONMENT variable, it will automatically set the environment in the application and look for matching methods in your configuration files. By default, the environment is called production
How It Works
When the application starts, ColdBox will:
-
Detect the
ENVIRONMENTvariable: If found, it sets the current environment to the value specified (e.g.,development,staging,production). -
Look for a matching method in
ColdBox.cfc: The framework searches for a method inconfig/ColdBox.cfcwith the same name as the environment and executes it if found. For example, ifENVIRONMENT=development, ColdBox looks for adevelopment()method inColdBox.cfc. -
Search modules for matching methods: It also checks each module’s
ModuleConfig.cfcfile for methods matching the environment and executes them during startup.
Precedence
It’s important to note that the ENVIRONMENT variable in your .env file takes precedence over the environment struct in your ColdBox.cfc. So, if both are set, the environment variable will override the value in the config file.
Why Use the ENVIRONMENT Variable?
-
Flexibility: Easily switch between environments (development, staging, production) without modifying your codebase.
-
Automation: Automatically execute environment-specific configurations for both your application and modules.
-
Consistency: Ensures that your environments are defined and managed in a consistent way across all your applications and modules. This is a powerful feature to manage multiple environments in ColdBox. Set up your
ENVIRONMENTvariable today and streamline your application’s environment management!
App Mode Helpers
ColdBox 7 introduces opinionated helpers to the FrameworkSuperType so you can determine if you are in three modes: production, development, and testing by looking at the environment setting:
Copy
function isProduction()
function isDevelopment()
function isTesting()
| Mode | Environment |
|---|---|
inProduction() == true | production |
inTesting() == true | testing |
inDevelopment() == true | development or local |
You can also find these methods in the controller object.
Learn More ColdBox Tips and Tricks
Stay tuned for more ColdBox tips in our ongoing series. if you want to learn more than 10 free tips and tricks make sure to get your “ColdBox 102 tips and tricks book” We have a variety of formats you can choose from.
Join the Ortus Community
Be part of the movement shaping the future of web development. Stay connected and receive the latest updates on, product launches, tool updates, promo services and much more.
Subscribe to our newsletter for exclusive content.
Follow Us on Social media and don’t miss any news and updates:
Add Your Comment