Bläddra i källkod

Cryptpad documentation

Bob Mottram 7 år sedan
förälder
incheckning
c488eaee81
2 ändrade filer med 112 tillägg och 62 borttagningar
  1. 16
    0
      doc/EN/mesh.org
  2. 96
    62
      website/EN/mesh.html

+ 16
- 0
doc/EN/mesh.org Visa fil

@@ -54,6 +54,7 @@ The Freedombone mesh roughly follows MondoNet's ten social specifications:
54 54
  - Voice chat (VoIP) and video calls
55 55
  - Private and public sharing of files
56 56
  - Blogging
57
+ - Collaborative editing of documents and presentations
57 58
  - Creating and broadcasting audio media/podcasts
58 59
  - Social network stream. Follow/unfollow other peers
59 60
  - No network administration required
@@ -303,6 +304,21 @@ One important point is that by default the microphone is turned off. When doing
303 304
 
304 305
 At present video doesn't work reliably, but text and voice chat do work well.
305 306
 
307
+** Collaborative document editing
308
+The mesh system includes the ability to collaboratively edit various sorts of documents using CryptPad. CryptPad is an almost peer-to-peer system in that it is designed for a client/server environment but that the server aspect of it is very minimal and limited to orchestrating the connected clients. With CryptPad installed on each mesh peer it effectively enables peer-to-peer collaborative editing. Documents are ephemeral and forgotten unless they're exported or copy-pasted to permanent storage.
309
+
310
+#+BEGIN_CENTER
311
+[[file:images/mesh_cryptpad1.jpg]]
312
+#+END_CENTER
313
+
314
+To create a document click on the CryptPad icon. Depending upon the specifications of your system it may take a few seconds to load, so don't be too disturned if the browser contents look blank for a while. Select _Rich Text Pad_ and give yourself a username.
315
+
316
+#+BEGIN_CENTER
317
+[[file:images/mesh_cryptpad2.jpg]]
318
+#+END_CENTER
319
+
320
+If you have the chat system running you can then copy and paste the URL for your pad into the chat, and the other user can then open the link and edit the document with you. You can repeat that for however many other users you wish to be able to edit.
321
+
306 322
 ** Social Network
307 323
 
308 324
 Patchwork is available as a social networking system for the mesh. Like all social network systems it has a stream of posts and you can follow or unfollow other users. You can also send private messages to other users with end-to-end encryption.

+ 96
- 62
website/EN/mesh.html Visa fil

@@ -3,7 +3,7 @@
3 3
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4 4
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
5 5
 <head>
6
-<!-- 2017-10-07 Sat 10:19 -->
6
+<!-- 2017-10-25 Wed 18:02 -->
7 7
 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
8 8
 <meta name="viewport" content="width=device-width, initial-scale=1" />
9 9
 <title>&lrm;</title>
@@ -274,13 +274,13 @@ for the JavaScript code in this tag.
274 274
 </colgroup>
275 275
 <tbody>
276 276
 <tr>
277
-<td class="org-left"><a href="#org459477a">What the system can do</a></td>
277
+<td class="org-left"><a href="#org29476fd">What the system can do</a></td>
278 278
 <td class="org-left">-</td>
279
-<td class="org-left"><a href="#org0164602">Disk Images</a></td>
279
+<td class="org-left"><a href="#orga4afa2f">Disk Images</a></td>
280 280
 <td class="org-left">-</td>
281
-<td class="org-left"><a href="#orgac711fb">Building Disk Images</a></td>
281
+<td class="org-left"><a href="#orgebc686d">Building Disk Images</a></td>
282 282
 <td class="org-left">-</td>
283
-<td class="org-left"><a href="#orgb7403cc">How to use it</a></td>
283
+<td class="org-left"><a href="#orgfde1e8f">How to use it</a></td>
284 284
 </tr>
285 285
 </tbody>
286 286
 </table>
@@ -324,15 +324,16 @@ The Freedombone mesh roughly follows MondoNet's ten social specifications:
324 324
 <li><b>Evolvable</b>: The network should be built with future development in mind. The platform should be flexible enough to support technologies, protocols and modes of usage that have not yet been developed.</li>
325 325
 </ul>
326 326
 
327
-<div id="outline-container-org459477a" class="outline-2">
328
-<h2 id="org459477a">What the system can do</h2>
329
-<div class="outline-text-2" id="text-org459477a">
327
+<div id="outline-container-org29476fd" class="outline-2">
328
+<h2 id="org29476fd">What the system can do</h2>
329
+<div class="outline-text-2" id="text-org29476fd">
330 330
 <ul class="org-ul">
