YunoHost-Apps/cryptpad_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/cryptpad_ynh.git synced 2024-09-03 18:26:14 +02:00
Code Issues Activity Actions

Auto-update README

Browse source
This commit is contained in:
Yunohost-Bot 2021-06-16 10:32:01 +00:00 committed by Yunohost-Bot
parent 332671a558
commit b5a55ab82f
2 changed files with 75 additions and 115 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

126
README.md
View file

@ -1,72 +1,54 @@
# CryptPad for YunoHost
[![Integration level](https://dash.yunohost.org/integration/cryptpad.svg)](https://dash.yunohost.org/appci/app/cryptpad) ![](https://ci-apps.yunohost.org/ci/badges/cryptpad.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/cryptpad.maintain.svg)
[![Install CryptPad with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=cryptpad)
*[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install CryptPad quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*
## Overview
CryptPad is a collaborative encrypted document editor in real time. It is a privacy-friendly alternative to popular office tools and cloud services. All content stored in CryptPad is encrypted before being sent, which means that no one can access your data unless you give them the keys. You can share access to a document simply by sharing the link.
**Shipped version:** 4.6.0
## Screenshots
![](https://github.com/xwiki-labs/cryptpad/raw/main/screenshot.png)
## Demo
* [Official demo](https://cryptpad.fr/)
## Configuration
* How to configure this app: From the admin panel and the plain file `/var/www/cryptpad/config/config.js.`
## Documentation
* Official documentation: https://docs.cryptpad.fr/en/
* 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 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/cryptpad.svg)](https://ci-apps.yunohost.org/ci/apps/cryptpad/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/cryptpad.svg)](https://ci-apps-arm.yunohost.org/ci/apps/cryptpad/)
## Limitations
* Installation possible only on a root domain (CryptPad limitation)
* Can't login via SSO (due to this [CryptPad limitation](https://github.com/xwiki-labs/cryptpad/issues/116))
## Additional information
* To increase space for CryptPad users, you can modify `/var/www/cryptpad/config/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](https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing).
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
```
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
# CryptPad for YunoHost
[![Integration level](https://dash.yunohost.org/integration/cryptpad.svg)](https://dash.yunohost.org/appci/app/cryptpad) ![](https://ci-apps.yunohost.org/ci/badges/cryptpad.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/cryptpad.maintain.svg)
[![Install CryptPad with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=cryptpad)
*[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install CryptPad quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
Zero Knowledge realtime collaborative editor
**Shipped version:** 4.7.0~ynh1
**Demo:** https://cryptpad.fr/
## Screenshots
![](./doc/screenshots/screenshot.png)
## Disclaimers / important information
## Configuration
* How to configure this app: From the admin panel and the plain file `/var/www/cryptpad/config/config.js.`
## Documentation and resources
* Official app website: https://cryptpad.fr/
* Official user documentation: https://yunohost.org/apps
* 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](https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing).
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

64
README_fr.md
View file

@ -1,64 +1,40 @@
# CryptPad pour YunoHost
[![Integration level](https://dash.yunohost.org/integration/cryptpad.svg)](https://dash.yunohost.org/appci/app/cryptpad) ![](https://ci-apps.yunohost.org/ci/badges/cryptpad.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/cryptpad.maintain.svg)
[![Niveau d'intégration](https://dash.yunohost.org/integration/cryptpad.svg)](https://dash.yunohost.org/appci/app/cryptpad) ![](https://ci-apps.yunohost.org/ci/badges/cryptpad.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/cryptpad.maintain.svg)
[![Installer CryptPad avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=cryptpad)
*[Read this readme in english.](./README.md)*
*[Read this readme in english.](./README.md)*
*[Lire ce readme en français.](./README_fr.md)*
> *Ce package vous permet d'installer CryptPad rapidement et simplement sur un serveur YunoHost.
Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/install) pour apprendre comment l'installer.*
> *Ce package vous permet d'installer CryptPad rapidement et simplement sur un serveur YunoHost.
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
## Vue d'ensemble
CryptPad est un éditeur de documents chiffrés collaboratifs en temps réel. C'est une alternative respectant la vie privée aux outils office et aux services cloud populaires. Tout le contenu stocké dans CryptPad est chiffré avant d'être envoyé, ce qui signifie que personne ne peut accéder à vos données à moins que vous ne leur donniez les clés. Vous pouvez partager l'accès à un document simplement en partageant le lien.
**Version incluse :** 4.6.0
Éditeur chiffré collaboratif en temps réel.
**Version incluse :** 4.7.0~ynh1
**Démo :** https://cryptpad.fr/
## Captures d'écran
![](https://github.com/xwiki-labs/cryptpad/raw/main/screenshot.png)
![](./doc/screenshots/screenshot.png)
## Démo
* [Démo officielle](https://cryptpad.fr/)
## Avertissements / informations importantes
## Configuration
Comment configurer cette application : via le panneau d'administration ainsi que le fichier de configuration `/var/www/cryptpad/config/config.js`.
## Documentation
## Documentations et ressources
* Official documentation : https://docs.cryptpad.fr/fr/
* YunoHost documentation : If specific documentation is needed, feel free to contribute.
## Caractéristiques spécifiques YunoHost
#### Support multi-utilisateur
* L'authentification LDAP et HTTP est-elle prise en charge ? **Non**
* L'application peut-elle être utilisée par plusieurs utilisateurs ? **Oui**
#### Architectures supportées
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/cryptpad.svg)](https://ci-apps.yunohost.org/ci/apps/cryptpad/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/cryptpad.svg)](https://ci-apps-arm.yunohost.org/ci/apps/cryptpad/)
## Limitations
* Nécessite un sous-domaine / domaine dédié. (limitation de CryptPad)
* Impossible de se connecter via SSO (cf [limitation de CryptPad](https://github.com/xwiki-labs/cryptpad/issues/116))
## Informations additionnelles
* Pour augmenter l'espace pour l'utilisateur dans le CryptPad, vous pouvez configurer le fichier `config.js` dans le dossier `/var/www/cryptpad/config/config.js`, puis redémarrez le service CryptPad `sudo service cryptpad restart`.
## Liens
* Signaler un bug : https://github.com/YunoHost-Apps/cryptpad_ynh/issues
* Site de l'application : https://cryptpad.fr/
* Dépôt de l'application principale : https://github.com/xwiki-labs/cryptpad
* Site web YunoHost : https://yunohost.org/
---
* Site officiel de l'app : https://cryptpad.fr/
* Documentation officielle utilisateur : https://yunohost.org/apps
* Documentation officielle de l'admin : https://docs.cryptpad.fr/en/
* Dépôt de code officiel de l'app : https://github.com/xwiki-labs/cryptpad
* Documentation YunoHost pour cette app : https://yunohost.org/app_cryptpad
* Signaler un bug : https://github.com/YunoHost-Apps/cryptpad_ynh/issues
## Informations pour les développeurs
@ -70,3 +46,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/cryptpad_ynh/tree/tes
ou
sudo yunohost app upgrade cryptpad -u https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing --debug
```
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps