Configuration

Environment variables

Server config file

By default, Unnode.js will look for the server config file at server-dir/config/unnode-server-config.js or at the path specified in UNNODE_SERVER_CONFIG environment variable.

See below for an example config file.

The file should export an array of objects with the following properties:

const logger  = require('unnode').workerLogger
const unUtils = require('unnode').utils
 
class IndexController {
    constructor() {
 
    }
 
    index(customParameter, req, res) {
        const ip     = unUtils.getClientIp(req)
        const method = req.method
        const url    = unUtils.getRequestFullUrl(req)
        const agent  = req.get('user-agent')
 
        logger.log('info',
            `Request ${method} ${url} (from: ${ip}, `
            + `User-Agent: ${agent})`)
 
        res.send('Hello World!')
    }
}
 
module.exports = new IndexController()

Example config:

//
// config/unnode-server-config.js
//

module.exports = [
    {
        // Answer on localhost also for development
        'vhost': ['localhost', 'my-site.org'],
        'secureContext': {
            'key': process.env.UNNODE_SERVER_SECURE_DEFAULT_KEY,
            'cert': process.env.UNNODE_SERVER_SECURE_DEFAULT_CERT
        },
        'helmetOptions': {
            // Allow external google font imports in our CSP policy
            contentSecurityPolicy: {
                directives: {
                    'default-src': ["'self'"],
                    'img-src': ["'self'", 'img.shields.io'],
                    'style-src': ["'self'", "'unsafe-inline'", 'fonts.googleapis.com'],
                    'font-src': ["'self'", 'fonts.gstatic.com'],
                    'script-src': ["'self'", "'unsafe-eval'"],
                    'object-src': ["'self'"],
                }
            }
        },
        'robotsTxt': "User-agent: *\nAllow: /",
        'serveFavicon': path.resolve(__dirname, '..', 'favicon.ico'),
        'routes': [
            // Serve some html pages
            {
                method: 'GET',
                path: '/',
                controller: 'site-controller#index',
                cacheControl: noCache
            },
            {
                method: 'GET',
                path: '/team',
                controller: 'site-controller#teamPage',
                cacheControl: noCache
            },
 
            // Serve some static assets
            { path: '/css', static: path.resolve(__dirname, '..', 'css') },
            { path: '/js', static: path.resolve(__dirname, '..', 'js') },
            { path: '/images', static: path.resolve(__dirname, '..', 'images') },
            { path: '/shared/images', static: path.resolve(__dirname, '..', 'images') },
        ]
    },
 
    {
        // This will catch every other request not matched to the above vhosts
        'vhost': ['*'],
        'routes': [
            {
                method: 'GET',
                path: '/',
                // Serve a 404 page via our controller
                controller: 'site-controller#not_found'
            }
        ]
    }
]

Next: Process clustering