331 331
 <li>Discovery of other users on the network</li>
332 332
 <li>Text based chat, one-to-one and in groups</li>
333 333
 <li>Voice chat (VoIP) and video calls</li>
334 334
 <li>Private and public sharing of files</li>
335 335
 <li>Blogging</li>
336
+<li>Collaborative editing of documents and presentations</li>
336 337
 <li>Creating and broadcasting audio media/podcasts</li>
337 338
 <li>Social network stream. Follow/unfollow other peers</li>
338 339
 <li>No network administration required</li>
@@ -350,13 +351,13 @@ This system should be quite scalable. Both qTox and IPFS are based upon distribu
350 351
 </div>
351 352
 </div>
352 353
 
353
-<div id="outline-container-org0164602" class="outline-2">
354
-<h2 id="org0164602">Disk Images</h2>
355
-<div class="outline-text-2" id="text-org0164602">
354
+<div id="outline-container-orga4afa2f" class="outline-2">
355
+<h2 id="orga4afa2f">Disk Images</h2>
356
+<div class="outline-text-2" id="text-orga4afa2f">
356 357
 </div>
357
-<div id="outline-container-orge7a4bb5" class="outline-3">
358
-<h3 id="orge7a4bb5">Writing many images quickly</h3>
359
-<div class="outline-text-3" id="text-orge7a4bb5">
358
+<div id="outline-container-org1fb8ee1" class="outline-3">
359
+<h3 id="org1fb8ee1">Writing many images quickly</h3>
360
+<div class="outline-text-3" id="text-org1fb8ee1">
360 361
 <p>
361 362
 There may be situations where you need to write the same disk image to multiple drives at the same time in order to maximize rate of deployment. In the instructions given below the <b>dd</b> command is used for writing to the target drive, but to write to multiple drives you can use a tool such as <a href="https://wiki.gnome.org/Apps/MultiWriter">GNOME MultiWriter</a>.
362 363
 </p>
@@ -384,9 +385,9 @@ The MultiWriter tool is also available within mesh client images, so that you ca
384 385
 </p>
385 386
 </div>
386 387
 </div>
387
-<div id="outline-container-org937e4d8" class="outline-3">
388
-<h3 id="org937e4d8">Client images</h3>
389
-<div class="outline-text-3" id="text-org937e4d8">
388
+<div id="outline-container-org311eb93" class="outline-3">
389
+<h3 id="org311eb93">Client images</h3>
390
+<div class="outline-text-3" id="text-org311eb93">
390 391
 <div class="org-center">
391 392
 
392 393
 <div class="figure">
@@ -435,16 +436,16 @@ sudo dd <span class="org-variable-name">bs</span>=1M <span class="org-variable-n
435 436
 </div>
436 437
 </div>
437 438
 
438
-<div id="outline-container-org4b4e016" class="outline-3">
439
-<h3 id="org4b4e016">Router images</h3>
440
-<div class="outline-text-3" id="text-org4b4e016">
439
+<div id="outline-container-org716b822" class="outline-3">
440
+<h3 id="org716b822">Router images</h3>
441
+<div class="outline-text-3" id="text-org716b822">
441 442
 <p>
442 443
 Routers are intended to build network coverage for an area using small and low cost hardware. You can bolt them to walls or leave them on window ledges. They don't have any user interface and their only job is to haul network traffic across the mesh and to enable peers to find each other via running bootstrap nodes for Tox and IPFS. Copy the image to a microSD card and insert it into the router, plug in an Atheros wifi dongle and power on. That should be all you need to do.
443 444
 </p>
444 445
 </div>
445
-<div id="outline-container-org139719d" class="outline-4">
446
-<h4 id="org139719d">Beaglebone Black</h4>
447
-<div class="outline-text-4" id="text-org139719d">
446
+<div id="outline-container-org9739d76" class="outline-4">
447
+<h4 id="org9739d76">Beaglebone Black</h4>
448
+<div class="outline-text-4" id="text-org9739d76">
448 449
 <div class="org-center">
449 450
 
450 451
 <div class="figure">
@@ -481,9 +482,9 @@ There is still a software freedom issue with the Beaglebone Black, but it doesn'
481 482
 </div>
482 483
 </div>
483 484
 
