turtle.io's Introduction

turtle.io

turtle.io is a HTTP 1.1 web server with a focus on simplicity.

All you need to do is install it, and tell it what directory holds your web sites, & which hostnames to answer for.

Getting Started

Install the module with: npm install turtle.io
Create a script to load & start a server. You could use sample.js in the turtle.io directory (./node_modules/turtle.io) as a template, or see the examples below
[Optional] Edit config.json in the turtle.io directory to configure server defaults; you can override defaults by passing server.start() an Object

Documentation

API documentation is available at api.turtle.io, please visit the wiki.

Support

If you're having problems, use the support forum at CodersClan.

Examples

Virtual hosts

Virtual host keys are the hostname, and the value is the directory relative to "root".

var turtle_io = require("turtle.io"),
    server    = new turtle_io(),
    params;

params = {
	default : "mysite.com",
	port    : 80,
	root    : "/var/www",
	pages   : "errors",
	vhosts  : {
		"mysite.com"         : "mysite.com",
		"another-domain.com" : "another-domain.com"
	}
};

server.start(params);

Proxy routes

The /api route acts as a proxy to another service. This example also utilizes a config.json file local to the server script, for easy DevOps management.

var config    = require("./config.json"),
    turtle_io = require("turtle.io"),
    server    = new turtle_io();

// Setting proxy routes
server.proxy("https://api.github.com", "/api");

server.start(config);