Fork me on GitHub Fork me on GitHub

jaggery.conf


{
    "displayName": "Minimal Sample",
    "welcomeFiles": ["index.jag", "index.html"],
    "logLevel": "debug",
    "errorPages": [{
        "errorCode": "500",
        "location": "/error1.html"
    }, {
        "errorCode": "404",
        "location": "/error.html"
    }],
    "securityConstraints": [{
        "securityConstraint": {
            "webResourceCollection": {
                "name": "foo",
                "urlPatterns": ["/bar/*"],
                "methods": ["GET", "POST", "PUT", "DELETE"]
            },
            "authRoles": ["admin"]
         }
    }],
    "loginConfig": {
        "authMethod": "BASIC"
    },
    "securityRoles": ["admin", "everyone"],
    "urlMappings": [{
        "url": "/sample/uri-mapping",
        "path": "/index.jag"
    }]
}

Overview

Jaggery configuration file specifies the application specific configurations


Configuration Options

Configuration Description
displayName
"displayName" : "Minimal Sample"
The display name of the application
welcomeFiles
"welcomeFiles" : ["index.jag", "index.html"]
specifys an array of welcome files
logLevel
"logLevel" : "info"
specifys log level [info|debug|error|warn|fatal] for application
errorPages
"errorPages":[{ "errorCode":"500", "location":"/error1.html" }]
specifys an error page for the corresponding HTTP error code
securityConstraints
"securityConstraints": [{
    "securityConstraint": {
        "webResourceCollection": {
            "name": "foo",
            "urlPatterns": ["/bar/*"],
            "methods": ["GET", "POST", "PUT", "DELETE"]
        },
        "authRoles": ["admin"]
    }
}]

specifys security constraint for a certain web resource (jaggery file/directory etc).

loginConfig
["BASIC"
| "CLIENT-CERT"
| "FORM"]
"loginConfig":{ "authMethod":"BASIC" }
specifys login mechanism "BASIC" or "FORM"
securityRoles
"securityRoles":["admin", "everyone"]
specifys the roles that applies to application's security constraints
urlMappings
"urlMappings" : [{ "url" : "/sample/uri-mapping", "path" : "/index.jag" }]
specifys URL mappings
distributable
"distributable" : true
application will distributable. It allow to use session replication efficiently.
initScripts
"initScripts" : [ "init.js" ]
specifys scripts to run at application deployment time.
destroyScripts
"destroyScripts" : [ "destroy.js" ]
specifys scripts to run when application undeploy.