484
-<div id="outline-container-orgac711fb" class="outline-2">
485
-<h2 id="orgac711fb">Building Disk Images</h2>
486
-<div class="outline-text-2" id="text-orgac711fb">
485
+<div id="outline-container-orgebc686d" class="outline-2">
486
+<h2 id="orgebc686d">Building Disk Images</h2>
487
+<div class="outline-text-2" id="text-orgebc686d">
487 488
 <p>
488 489
 It's better not to trust images downloaded from random places on the interwebs. Chances are that unless you are in the web of trust of the above GPG signatures then they don't mean very much to you. If you actually want something trustworthy then build the images from scratch. It will take some time. Here's how to do it.
489 490
 </p>
@@ -571,9 +572,9 @@ The resulting image can be copied to a microSD card, inserted into a Beaglebone
571 572
 </div>
572 573
 </div>
573 574
 
574
-<div id="outline-container-org9625de2" class="outline-2">
575
-<h2 id="org9625de2">Customisation</h2>
576
-<div class="outline-text-2" id="text-org9625de2">
575
+<div id="outline-container-org62b6db3" class="outline-2">
576
+<h2 id="org62b6db3">Customisation</h2>
577
+<div class="outline-text-2" id="text-org62b6db3">
577 578
 <p>
578 579
 If you want to make your own specially branded version, such as for a particular event, then to change the default desktop backgrounds edit the images within <b>img/backgrounds</b> and to change the available avatars and desktop icons edit the images within <b>img/avatars</b>. Re-create disk images using the instructions shown previously.
579 580
 </p>
@@ -583,9 +584,9 @@ If you need particular <i>dconf</i> commands to alter desktop appearance or beha
583 584
 </p>
584 585
 </div>
585 586
 </div>
586
-<div id="outline-container-orgb7403cc" class="outline-2">
587
-<h2 id="orgb7403cc">How to use it</h2>
588
-<div class="outline-text-2" id="text-orgb7403cc">
587
+<div id="outline-container-orgfde1e8f" class="outline-2">
588
+<h2 id="orgfde1e8f">How to use it</h2>
589
+<div class="outline-text-2" id="text-orgfde1e8f">
589 590
 <p>
590 591
 When you first boot from the USB drive the system will create some encryption keys, assign a unique network address to the system and then reboot itself. When that's done you should see a prompt asking for a username. This username just makes it easy for others to initially find you on the mesh and will appear in the list of users.
591 592
 </p>
@@ -595,9 +596,9 @@ After a minute or two if you are within wifi range and there is at least one oth
595 596
 </p>
596 597
 </div>
597 598
 
598
-<div id="outline-container-org70dd907" class="outline-3">
599
-<h3 id="org70dd907">Boot trouble</h3>
600
-<div class="outline-text-3" id="text-org70dd907">
599
+<div id="outline-container-orgbf32895" class="outline-3">
600
+<h3 id="orgbf32895">Boot trouble</h3>
601
+<div class="outline-text-3" id="text-orgbf32895">
601 602
 <p>
602 603
 If the system doesn't boot and reports an error which includes <b>/dev/mapper/loop0p1</b> then reboot with <b>Ctrl-Alt-Del</b> and when you see the grub menu press <b>e</b> and manually change <b>/dev/mapper/loop0p1</b> to <b>/dev/sdb1</b>, then press <b>Ctrl-x</b>. If that doesn't work then reboot and try <b>/dev/sdc1</b> instead.
603 604
 </p>
@@ -607,9 +608,9 @@ After the system has booted successfully the problem should resolve itself on su
607 608
 </p>
608 609
 </div>
609 610
 </div>
610
-<div id="outline-container-orge861d36" class="outline-3">
611
-<h3 id="orge861d36">Set the Date</h3>
612
-<div class="outline-text-3" id="text-orge861d36">
611
+<div id="outline-container-org7608b0d" class="outline-3">
612
+<h3 id="org7608b0d">Set the Date</h3>
613
+<div class="outline-text-3" id="text-org7608b0d">
613 614
 <p>
614 615
 On the ordinary internet the date and time of your system would be set automatically via NTP. But this is not the internet and so you will need to manually ensure that your date and time settings are correct. You might need to periodically do this if your clock drifts. It's not essential that the time on your system be highly accurate, but if it drifts too far or goes back to epoch then things could become a little confusing in regard to the order of blog posts.
615 616
 </p>
