cryptalk/README.md

77 lines
2.2 KiB
Markdown
Raw Normal View History

2014-09-19 13:59:10 -04:00
![cryptalk](/docs/screenshot.png)
Cyptalk is a HTML5/Node.js based encrypted instant chat
Features
2014-09-18 03:24:21 -04:00
========
2014-09-19 14:01:28 -04:00
* Client side AES-256-CBC encryption/decryption (the server is just a messenger)
* 256 bit key derived from your passphrase using PBKDF2
2014-09-19 13:59:10 -04:00
* Optional nicknames
* Random (UUID v4) channel name generation för less guessability
* Quick-links (not recommended) using http://server/#Room:Passphrase
* Super simple setup
2014-09-20 09:26:43 -04:00
* Notification sounds (mutable)
2014-09-23 14:19:00 -04:00
* Native popup notifications
* Configurable page title
2014-09-19 13:59:10 -04:00
* ~~Flashing title on new messages~~
2014-09-18 13:48:17 -04:00
2014-09-19 13:59:10 -04:00
Setup
2014-09-18 13:48:17 -04:00
========
2014-09-18 17:13:10 -04:00
Install node.js, exact procedure is dependant on platform and distribution.
2014-09-18 13:54:45 -04:00
2014-09-18 13:48:17 -04:00
Clone this repo
2014-09-18 13:54:45 -04:00
```bash
git clone https://github.com/Hexagon/cryptalk.git
cd cryptalk
```
2014-09-18 13:48:17 -04:00
2014-09-18 13:54:45 -04:00
Pull express.io and node-uuid from npm.
```bash
npm install node-uuid express.io
```
2014-09-18 13:48:17 -04:00
2014-09-18 13:54:45 -04:00
Start server
```bash
node server.js
```
2014-09-18 13:48:17 -04:00
2014-09-19 13:59:10 -04:00
Browse to ```http://localhost:8080```
2014-09-19 14:05:30 -04:00
Usage
========
```
2014-09-23 14:19:00 -04:00
Available commands:
Client:
/key StrongPassphrase Sets encryption key
/nick NickName Sets an optional nick
/mute Audio on
/unmute Audio off
/clear Clear on-screen buffer
/help This
/title Set your local page title
Room:
/generate Generate random room
/join RoomId Join a room
/leave Leave the room
/count Count participants
Host:
/hosts List available hosts
/connect HostIndex Connect to selected host
/disconnect Disconnect from host
You can select any of the five last commands/messages with up/down key.
Due to security reasons, /key command is not saved, and command
history is automatically cleared after one minute of inactivity.
2014-09-21 08:20:25 -04:00
2014-09-19 14:05:30 -04:00
```