Substitute

A proxy image server. This is a rewrite version of camo.


Installation

Install with npm:

``
$ npm install substitute -g
`

Quick Help

`
$ substitute -h

Usage: substitute [options]

Options:

-b, --bind The port or unix path to listen
--host The hostname to listen [localhost]
--path The pathname to listen [null]
-c, --config Specify a configuration file
-r, --redirects Max redirects allowed, default is 4
-s, --secret A secret token to encrypto urls
-V, --version Display the version
-h, --help Display this help menu
`

URL Formats

Unlike camo, substitute supports only one URL Format:

`
http://example.org///
`

The is a 32 character hex encoded HMAC digest with a secret in md5 hash. And the should be an ecoded/escaped replaced '/' uri.

`
http://example.org/moc.dlrowsmuabe.aidem/d42a08bfa19e5b526b0d2d53eb3b106c/picture/Mincemeat/Pimp.jpg
`

Browser Support

You can get the browser client with component(1):

$ component install lepture/substitute

And generate new src with:

`js
var substitute = require('substitute');
substitute.server = 'https://example.com';
substitute.secret = 'a secret that match the server secret';

var newSrc = substitute.link('http://path/to/image');

// replace all image src
var newHtml = substitute.image(html);
`

Testing

Test it manally, start a server:

`
$ substitute
`

And then visit: this link.

Test it automatically with mocha:

`
$ make test
`

You can also test the client part with:

`
$ make test-client
`

API


`js
var substitute = require('substitute');
console.log(substitute.version);

substitute.defaults({
maxRedirects: 5
});

var server = substitute(secret, options);
server.listen(8000)
``