mirror of https://github.com/YunoHost-Apps/cryptpad_ynh.git synced 2024-09-03 18:26:14 +02:00

CryptPad package for YunoHost

Find a file

DDATAA fea5f79683 Update scripts/upgrade Co-authored-by: Alexandre Aubin <alex.aubin@mailoo.org>		2023-03-04 19:57:24 +00:00
.github	[autopatch] Upgrade auto-updater	2023-02-23 23:37:36 +01:00
conf	Update nginx.conf	2023-02-15 21:49:39 +01:00
doc	Update DISCLAIMER_fr.md	2023-03-03 14:14:20 +00:00
scripts	Update scripts/upgrade	2023-03-04 19:57:24 +00:00
check_process	Use sandbox domain and upgrade to v5.1.0	2022-12-09 18:01:27 +01:00
LICENSE	Change to a compatible license	2018-03-11 15:26:19 +01:00
manifest.json	Update manifest.json	2023-03-03 23:08:21 +00:00
README.md	Auto-update README	2023-03-03 23:08:24 +00:00
README_fr.md	Auto-update README	2023-03-03 23:08:24 +00:00

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 collaboration suite that is end-to-end-encrypted and open-source. It is built to enable collaboration, synchronizing changes to documents in real time. Because all data is encrypted, the service and its administrators have no way of seeing the content being edited and stored.

Shipped version: 5.2.1~ynh6

Demo: https://cryptpad.fr/

Screenshots

Disclaimers / important information

Configuration

We have added the mandatory sandbox domain for you but you still need to configure your DNS and generate Let's Encrypt Certificates for it !!

Once CryptPad is installed, create an account via the Register button on the home page. To make this account an instance administrator:

Copy the public key found in User Menu (avatar at the top right) > Settings > Account > Public Signing Key
Paste this key in /var/www/cryptpad/config/config.js in the following array (uncomment and replace the placeholder):

adminKeys: [
        "[cryptpad-user1@my.awesome.website/YZgXQxKR0Rcb6r6CmxHPdAGLVludrAF2lEnkbx1vVOo=]",
],

Restart CryptPad service (In YunoHost webadmin -> Services -> cryptpad -> Restart)

Documentation and resources

Official app website: https://cryptpad.fr/
Official admin documentation: https://docs.cryptpad.fr/en/
Upstream app code repository: https://github.com/xwiki-labs/cryptpad
YunoHost documentation for this app: https://yunohost.org/app_cryptpad
Report a bug: https://github.com/YunoHost-Apps/cryptpad_ynh/issues

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

More info regarding app packaging: https://yunohost.org/packaging_apps