module.exports = {
    /**********************************************************************************
    * Each host has it's own "hostConfig" section.                                    *
    * The key must match the received reqest hostname.                                *
    * **/!\** when requesting your local machine the request will have a              *
    *         _null_ hostname, _stuback_ will then lookup for a _localhost_ config.   *
    **********************************************************************************/
    localhost: {
 
        // Optional server to redirect request to
        //(useful when stuback is used as a system or browser proxy)
        targetHost: 'mydevelopmentserver.net',
 
        // Optional port to redirect request to
        targetPort: '8080',
 
        // When true stuback will try to proxy any request which doesn't match defined
        // paths in stubbed or backed.
        // If false you will get an error on not stubbed or backed urls.
        // You probably want true for a system defined proxy and probably in most cases
        passthrough: true,
 
        // default proxyied request doesn't timeout. You can set a timeout on a by host basis.
        timeout: 5000,
 
        /***************************************************************************
        * *stubs* contains a list of path which will be looked up for a stub file. *
        ***************************************************************************/
        stubs: {
            // Keys are path patterns (as in connect/express) of urls to stubs,
            // they will be looked up in order they are defined.
            '/api/doc.html': true, // boolean value can be used as a shortcut for {use: true}
 
            '/api/*': {
                // True if ommited, tell stuback whether this path should be used
                // for url matching or not. This is a convenience to quickly disable
                // a path from the config without removing the it from the file.
                use: true,
 
                // You can defined specific response headers for a given path.
                // They will be applied after hostConfig.responseHeaders and hostConfig.stubs.responseHeaders settings
                // Any falsy value will result in header removal.
                responseHeaders: {
                    // add a Content-Type header
                    'Content-Type': 'application/vnd.myapimediatype+json',
                    // remove any WWW-Authenticate header
                    'WWW-Authenticate': false
                },
 
                // Optionally you can force a particular response statusCode for a given path
                statusCode: 500
 
                // don't include this, it's just here to tell you that it's a reserved name
                exp: undefined
            },
 
            // You can defined specific response headers for all stubbed paths at once.
            // They will be applied after hostConfig.responseHeaders settings and
            // before hostConfig.stubs.path.responseHeaders.
            // Falsy values will result in header removal.
            responseHeaders: { 'Content-Type': 'application/json' }
        },
 
        /*************************************************************************************
        * **backed** contains a list of path patterns which will be looked up _after_        *
        * the one in stubs.                                                                  *
        * Each paths has it's own config as in stubs.                                        *
        * If a url matched then it will try to reach the remote server and will backup       *
        * the response in your stubs directory before returning it as a response.            *
        * If the remote server request doesn't work then the backup will be returned instead.*
        * All configs from stubs section may apply here.                                     *
        *************************************************************************************/
        backed: {
            // Keys are path patterns (as in connect/express) of urls to backup.
            // They will be looked up in order they are defined.
            '/*': {
                use: true,
                responseHeaders: {
                    'Content-Type': 'Application/json'
                },
                statusCode: 200,
 
                // by default each request to the remote server are considered success
                // whenever the server gave one, whatever their status code is.
                // So stuback will probably save an empty stub on 404 or 500 server error.
                // It can actually be the right thing to reply but if not
                // *backedStatusCode* is a list of remote server statusCode you want to
                // consider erroneous. So the actual stub file will be returned instead
                // if the server respond with one of the given codes
                onStatusCode: [404, 500],
 
                // don't include this, it's just here to tell you that it's a reserved name
                exp: undefined
            },
 
            // You can also define statusCodes to consider erroneous for all backed paths at once
            onStatusCode: [500],
        }
 
        // this is not used at this time but reserved for future use.
        tampered: {}
 
        // You can set response headers to add to any stuback response for this specific host.
        // They will be applied first in any cases, falsy values will result in header removal.
        responseHeaders: { // list of headers to add to proxyed response, will be removed if falsy
            'X-stuback-custom': 'stubacked'
        }
    }
 
    // optional credentials for the admin section
    adminLogin: 'login',
    adminPass: 'Password'
}