Using Multiple server.json Files

CommandBox : CLI, Package Manager, REPL & More
Search…
With the advent of Multi-server functionality, you may want to regularly start up the same web site with different settings (such as different CF engine's). To help with this, you can have more than one JSON file.
Create anything.json
The default server configuration file is server.json, but you can actually call the file anything you want as long as you use the file's path (or unique name) when starting the server.
Let's say we want to test our app in Lucee 4, Lucee 5 and Adobe 2016. Let's start 3 servers. Note we give each server a unique name. This will come in handy when we want to start/stop the servers by name later.
1
start cfengine=[email protected] name=lucee4
2
start cfengine=[email protected] name=lucee5
3
start cfengine=[email protected] name=adobe2016
Copied!
Info It's important to always use a name when starting more than one server. Otherwise, the settings will override each other and only the last server will be saved. Also, you will only be able to stop the last server via the stop command.
You can have full control over the name of the JSON files by using the serverConfigFile parameter, but when CommandBox sees us use the name parameter, it will automatically create a file called server-{name}.json. In this case, we'll have 3 new files:
server-lucee4.json
1
{
2
    "app":{
3
        "cfengine":"[email protected]"
4
    },
5
    "name":"lucee4"
6
}
Copied!
server-lucee5.json
1
{
2
    "app":{
3
        "cfengine":"[email protected]"
4
    },
5
    "name":"lucee5"
6
}
Copied!
server-adobe2016.json
1
{
2
    "app":{
3
        "cfengine":"[email protected]"
4
    },
5
    "name":"adobe2016"
6
}
Copied!
Interacting with non-standard JSON file names
If you run the server show command, you'll see it returns {}. This is because it looks for a file called server.json by default. Not to worry, you can still programmatically manipulate your JSON files like so:
1
# Show all properties
2
server show server-lucee5.json
3
​
4
# Show one property
5
server show server-lucee5.json name
6
​
7
# named args are required to set properties
8
server set serverConfigFile=server-lucee5.json jvm.heapSize=1024 
9
​
10
# Clear properties
11
server clear server-lucee5.json jvm
Copied!
Info The property name and server config file path are interchangeable for the server show and server clear commands for your convenience.
Use server JSON files to control servers
Now that you have 3 JSON files-- one for each server, you can use the path to the JSON file (absolute or relative to your CWD) to control each server.
1
start serverConfigFile=server-lucee4.json
Copied!
For your convenience, if you pass in a path to an existing JSON for the server name, we'll use it as the serverConfigFile parameter.
1
start server-lucee4.json
2
stop server-lucee4.json
3
start server-adobe2016.json
Copied!
This trick works on any server commands
1
# Open your Lucee 5 site in the browser
2
server log server-lucee5.json
3
​
4
# cd into the web root for your Adobe 2016 web
5
server cd /path/to/server-adobe2016.json
Copied!
Use server names to control servers
After you've started a server at least once, you can use its server name to control it as well which is a great shortcut. CommandBox will recognize the server name and remember where the server JSON for that server name is stored. Then it will pull the correct web root from the JSON file.
1
start lucee4
2
start lucee5
3
start adobe2106
4
​
5
restart adobe2016
6
stop lucee4
Copied!
Packaging Your Server
Package Management
Copy link
Edit on GitHub
Contents
Create anything.json
Interacting with non-standard JSON file names
Use server JSON files to control servers
Use server names to control servers