2017-07-31 20:47:54 +08:00
|
|
|
[](https://labs.xwiki.com/xwiki/bin/view/Main/WebHome)
|
2015-07-02 20:18:52 +08:00
|
|
|
|
2014-11-06 20:10:16 +08:00
|
|
|
<p align="center">
|
2017-07-31 20:47:54 +08:00
|
|
|
|
2014-11-06 20:10:16 +08:00
|
|
|
</p>
|
2014-10-31 23:42:58 +08:00
|
|
|
|
2017-07-31 20:47:54 +08:00
|
|
|
CryptPad is the **Zero Knowledge** realtime collaborative editor.
|
2014-10-31 23:42:58 +08:00
|
|
|
|
|
|
|
|
Encryption carried out in your web browser protects the data from the server, the cloud
|
2017-07-31 20:47:54 +08:00
|
|
|
and the NSA. It relies on the [ChainPad] realtime engine.
|
2014-10-31 23:42:58 +08:00
|
|
|
|
2017-07-31 20:47:54 +08:00
|
|
|
<!--If you'd like to know more, please read [the Whitepaper]().-->
|
2014-10-31 23:42:58 +08:00
|
|
|
|
2016-09-26 22:14:45 +08:00
|
|
|
# Installation
|
2016-03-04 18:28:27 +08:00
|
|
|
|
2017-07-31 20:47:54 +08:00
|
|
|
Installing CryptPad is pretty straightforward. You can read all about it in the
|
|
|
|
|
[installation guide](https://github.com/xwiki-labs/cryptpad/wiki/Installation-guide).
|
2016-03-04 19:14:40 +08:00
|
|
|
|
2017-07-31 20:47:54 +08:00
|
|
|
It also contains information on keeping your instance of CryptPad up to date.
|
2017-05-06 03:33:45 +08:00
|
|
|
|
2017-07-31 20:47:54 +08:00
|
|
|
## Setup using Docker
|
2016-03-04 19:14:40 +08:00
|
|
|
|
2017-07-31 20:47:54 +08:00
|
|
|
See [Cryptpad-Docker](docs/cryptpad-docker.md)
|
2017-03-13 18:29:08 +08:00
|
|
|
|
2017-07-31 20:47:54 +08:00
|
|
|
# Security
|
2014-11-04 03:43:43 +08:00
|
|
|
|
2016-01-29 18:53:11 +08:00
|
|
|
CryptPad is *private*, not *anonymous*. Privacy protects your data, anonymity protects you.
|
2014-11-04 03:43:43 +08:00
|
|
|
As such, it is possible for a collaborator on the pad to include some silly/ugly/nasty things
|
|
|
|
|
in a CryptPad such as an image which reveals your IP address when your browser automatically
|
2016-08-22 08:54:42 +08:00
|
|
|
loads it or a script which plays Rick Astleys's greatest hits. It is possible for anyone
|
2014-11-04 03:43:43 +08:00
|
|
|
who does not have the key to be able to change anything in the pad or add anything, even the
|
2016-08-22 08:54:42 +08:00
|
|
|
server, however the clients will notice this because the content hashes in ChainPad will fail to
|
|
|
|
|
validate.
|
2014-11-04 03:43:43 +08:00
|
|
|
|
|
|
|
|
The server does have a certain power, it can send you evil javascript which does the wrong
|
|
|
|
|
thing (leaks the key or the data back to the server or to someone else). This is however an
|
|
|
|
|
[active attack] which makes it detectable. The NSA really hates doing these because they might
|
|
|
|
|
get caught and laughed at and humiliated in front of the whole world (again). If you're making
|
|
|
|
|
the NSA mad enough for them to use an active attack against you, Great Success Highfive, now take
|
|
|
|
|
the battery out of your computer before it spawns Agent Smith.
|
|
|
|
|
|
|
|
|
|
Still there are other low-lives in the world so using CryptPad over HTTPS is probably a good idea.
|
|
|
|
|
|
2017-07-31 20:47:54 +08:00
|
|
|
# Translations
|
2016-11-04 21:10:32 +08:00
|
|
|
|
|
|
|
|
We'd like to make it easy for more people to use encryption in their routine activities.
|
2017-03-04 00:16:06 +08:00
|
|
|
As such, we've tried to make language-specific parts of CryptPad translatable. If you're
|
|
|
|
|
able to translate CryptPad's interface, and would like to help, please contact us!
|
2016-11-04 21:10:32 +08:00
|
|
|
|
|
|
|
|
You can also see [our translation guide](/customize.dist/translations/README.md).
|
|
|
|
|
|
2017-07-31 20:47:54 +08:00
|
|
|
# Contacting Us
|
2016-11-04 21:10:32 +08:00
|
|
|
|
2017-03-04 00:16:06 +08:00
|
|
|
You can reach members of the CryptPad development team on [twitter](https://twitter.com/cryptpad),
|
2016-11-04 21:10:32 +08:00
|
|
|
via our [github issue tracker](https://github.com/xwiki-labs/cryptpad/issues/), on the
|
|
|
|
|
[freenode](http://webchat.freenode.net/?channels=%23cryptpad&uio=MT1mYWxzZSY5PXRydWUmMTE9Mjg3JjE1PXRydWUe7)
|
|
|
|
|
irc network, or by [email](mailto:research@xwiki.com).
|
|
|
|
|
|
2017-07-31 20:47:54 +08:00
|
|
|
# Contributing
|
2014-12-03 08:51:43 +08:00
|
|
|
|
|
|
|
|
We love Open Source and we love contribution. It is our intent to keep this project available
|
|
|
|
|
under the AGPL license forever but in order to finance more development on this and other FOSS
|
|
|
|
|
projects, we also wish to sell other licenses to this software. Before making a pull request,
|
|
|
|
|
please read and
|
|
|
|
|
[sign the Commons Management Agreement](https://www.clahub.com/agreements/cjdelisle/cryptpad).
|
2014-11-04 03:43:43 +08:00
|
|
|
|
2016-06-20 16:43:30 +08:00
|
|
|
If you have any questions or comments, or if you're interested in contributing to Cryptpad, come say hi on IRC, `#cryptpad` on Freenode.
|
|
|
|
|
|
2017-07-31 20:47:54 +08:00
|
|
|
# License
|
|
|
|
|
|
|
|
|
|
|
2014-12-05 18:01:43 +08:00
|
|
|
|
|
|
|
|
This software is and will always be available under the GNU Affero General Public License as
|
|
|
|
|
published by the Free Software Foundation, either version 3 of the License, or (at your option)
|
|
|
|
|
any later version. If you wish to use this technology in a proprietary product, please contact
|
|
|
|
|
sales@xwiki.com
|
2014-11-04 03:43:43 +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
|
2014-11-04 03:43:43 +08:00
|
|
|
[active attack]: https://en.wikipedia.org/wiki/Attack_(computing)#Types_of_attacks
|
2015-01-31 01:12:20 +08:00
|
|
|
[Creative Commons Attribution 2.5 License]: http://creativecommons.org/licenses/by/2.5/
|
