cryptpad/readme.md

27 lines
995 B
Markdown
Raw Normal View History

2014-10-31 23:42:58 +08:00
# CryptPad
Unity is Strength - Collaboration is Key
![and_so_it_begins.png](https://github.com/cjdelisle/cryptpad/raw/master/and_so_it_begins.png "We are the 99%")
CryptPad is a **zero knowledge** realtime collaborative editor.
Encryption carried out in your web browser protects the data from the server, the cloud
2014-10-31 23:44:26 +08:00
and the NSA. This project uses the [CKEditor] Visual Editor and the [ChainPad] realtime
2014-10-31 23:42:58 +08:00
engine. The secret key is stored in the URL [fragment identifier] which is never sent to
the server but is available to javascript so by sharing the URL, you give authorization
2014-10-31 23:44:26 +08:00
to others who want to participate.
2014-10-31 23:42:58 +08:00
2014-10-31 23:44:26 +08:00
To install:
2014-10-31 23:42:58 +08:00
2014-10-31 23:44:26 +08:00
git clone <this repo>
npm install
npm install -g bower ## if necessary
bower install
## edit server.js to modify configuration (use your own mongodb instance)
node ./server.js
2014-10-31 23:42:58 +08:00
2014-10-31 23:44:26 +08:00
[ChainPad]: https://github.com/xwiki-contrib/chainpad
[CKEditor]: http://ckeditor.com/
[fragment identifier]: https://en.wikipedia.org/wiki/Fragment_identifier