@imaginarium/vestibulum v0.5.0

imaginarium.VESTIBULUM

Serve static files

Standalone Usage

imaginarium.VESTIBULUM can be used as standalone http static server.

git clone https://framagit.org/imaginarium/Vestibulum
cd vestibulum
npm install
npm start

Docker Image

imaginarium.VESTIBULUM didn't have official builds yet. You need to build them yourself.

git clone https://framagit.org/imaginarium/vestibulum
cd vestibulum
docker build -t imaginarium/vestibulum:latest -f Docker/latest.dockerfile .

You can next build image with pre-installed imaginarium.CERBERUM :

docker build -t imaginarium/vestibulum:cerberum-latest -f Docker/cerberum.dockerfile .

Configuration

Some parameters can be set with Environnement Variables. Exemple :

PORT=8282 npm start

PORT

default: 8080

PUBLICDIR

— not implanted yet — Root directory for your static server.
default: ./public

Module Usage

imaginarium.VESTIBULUM can also be used as part of your own project, as module.

npm install -save @imaginarium/vestibulum

const vestibulum = require('@imaginarium/vestibulum')

/* … */

const server = http.createServer(vestibulum)
server.listen(port)

— It's planned to offer the possibility of directly running a full HTTP static server, but for now you need to setup it yourself.

imaginarium.VESTIBULUM can be used with imaginarium.CERBERUM, simply add @imaginarium/cerberum to your project :

npm install --save @imaginarium/cerberum

Middleware usage

— not recommended —

imaginarium.VESTIBULUM is not intended to be used as Middleware… However, it's actually possible to do that, but it did not have a next callback.

If you wan't to use imaginarium.CERBERUM, just remember : it'll protect only imaginarium.VESTIBULUM.

— It's planned to make Middleware usages evolve.