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 <port> The port or unix path to listen
--host <host> The hostname to listen [localhost]
--path <path> The pathname to listen [null]
-c, --config <file> Specify a configuration file
-r, --redirects <num> Max redirects allowed, default is 4
-s, --secret <token> 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/<reverse-domain>/<digest>/<image-path>
The <digest>
is a 32 character hex encoded HMAC digest with a secret in md5 hash. And the <image-path>
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:
var substitute = ;substituteserver = 'https://example.com';substitutesecret = 'a secret that match the server secret'; var newSrc = substitutelink'http://path/to/image'; // replace all image srcvar newHtml = substitute;
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
var substitute = ;console; substitute; var server = ;server