cryptpad_ynh/README.md

CryptPad for YunoHost

Lire ce readme en français.

This package allows you to install CryptPad quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

CryptPad is a Zero Knowledge realtime collaborative editor. You can share access to a document simply by sharing the link.

Shipped version: 3.18.1

Screenshots

Demo

• Official demo

Configuration

• How to configure this app: From an admin panel, a plain file with SSH.

Documentation

• Official documentation: https://cryptpad.fr/what-is-cryptpad.html
• YunoHost documentation: If specific documentation is needed, feel free to contribute.

YunoHost specific features

Multi-user support

• Are LDAP and HTTP auth supported? No
• Can the app be used by multiple users? Yes

Supported architectures

• x86-64 -
• ARMv8-A -

Limitations

• Installation possible only on a root domain (CryptPad limitation)
• Can't login via SSO (due to this Cryptpad limitation)

Additional information

• To increase space for CryptPad users, you can modify /var/www/cryptpad/config.js, and restart the CryptPad service with sudo service cryptpad restart.

Links

• Report a bug: https://github.com/YunoHost-Apps/cryptpad_ynh/issues
• App website: https://cryptpad.fr/
• Upstream app repository: https://github.com/xwiki-labs/cryptpad
• YunoHost website: https://yunohost.org/

---

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing --debug
or
sudo yunohost app upgrade cryptpad -u https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing --debug