@@ -619,9 +620,9 @@ On the ordinary internet the date and time of your system would be set automatic
619 620
 </p>
620 621
 </div>
621 622
 </div>
622
-<div id="outline-container-org15c35d8" class="outline-3">
623
-<h3 id="org15c35d8">Check network status</h3>
624
-<div class="outline-text-3" id="text-org15c35d8">
623
+<div id="outline-container-org55bf854" class="outline-3">
624
+<h3 id="org55bf854">Check network status</h3>
625
+<div class="outline-text-3" id="text-org55bf854">
625 626
 <p>
626 627
 Unlike with ordinary wifi, on the mesh you don't get a signal strength icon and so it's not simple to see if you have a good connection.
627 628
 </p>
@@ -644,9 +645,9 @@ When you are finished close the window and then select the <i>Network Restart</i
644 645
 </p>
645 646
 </div>
646 647
 </div>
647
-<div id="outline-container-org1a60165" class="outline-3">
648
-<h3 id="org1a60165">Connecting to the internet</h3>
649
-<div class="outline-text-3" id="text-org1a60165">
648
+<div id="outline-container-orgea3ec04" class="outline-3">
649
+<h3 id="orgea3ec04">Connecting to the internet</h3>
650
+<div class="outline-text-3" id="text-orgea3ec04">
650 651
 <p>
651 652
 If you need to be able to access the internet from the mesh then connect one of the peers to an internet router using an ethernet cable, then reboot it. Other peers in the mesh, including any attached mobile devices, will then be able to access the internet using the ethernet attached peer as a gateway. <a href="https://en.wikipedia.org/wiki/Freifunk">Freifunk</a> works in a similar way.
652 653
 </p>
@@ -669,9 +670,9 @@ Where <i>myclient.ovpn</i> comes from your VPN provider and with the password "<
669 670
 </p>
670 671
 </div>
671 672
 </div>
672
-<div id="outline-container-orgc23a852" class="outline-3">
673
-<h3 id="orgc23a852">Connecting two meshes over the internet via a VPN tunnel</h3>
674
-<div class="outline-text-3" id="text-orgc23a852">
673
+<div id="outline-container-org9328f03" class="outline-3">
674
+<h3 id="org9328f03">Connecting two meshes over the internet via a VPN tunnel</h3>
675
+<div class="outline-text-3" id="text-org9328f03">
675 676
 <p>
676 677
 Maybe the internet exists, but you don't care about getting any content from it and just want to use it as a way to connect mesh networks from different geographical locations together. VPN configuration, pem and stunnel files exist within the home directory. Edit the configuration with:
677 678
 </p>
@@ -707,9 +708,9 @@ Using the password "<i>freedombone</i>". From a deep packet inspection point of
707 708
 </div>
708 709
 </div>
709 710
 
710
-<div id="outline-container-orgfb80d50" class="outline-3">
711
-<h3 id="orgfb80d50">Mobile devices (phones, etc)</h3>
712
-<div class="outline-text-3" id="text-orgfb80d50">
711
+<div id="outline-container-org000aae6" class="outline-3">
712
+<h3 id="org000aae6">Mobile devices (phones, etc)</h3>
713
+<div class="outline-text-3" id="text-org000aae6">
713 714
 <p>
714 715
 To allow mobile devices to connect to the mesh you will need a second wifi adapter connected to your laptop/netbook/SBC. Plug in a second wifi adapter then reboot the system. The second adaptor will then create a wifi hotspot which mobile devices can connect to. The hotspot name also contains its local IP address (eg. "<i>mesh-192.168.1.83</i>").
715 716
 </p>
@@ -731,9 +732,9 @@ On some android devices you may need to move the downloaded APK file from the <b
731 732
 </p>
732 733
 </div>
733 734
 </div>
734
-<div id="outline-container-org8cef3f4" class="outline-3">
735
-<h3 id="org8cef3f4">Chat System</h3>
736
-<div class="outline-text-3" id="text-org8cef3f4">
735
+<div id="outline-container-orgb234fc6" class="outline-3">
736
+<h3 id="orgb234fc6">Chat System</h3>
737
+<div class="outline-text-3" id="text-orgb234fc6">
737 738
 <p>
738 739
 Ensure that you're within wifi range of at least one other mesh peer (could be a router or client) and then you should see that the <i>Chat</i> and <i>Other Users</i> icons appear. Select the users icon and you should see a list of users on the mesh. Select the <i>Chat</i> icon and once you are connected you should see the status light turn green. If after a few minutes you don't get the green status light then try closing and re-opening the Tox chat application. Select the plus button to add a friend and then copy and paste in a Tox ID from the users list.
