blitzwing/cryptpad
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

correct out of date portions of the readme

Browse source
This commit is contained in:
ansuz 2017-03-03 17:16:06 +01:00
parent 6e72c6a51b
commit 92066118a1
1 changed files with 18 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
readme.md
View file

@ -35,13 +35,18 @@ bower install
## copy config.js.dist to config.js ## copy config.js.dist to config.js
cp config.js.dist config.js cp config.js.dist config.js
## modify configuration to use your own mongodb instance
## for example aon the default mongodb port `mongodb://localhost:27017/demo_database`
$EDITOR config.js
node ./server.js node ./server.js
``` ```
## Configuration
CryptPad _should_ work with an unmodified configuration file, though there are many things which you may want to customize.
Attributes in the config should have comments indicating how they are used.
```
$EDITOR config.js
```
## Maintenance ## Maintenance
To get access to the most recent codebase: To get access to the most recent codebase:
@ -63,18 +68,20 @@ npm update;
To reset your instance of Cryptpad and remove all the data that is being stored: To reset your instance of Cryptpad and remove all the data that is being stored:
If you are using the leveldb adaptor, this is as simple as deleting the folder which contains your leveldb datastore:
``` ```
# change into your cryptpade directory # change into your cryptpad directory
cd /your/cryptpad/instance/location; cd /your/cryptpad/instance/location;
# delete the datastore # delete the datastore
rm -rf ./cryptpad.db rm -rf ./datastore
``` ```
If you are using the mongodb adaptor, [drop the relevant collection](https://docs.mongodb.org/manual/reference/method/db.collection.drop/#db.collection.drop). If you are using the mongodb adaptor, [drop the relevant collection](https://docs.mongodb.org/manual/reference/method/db.collection.drop/#db.collection.drop).
If you are using the [leveldb adaptor](https://github.com/xwiki-labs/cryptpad-level-store), delete the datastore directory you have configured.
## Testing ## Testing
To test CryptPad, go to http://your.server:3000/assert/ To test CryptPad, go to http://your.server:3000/assert/
@ -108,14 +115,14 @@ Still there are other low-lives in the world so using CryptPad over HTTPS is pro
## Translations ## Translations
We'd like to make it easy for more people to use encryption in their routine activities. We'd like to make it easy for more people to use encryption in their routine activities.
As such, we've tried to make language-specific parts of Cryptpad translatable. If you're 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! able to translate CryptPad's interface, and would like to help, please contact us!
You can also see [our translation guide](/customize.dist/translations/README.md). You can also see [our translation guide](/customize.dist/translations/README.md).
## Contacting Us ## Contacting Us
You can reach members of the Cryptpad development team on [twitter](https://twitter.com/cryptpad), You can reach members of the CryptPad development team on [twitter](https://twitter.com/cryptpad),
via our [github issue tracker](https://github.com/xwiki-labs/cryptpad/issues/), on the via our [github issue tracker](https://github.com/xwiki-labs/cryptpad/issues/), on the
[freenode](http://webchat.freenode.net/?channels=%23cryptpad&uio=MT1mYWxzZSY5PXRydWUmMTE9Mjg3JjE1PXRydWUe7) [freenode](http://webchat.freenode.net/?channels=%23cryptpad&uio=MT1mYWxzZSY5PXRydWUmMTE9Mjg3JjE1PXRydWUe7)
irc network, or by [email](mailto:research@xwiki.com). irc network, or by [email](mailto:research@xwiki.com).
@ -137,11 +144,9 @@ published by the Free Software Foundation, either version 3 of the License, or (
any later version. If you wish to use this technology in a proprietary product, please contact any later version. If you wish to use this technology in a proprietary product, please contact
sales@xwiki.com sales@xwiki.com
* Icons thanks to http://www.famfamfam.com/ licensed [Creative Commons Attribution 2.5 License]
[ChainPad]: https://github.com/xwiki-contrib/chainpad [ChainPad]: https://github.com/xwiki-contrib/chainpad
[CKEditor]: http://ckeditor.com/ [CKEditor]: http://ckeditor.com/
[fragment identifier]: https://en.wikipedia.org/wiki/Fragment_identifier [fragment identifier]: https://en.wikipedia.org/wiki/Fragment_identifier
[active attack]: https://en.wikipedia.org/wiki/Attack_(computing)#Types_of_attacks [active attack]: https://en.wikipedia.org/wiki/Attack_(computing)#Types_of_attacks
[Creative Commons Attribution 2.5 License]: http://creativecommons.org/licenses/by/2.5/ [Creative Commons Attribution 2.5 License]: http://creativecommons.org/licenses/by/2.5/