From f5c6a3b2b5538f65f46d2507aa0b86a25bc4c795 Mon Sep 17 00:00:00 2001 From: Hexagon Date: Tue, 17 Jan 2017 22:30:16 +0100 Subject: [PATCH] Updating ignorefiles. Documentation. Release 1.1.11. --- .dockerignore | 18 ++++++++++++- .npmignore | 10 +++++++ README.md | 73 +++++++++++++++++++++++++++------------------------ package.json | 2 +- 4 files changed, 66 insertions(+), 37 deletions(-) create mode 100644 .npmignore diff --git a/.dockerignore b/.dockerignore index 5171c54..3964b7d 100644 --- a/.dockerignore +++ b/.dockerignore @@ -1,2 +1,18 @@ +# Node.js/npm stuff node_modules -npm-debug.log \ No newline at end of file +npm-debug.log +npm-shrinkwrap.json +package.json + +# Cryptalk documentation +docs + +# Git stuff +.git +.gitignore + +# Travis CI configuration +.travis.yml + +# Heroku metadata +app.json \ No newline at end of file diff --git a/.npmignore b/.npmignore new file mode 100644 index 0000000..ff9d95c --- /dev/null +++ b/.npmignore @@ -0,0 +1,10 @@ +# Docker stuff +.dockerignore +Dockerfile +docker-entrypoint.sh + +# Heroku stuff +app.json + +# GitHub documentation +docs/ \ No newline at end of file diff --git a/README.md b/README.md index 8b030ef..03e7969 100644 --- a/README.md +++ b/README.md @@ -13,24 +13,56 @@ Features * Client side AES-256-CBC encryption/decryption (the server is just a messenger) * 256 bit key derived from your passphrase using PBKDF2 - * Message is torched after a configurable delay, default is 600s. - * Optional nicknames - * Quick-links (not recommended!) using http://server/#Room:Passphrase - * Super simple setup + * Messages torched after a configurable delay, default is 600s. + * Simple setup using npm, Docker or Heroku * Notification sounds (mutable) * Native popup notifications * Configurable page title - * Heroku support + * Nicknames, optional. + * Quick-links using http://server/#Room:Passphrase, optional and insecure +Docker setup +======== + +To run latest cryptalk with docker, exposed on host port 80, simply run the following command to pull it from docker hub + +```bash +sudo docker run -d --restart=always -p 80:8080 hexagon/cryptalk +``` + Heroku setup ======== +Click the button below + [![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https://github.com/hexagon/cryptalk) -Regular setup + +Docker setup without using docker hub +======== + +Clone this repo, enter the new directory. + +Build image +```bash +docker build . --tag="hexagon/cryptalk" +``` + +Run container, enable start on boot, expose to port 80 at host +```bash +sudo docker run -d --restart=always -p 80:8080 hexagon/cryptalk +``` + +Browse to ```http:///``` + +Done! + + + +npm setup ======== Install node.js, exact procedure is dependant on platform and distribution. @@ -51,35 +83,6 @@ Browse to ```http://localhost:8080``` Done! -Docker setup -======== - -To run latest cryptalk with docker, exposed on host port 80, simply run the following command to pull it from docker hub - -```bash -sudo docker run -d --restart=always -p 80:8080 hexagon/cryptalk -``` - - -Docker setup (manual) -======== - -Clone this repo, enter the new directory. - -Build image -```bash -docker build . --tag="hexagon/cryptalk" -``` - -Run container, enable start on boot, expose to port 80 at host -```bash -sudo docker run -d --restart=always -p 80:8080 hexagon/cryptalk -``` - -Browse to ```http:///``` - -Done! - Developer setup ======== diff --git a/package.json b/package.json index baa9bbd..2be560b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name" : "cryptalk", - "version" : "1.1.10", + "version" : "1.1.11", "description" : "Encrypted HTML5/Node.JS instant chat", "main" : "server.js", "subdomain": "cryptalk",