publicist-middleware

Publicist Middleware

locking static sites down since 1888

Note: This project is in early development, and versioning is a little different. Read this for more details.

Why should you care?

Let's be clear here, HTTP Basic Auth isn't the most secure thing in the world, but many times it's all you really need. Whether you're staging a site for a private audience or hiding a couple trade secrets adding a username and password to your static site should be easy. Simply provide publicist a username:password string and we'll do the heavy lifting.

Aside from being simple, publicist is also powerful. We allow you to lockdown multiple routes with different usernames and passwords through powerful globstar matching.

Installation

npm install publicist-middleware --save

Usage

This library can be used with connect, express, and any other server stack that accepts the same middleware format. The most simple way to use initiate Basic Auth is by simply passing username:password string:

var http = require('http');
    connect = require('connect'),
    publicist = require('publicist-middleware');

var app = connect()
  .use(publicist('username:password')
  .use(connect.static('public'));

var server = http.createServer(app).listen(1111)

For more control, you can also pass an object with user and pass keys:

var http = require('http');
    connect = require('connect'),
    publicist = require('publicist-middleware');

var app = connect()
  .use(publicist({ user: 'omar', pass: 'allinthegame' })
  .use(connect.static('public'));

var server = http.createServer(app).listen(1111)

To be able to lock down only certain routes, you can use powerful globstar matching and define username:password strings.

var http = require('http');
    connect = require('connect'),
    publicist = require('publicist-middleware');

var app = connect()
  .use(publicist({
    '/secret/*': 'user:pass',
    '/doge/**': 'doge:wow'
  })
  .use(connect.static('public'));

var server = http.createServer(app).listen(1111)

License & Contributing

• Details on the license can be found here
• Details on running tests and contributing can be found here