Skip to content

Commit ebf4bb1

Browse files
committed
draft: [DOC] DAT Cryptpad
1 parent 9df01a7 commit ebf4bb1

1 file changed

Lines changed: 39 additions & 13 deletions

File tree

docs/hosting/deployment/editics/index.rst

Lines changed: 39 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,30 +5,56 @@
55
|english-only|
66

77
===================
8-
Cryptpad Deployment
8+
Cryptpad deployment
99
===================
1010

11-
Cryptpad deployment allows to edit documents directly in the application.
1211

13-
It's incredibly useful on :ref:`web <doc_hosting_deployment_webapp>` since users won't have access to the file system mountpoints provided by the desktop application.
12+
Overview
13+
========
14+
15+
Parsec supports an integrated file editor through :ref:`Cryptpad <https://cryptpad.fr/>`, allowing document edition directly in the application.
16+
17+
It's very useful on :ref:`web <doc_hosting_deployment_webapp>` since users won't have access to the file system mountpoints provided by the desktop application.
18+
19+
See `this section of our documentation <https://docs.parsec.cloud/en/latest/userguide/manage-files.html#file-editing-in-parsec>` for more information on its in-app usage.
20+
21+
Security
22+
========
23+
24+
Architecture
25+
============
26+
27+
.. mermaid::
28+
29+
flowchart TD
30+
cryptpad[Cryptpad Server]
31+
client[Parsec Client]
32+
server[Parsec Server]
33+
editor[Embedded file editor]
34+
client --(1) Connection ---> server
35+
server --(2) Connection ---> cryptpad
36+
cryptpad --(3) Enables file edition if correctly set up ---> editor
37+
38+
Deployment
39+
==========
1440

1541
Obtaining the patched server
16-
============================
42+
----------------------------
1743

1844
.. _cryptpad-repo: https://github.com/Scille/cryptpad
1945

20-
Parsec maintain a `soft-fork of cryptpad <cryptpad-repo_>`_ source as it requires some light modifications to better integrate in parsec.
46+
Parsec maintains a `soft-fork of cryptpad <cryptpad-repo_>`_ source as it requires some light modifications to better integrate in parsec.
2147

2248
.. _cryptpad-server-repo: https://github.com/Scille/cryptpad-server
2349
.. _cryptpad-docker: https://github.com/Scille/cryptpad-server/pkgs/container/cryptpad-server%2Fcryptpad
2450
.. _cryptpad-server-static-build: https://github.com/Scille/cryptpad-server/releases/download/v0.3/cryptpad-server.zip
2551

26-
We have a repository used to `build the cryptpad server <cryptpad-server-repo_>`_ either as a `linux container <cryptpad-docker_>`_ format or `the resources needed for a nodejs server <cryptpad-server-static-build_>`_.
52+
We have a repository used to `build the cryptpad server <cryptpad-server-repo_>`_, either as a `linux container <cryptpad-docker_>`_ format or as a `.zip containing the resources needed for a nodejs server <cryptpad-server-static-build_>`_.
2753

2854
Deploying using the docker testing infra
29-
========================================
55+
----------------------------------------
3056

31-
To deploy cryptpad using :ref:`the docker-compose stack <doc_hosting_deployment_with_docker>`, we will need to patch some configuration:
57+
To deploy cryptpad usingo :ref:`the docker-compose stack <doc_hosting_deployment_with_docker>`, we will need to patch some configuration:
3258

3359
#. We will deploy alongside the parsec server our patched cryptpad server.
3460

@@ -118,19 +144,19 @@ If you have an already running stack, you need to:
118144
docker compose --file ./parsec-server.docker.yaml up --detach parsec-server
119145
120146
Other deployment methods
121-
========================
147+
------------------------
122148

123149
.. _Cryptpad server README: https://github.com/Scille/cryptpad-server
124150

125-
For other deployment methods refer to https://github.com/Scille/cryptpad-server/blob/master/README.md
151+
For other deployment methods please refer to https://github.com/Scille/cryptpad-server/blob/master/README.md
126152

127-
Further more you need some specific configure of both :ref:`Parsec <parsec-specific-config>` and :ref:`Cryptpad <cryptpad-specific-config>`.
153+
Furthermore you need some specific configuration of both :ref:`Parsec <parsec-specific-config>` and :ref:`Cryptpad <cryptpad-specific-config>`.
128154

129155
Verify the deployment
130-
=====================
156+
---------------------
131157

132158
Before trying to use CryptPad in parsec, open the server URL (https://cryptpad.parsec.localhost) in the browser, you should get the following page:
133159

134160
.. image:: ./404-welcome-cryptpad.png
135161

136-
If you have the following, it means the Cryptpad server is somewhat working, to confirm how can now try to use it in Parsec.
162+
If you have the following, it means the Cryptpad server is somewhat working, to confirm it you can now try to use it in Parsec.

0 commit comments

Comments
 (0)