REQUEST_ID_HEADER
- set request id header name to enable cc-request-id middleware
MAINTENANCE_ENABLED
- set to true to enable maintenance mode on server
MAINTENANCE_MESSAGE
- maintenance message sent to clients when maintenance mode is enabled
MAINTENANCE_OVERRIDE_HEADER
- bypass maintenance mode with this header
ALLOWED_IP
- list of ip addresses allowed to bypass maintenance mode
COMPRESION_ENABLED
- set to true to enable compression middleware
COMPRESSION_LEVEL
- compressions level if compression is enabled
NO_COMPRESSION_HEADER
- don't compress responses with this request header
MORGAN_FORMAT
- format for morgan
- see morgan predefined formats
- default is tiny
CORS_WHITELIST
- configuring CORS w/ dynamic origin
STATIC_ENGINE_TYPE
VIEWS_FOLDER
- use template engines
STATIC_FOLDER
- serve static files
ADD_HEALTHCHECK
- add /healthcheck endpoint which returns OK with status code 200
ADD_IS_RUNNING
- add /is_running endpoint which returns OK with status code 200

Example

First, create index.js:

const Osseus = require('osseus')

const main = async () => {
	try {
		// init osseus
		const osseus = await Osseus.init()
  	} catch (err) {
		console.error(err)
  	}
}

main()

Running:

$ node index.js --OSSEUS_SERVER_PORT 8080

Will result in:

server is listening on port: 8080

Contributing

Please see contributing guidelines.

License

Code released under the MIT License.