739 740
 </p>
@@ -792,9 +793,42 @@ At present video doesn't work reliably, but text and voice chat do work well.
792 793
 </div>
793 794
 </div>
794 795
 
795
-<div id="outline-container-org1bfb325" class="outline-3">
796
-<h3 id="org1bfb325">Social Network</h3>
797
-<div class="outline-text-3" id="text-org1bfb325">
796
+<div id="outline-container-org732a371" class="outline-3">
797
+<h3 id="org732a371">Collaborative document editing</h3>
798
+<div class="outline-text-3" id="text-org732a371">
799
+<p>
800
+The mesh system includes the ability to collaboratively edit various sorts of documents using CryptPad. CryptPad is an almost peer-to-peer system in that it is designed for a client/server environment but that the server aspect of it is very minimal and limited to orchestrating the connected clients. With CryptPad installed on each mesh peer it effectively enables peer-to-peer collaborative editing. Documents are ephemeral and forgotten unless they're exported or copy-pasted to permanent storage.
801
+</p>
802
+
803
+<div class="org-center">
804
+
805
+<div class="figure">
806
+<p><img src="images/mesh_cryptpad1.jpg" alt="mesh_cryptpad1.jpg" />
807
+</p>
808
+</div>
809
+</div>
810
+
811
+<p>
812
+To create a document click on the CryptPad icon. Depending upon the specifications of your system it may take a few seconds to load, so don't be too disturned if the browser contents look blank for a while. Select <span class="underline">Rich Text Pad</span> and give yourself a username.
813
+</p>
814
+
815
+<div class="org-center">
816
+
817
+<div class="figure">
818
+<p><img src="images/mesh_cryptpad2.jpg" alt="mesh_cryptpad2.jpg" />
819
+</p>
820
+</div>
821
+</div>
822
+
823
+<p>
824
+If you have the chat system running you can then copy and paste the URL for your pad into the chat, and the other user can then open the link and edit the document with you. You can repeat that for however many other users you wish to be able to edit.
825
+</p>
826
+</div>
827
+</div>
828
+
829
+<div id="outline-container-org5d227c5" class="outline-3">
830
+<h3 id="org5d227c5">Social Network</h3>
831
+<div class="outline-text-3" id="text-org5d227c5">
798 832
 <p>
799 833
 Patchwork is available as a social networking system for the mesh. Like all social network systems it has a stream of posts and you can follow or unfollow other users. You can also send private messages to other users with end-to-end encryption.
800 834
 </p>
@@ -829,9 +863,9 @@ The Secure Scuttlebutt protocol which Patchwork is based upon is intended to be
829 863
 </div>
830 864
 </div>
831 865
 
832
-<div id="outline-container-org2d4c2ef" class="outline-3">
833
-<h3 id="org2d4c2ef">Sharing Files</h3>
834
-<div class="outline-text-3" id="text-org2d4c2ef">
866
+<div id="outline-container-orgf471f2b" class="outline-3">
867
+<h3 id="orgf471f2b">Sharing Files</h3>
868
+<div class="outline-text-3" id="text-orgf471f2b">
835 869
 <p>
836 870
 You can make files publicly available on the network simply by dragging and dropping them into the <i>Public</i> folder on the desktop. To view the files belonging to another user select the desktop icon called <i>Visit a site</i> and enter the username or Tox ID of the other user.
837 871
 </p>
@@ -846,9 +880,9 @@ You can make files publicly available on the network simply by dragging and drop
846 880
 </div>
847 881
 </div>
848 882
 
849
-<div id="outline-container-org47a1d04" class="outline-3">
850
-<h3 id="org47a1d04">Blogging</h3>
851
-<div class="outline-text-3" id="text-org47a1d04">
883
+<div id="outline-container-org15f5eea" class="outline-3">
884
+<h3 id="org15f5eea">Blogging</h3>
885
+<div class="outline-text-3" id="text-org15f5eea">
852 886
 <p>
853 887
 To create a blog post select the <i>Blog</i> icon on the desktop and then use the up and down cursor keys, space bar and enter key to add a new entry. Edit the title of the entry and add your text. You can also include photos if you wish - just copy them to the <b>CreateBlog/content/images</b> directory and then link to them as shown.
854 888
 </p>