Updating ignorefiles. Documentation. Release 1.1.11.

This commit is contained in:
Hexagon 2017-01-17 22:30:16 +01:00
parent 7dc1d385ab
commit f5c6a3b2b5
4 changed files with 66 additions and 37 deletions

View File

@ -1,2 +1,18 @@
# Node.js/npm stuff
node_modules
npm-debug.log
npm-debug.log
npm-shrinkwrap.json
package.json
# Cryptalk documentation
docs
# Git stuff
.git
.gitignore
# Travis CI configuration
.travis.yml
# Heroku metadata
app.json

10
.npmignore Normal file
View File

@ -0,0 +1,10 @@
# Docker stuff
.dockerignore
Dockerfile
docker-entrypoint.sh
# Heroku stuff
app.json
# GitHub documentation
docs/

View File

@ -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://<ip-of-server>/```
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://<ip-of-server>/```
Done!
Developer setup
========

View File

@ -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",