From c0b7ad31153e21ddf17ee77d2ce4ed2a3b4ea7f5 Mon Sep 17 00:00:00 2001 From: MShayOffice Date: Tue, 26 Mar 2024 13:16:37 -0700 Subject: [PATCH] Update README.md Spacing/consistency adjustments, added web.directoryListing --- embedded-server/server.json/README.md | 100 +++++++++++++------------- 1 file changed, 50 insertions(+), 50 deletions(-) diff --git a/embedded-server/server.json/README.md b/embedded-server/server.json/README.md index 00bae1a..479d470 100644 --- a/embedded-server/server.json/README.md +++ b/embedded-server/server.json/README.md @@ -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, @@ -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": [ { @@ -33,16 +33,16 @@ 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" } @@ -50,22 +50,23 @@ Every time you start a server, the settings used to start it are saved in a `ser "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": { @@ -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, @@ -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": "", @@ -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" },