Updated readme, v1.5.8

This commit is contained in:
Dan Seripap 2016-11-28 13:48:18 -05:00
parent d9a51de7e7
commit d412876bb9

View File

@ -5,10 +5,11 @@
Simple encrypted web chat. Powered by [socket.io](http://socket.io) and the [web cryptography API](https://developer.mozilla.org/en-US/docs/Web/API/Window/crypto). Simple encrypted web chat. Powered by [socket.io](http://socket.io) and the [web cryptography API](https://developer.mozilla.org/en-US/docs/Web/API/Window/crypto).
### Running a local copy ### Running a local copy
Starting at version **1.5.7**, you can run a local copy of Darkwire via Docker through dockerhub. You can run a local copy of Darkwire via Docker through dockerhub. Versions are strictly controlled, (we recommend using the latest tagged version)[https://github.com/seripap/darkwire.io/releases] as older versions may pose some security issues.
``` ```
$ docker run -d -p 80:3000 --name dakrwire darkwire/1.5.7 # Version numbers can be found in latest releases
$ docker run -d -p 80:3000 --name dakrwire darkwire/${VERSION_NUMBER}
``` ```
Docker is now running on local port 80. Docker is now running on local port 80.
@ -23,21 +24,18 @@ $ docker run -p 80:3000 darkwire
Darkwire is now online on local port 80. Default container port is 3000. Darkwire is now online on local port 80. Default container port is 3000.
### Installation ### Installation
# Get latest version of NodeJS for ES2015 support # Using node@v6.7
npm install -g n $ npm install
n stable
npm install
# Starting dev environment # Starting dev environment
npm run dev $ npm run dev
# Running tests locally
brew install chromedriver
npm test
# Running tests locally (Mac)
$ brew install chromedriver
$ npm test
# Start a local instance of darkwire # Start a local instance of darkwire
npm run bundle $ npm run bundle
npm start $ npm start
# Changing ports, default is 3000 # Changing ports, default is 3000
port=3000 npm start port=3000 npm start