Skip to content

Update README.md #219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 26, 2024
Merged

Update README.md #219

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 50 additions & 50 deletions embedded-server/server.json/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Every time you start a server, the settings used to start it are saved in a `ser
{
"name": "",
"openBrowser": true,
"openBrowserURL" : "http://localhost/admin/login",
"openBrowserURL": "http://localhost/admin/login",
"startTimeout": 240,
"stopsocket": 50123,
"debug": false,
Expand All @@ -19,10 +19,10 @@ Every time you start a server, the settings used to start it are saved in a `ser
"trayEnable": true,
"trayicon": "/path/to/trayicon.png",
// Used for host-updater module, but not for bindings
"hostAlias" : "site.com",
"env" : {
"ANYTHING_HERE" : "you want",
"THESE_ARE_ADDED" : "As environment variables to the server"
"hostAlias": "site.com",
"env": {
"ANYTHING_HERE": "you want",
"THESE_ARE_ADDED": "As environment variables to the server"
},
"trayOptions": [
{
Expand All @@ -33,39 +33,40 @@ Every time you start a server, the settings used to start it are saved in a `ser
"image": "/path/to/image.png"
},
{
"label":"Open VScode",
"action":"runAsync",
"command":"code .", //command is run relative to webroot, for box commands begin command with `box`
"label": "Open VScode",
"action": "runAsync",
"command": "code .", // Command is run relative to webroot, for box commands begin command with `box`
"disabled": false,
"image": "/path/to/image.png"
},
{
"label":"Open Webroot",
"action":"openfilesystem",
"path":"./", //path is relative to your webroot
"label": "Open Webroot",
"action": "openfilesystem",
"path": "./", // Path is relative to your webroot
"disabled": false,
"image": "/path/to/image.png"
}
],
"jvm": {
"heapSize": 512,
"minHeapSize": 256,
"args" : [ //can be a string or an array
"-XX:+UseG1GC",
"-XX:-CreateMinidumpOnCrash",
"--add-opens=java.base/java.net=ALL-UNNAMED"
],
"javaHome" : "/path/to/java/home",
"javaVersion" : "openjdk11"
"args": [
// Can be a string or an array
"-XX:+UseG1GC",
"-XX:-CreateMinidumpOnCrash",
"--add-opens=java.base/java.net=ALL-UNNAMED"
],
"javaHome": "/path/to/java/home",
"javaVersion": "openjdk11"
},
"web": {
"host": "127.0.0.1",
// Used for default bindings
"hostAlias" : "site.com",
"hostAlias": "site.com",
"webroot": "src/cfml",
"directoryBrowsing": true,
"accessLogEnable": true,
"maxRequests":30,
"maxRequests": 30,
"gzipEnable": true,
"gzipPredicate": "regex( '(.*).css' ) and request-larger-than( 500 )",
"aliases": {
Expand Down Expand Up @@ -96,8 +97,7 @@ Every time you start a server, the settings used to start it are saved in a `ser
"enable": false,
"port": 8009
},
"bindings" : {
}
"bindings": {},
"rewrites": {
"enable": true,
"logEnable": true,
Expand All @@ -113,36 +113,35 @@ Every time you start a server, the settings used to start it are saved in a `ser
}
},
"rules": [
"path-suffix(/box.json) -> set-error(404)",
"path-prefix(.env) -> set-error(404)",
"path-prefix(/admin/) -> ip-access-control(192.168.0.* allow)",
"path(/sitemap.xml) -> rewrite(/sitemap.cfm)",
"disallowed-methods(trace)"
"path-suffix(/box.json) -> set-error(404)",
"path-prefix(.env) -> set-error(404)",
"path-prefix(/admin/) -> ip-access-control(192.168.0.* allow)",
"path(/sitemap.xml) -> rewrite(/sitemap.cfm)",
"disallowed-methods(trace)"
],

//3 ways to specify rulesFile
// 3 ways to specify rulesFile:
"rulesFile": "../secure-rules.json",
// Or...
// Or...
"rulesFile": [
"../security.json",
"../rewrites.json",
"../app-headers.json"
"../security.json",
"../rewrites.json",
"../app-headers.json"
],
// Or...
"rulesFile":"../rules/*.json",

"rulesFile": "../rules/*.json",
"directoryListing": true,
"blockCFAdmin": false,
"blockSensitivePaths": true,
"blockFlashRemoting": true
"blockSensitivePaths": true,
"blockFlashRemoting": true
},
"sites" : {
"site-name-here" : {
"sites": {
"site-name-here": {
// Any valid option from "web" plus "profile"
},
"another-site-name-here" : {
"another-site-name-here": {
// Any valid option from "web" plus "profile"
}
}
}
},
"app": {
"logDir": "",
"libDirs": "",
Expand All @@ -155,17 +154,18 @@ Every time you start a server, the settings used to start it are saved in a `ser
"serverHomeDirectory": "",
"sessionCookieSecure": true,
"sessionCookieHTTPOnly": true,
"webXMLOverride" : "path/to/web.xml",
"webXMLOverrideForce" : false
"webXMLOverride": "path/to/web.xml",
"webXMLOverrideForce": false
},
"runwar": {
"jarPath": "/path/to/runwar.jar",
"args" : [ //can be a string or an array
"--runwar-option",
"value",
"--runwar-option2",
"value2"
]
"args": [
// Can be a string or an array
"--runwar-option",
"value",
"--runwar-option2",
"value2"
],
"XNIOOptions": {
"WORKER_NAME": "MyWorker"
},
Expand Down