Prepare for release: fix install issues and updated readme.

Author: Robin Duda

README.md

@@ -1,16 +1,59 @@
 # kbn-authentication-plugin [![Build Status](https://travis-ci.org/codingchili/kbn-authentication-plugin.svg?branch=master)](https://travis-ci.org/codingchili/kbn-authentication-plugin)
-Plugin provides authentication through LDAP with 2-factor OTP authentication.
+A plugin adds authentication to Kibana dashboards!
 
-To install on a Kibana dashboard instance, move to kibana/installedPlugins/
+
+#### Building the plugin
+To check out the sources and build the plugin do the following
 ```
 git clone https://github.com/codingchili/kbn-authentication-plugin
 cd kbn-authentication-plugin
-mocha test/
+npm install --arch=ia32
+mocha test --recursive -u tdd
+```
+Perform the following steps to create an installable zip:
+1. Set the kibana version in package.json, must match exactly.
+1. move kbn-authentication-plugin into a folder named 'kibana'.
+2. Create a zip file that includes the 'kibana' folder.
+4. The plugin can then be installed with the kibana-plugin install command, see installing.
+
+##### Dependencies
+
+- NodeJS 6.*
+- NPM
+- MS Build tools
+- Python 2.7
+
+To compile the binary module argon2-ffi build tools are requried, install with
+```
+npm install --global --production windows-build-tools
+```
+This installs MS build tools and python 2.7 and is required for node-gyp to work.
+
+#### Installing
+To install the plugin use the kibana-plugin utility, example:
+```
+./kibana-plugin install 'file:///C:/users/downloads/kbn-authentication-plugin.zip'
 ```
 Make sure to set the correct version in json.config. The version must match the version of Kibana being used.
 
-If the Kibana instance is already running it may be set to reload all plugins on change, if not then try restarting the instance. The authentication plugin is tested working with Kibana version 5.0.0-alpha1.
+#### Features
+- two factor authentication with [time based tokens](https://en.wikipedia.org/wiki/Time-based_One-time_Password_Algorithm).
+- supports scanning a barcode in the [Google Authenticator](https://www.google.se/search?q=Google+authenticator) app for example.
+- supports storing user credentials and keys in a simple json file.
+- supports storing user credentials and keys in [MongoDB](https://www.mongodb.com/).
+- supports storing user credentials in [LDAP](https://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol) and keys in a json file.
+- json web token authentication using Kibanas bundled HAPI package.
+- uses the password hashing contest winner of 2017 for password hashing!
+  - See: [Argon2](https://password-hashing.net/)
+
+##### Troubleshooting
+If the Kibana instance is already running it may be set to reload all plugins on change, if not then try restarting the instance. The authentication plugin is tested working with Kibana version 5.6.2.
+
+If you have issues installing the plugin,
+- make sure that the version in package.json is matching your kibana version.
+- make sure to build with --arch=ia32 as kibana ships with a bundled x86 nodejs for windows.
 
-The plugin is not ready for release yet, currently working with two-factor (TOTP RFC 6238, using QR for distribution) and LDAP authentication. All routes are protected by authentication by default. 
 
-Multi-user capabilities is not yet working fully, all authenticated users share the same indice and dashboards. Multi-user capabilities is implemented by overriding all the routing present in kibana through a proxy, it is a tedious and fail-prone mission. As such access restriction to only allow access to the proxy server is pointless at this stage, users may as well authenticate directly with the Kibana instance.
+##### Known issues
+Multi-user capabilities is completed, all authenticated users share the same indice and dashboards.
+No plans on implementing this for now.

index.js

@@ -18,7 +18,7 @@ const Authentication = require('./src/authentication/auth');
 
 
 module.exports = function (kibana) {
-  console.log('WHAT UP');
+  console.log('kibana authentication plugin by codingchili@github init!');
 
   return new kibana.Plugin({
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "kbn-authentication-plugin",
-  "version": "5.4.2",
+  "version": "5.6.2",
   "description": "Prevents unauthorized access to kbn dashboards.",
   "repository": "https://github.com/codingchili/kbn-authentication-plugin",
   "license": "MIT",

public/login.jade

@@ -31,7 +31,7 @@ html(lang="EN")
         input(type="button", value="LOGIN", onclick='submit();')#submit.button
 
     div.page-footer
-        h4.page-footer-text ©2017
+        h5.page-footer-text ©2017 Robin Duda
     script
       include script/jquery-2.2.3.min.js
       include script/login.js

src/authentication/file.js

@@ -7,21 +7,22 @@
 const Config = require('../config').load('file');
 const Hash = require('./hash');
 const fs = require('fs');
+const filePath = require('path').resolve(__dirname, '../../' + Config.filename);
 let users = [];
 
 
 function load() {
     let data = '{}';
     try {
-        data = fs.readFileSync(Config.filename, {});
+        data = fs.readFileSync(filePath, 'utf-8');
     } catch (e) {
         throw e;
     }
     users = JSON.parse(data);
 }
 
 function save(callback) {
-    fs.writeFile(Config.filename, JSON.stringify(users), (err) => {
+    fs.writeFile(filePath, JSON.stringify(users), (err) => {
         if (err) {
             throw err;
         } else {