From 344d1fec7b369541039782d7ab8c0be520b3f4c2 Mon Sep 17 00:00:00 2001 From: John Crepezzi Date: Tue, 29 Nov 2011 09:25:22 -0500 Subject: [PATCH] Add more detail to README --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 068608f..39725f1 100644 --- a/README.md +++ b/README.md @@ -27,9 +27,21 @@ which will output a URL to share containing the contents of `cat something`'s ST 3. `npm install` 4. `npm start` +## Settings + +* `host` - the host the server runs on (default localhost) +* `port` - the port the server runs on (default 7777) +* `keyLength` - the length of the keys to user (default 10) +* `maxLength` - maximum length of a paste (default none) +* `staticMaxAge` - max age for static assets (86400) +* `recompressStatisAssets` - whether or not to compile static js assets (true) +* `documents` - static documents to serve (ex: http://hastebin.com/about.com) in addition to static assets. These will never expire. +* `storage` - storage options (see below) +* `logging` - logging preferences + ## Storage -## File +### File To use file storage (the default) change the storage section in `config.js` to something like: @@ -59,6 +71,8 @@ Once you've done that, your config section should look like: } ``` +You can also set an `expire` option to the number of seconds to expire keys in. This is off by default, but will constantly kick back expirations on each view or post. + All of which are optional except `type` with very logical default values. ## Author