瀏覽代碼

Patchwork documentation

Bob Mottram 7 年之前
父節點
當前提交
46790f951b
共有 4 個文件被更改,包括 105 次插入50 次删除
  1. 18
    0
      doc/EN/mesh.org
  2. 二進制
      img/patchwork_public.jpg
  3. 二進制
      img/patchwork_setup.jpg
  4. 87
    50
      website/EN/mesh.html

+ 18
- 0
doc/EN/mesh.org 查看文件

233
 
233
 
234
 At present video doesn't work reliably, but text and voice chat do work well.
234
 At present video doesn't work reliably, but text and voice chat do work well.
235
 
235
 
236
+** Social Network
237
+
238
+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.
239
+
240
+Double click on the "Social" icon to open the app, then add your nickname and optionally a description. If you want to choose an avatar image some can be found within the directory */usr/share/freedombone/avatars*.
241
+
242
+#+BEGIN_CENTER
243
+[[file:images/patchwork_setup.jpg]]
244
+#+END_CENTER
245
+
246
+Other Patchwork users on the mesh will appear automatically under the *local* list and you can select and follow them if you wish. It's also possible to select the dark theme from *settings* on the drop down menu if you prefer.
247
+
248
+#+BEGIN_CENTER
249
+[[file:images/patchwork_public.jpg]]
250
+#+END_CENTER
251
+
252
+The Secure Scuttlebutt protocol which Patchwork is based upon is intended to be robust to intermittent network connectivity, so you can write posts when out of range and they will sync once you are back in the network.
253
+
236
 ** Sharing Files
254
 ** Sharing Files
237
 You can make files publicly available on the network simply by dragging and dropping them into the /Public/ folder on the desktop. To view the files belonging to another user select the desktop icon called /Visit a site/ and enter the username or Tox ID of the other user.
255
 You can make files publicly available on the network simply by dragging and dropping them into the /Public/ folder on the desktop. To view the files belonging to another user select the desktop icon called /Visit a site/ and enter the username or Tox ID of the other user.
238
 
256
 

二進制
img/patchwork_public.jpg 查看文件


二進制
img/patchwork_setup.jpg 查看文件


+ 87
- 50
website/EN/mesh.html 查看文件

3
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
4
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
5
 <head>
5
 <head>
6
-<!-- 2017-09-15 Fri 22:19 -->
6
+<!-- 2017-09-17 Sun 21:04 -->
7
 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
7
 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
8
 <meta name="viewport" content="width=device-width, initial-scale=1" />
8
 <meta name="viewport" content="width=device-width, initial-scale=1" />
9
 <title></title>
9
 <title></title>
274
 </colgroup>
274
 </colgroup>
275
 <tbody>
275
 <tbody>
276
 <tr>
276
 <tr>
277
-<td class="org-left"><a href="#orgc6406cc">What the system can do</a></td>
277
+<td class="org-left"><a href="#org5b8ad9d">What the system can do</a></td>
278
 <td class="org-left">-</td>
278
 <td class="org-left">-</td>
279
-<td class="org-left"><a href="#orgf24c15c">Disk Images</a></td>
279
+<td class="org-left"><a href="#orgb0c31bc">Disk Images</a></td>
280
 <td class="org-left">-</td>
280
 <td class="org-left">-</td>
281
-<td class="org-left"><a href="#org08c02eb">Building Disk Images</a></td>
281
+<td class="org-left"><a href="#orgd14a53a">Building Disk Images</a></td>
282
 <td class="org-left">-</td>
282
 <td class="org-left">-</td>
283
-<td class="org-left"><a href="#orgfce6a77">How to use it</a></td>
283
+<td class="org-left"><a href="#orgc64234b">How to use it</a></td>
284
 </tr>
284
 </tr>
285
 </tbody>
285
 </tbody>
286
 </table>
286
 </table>
293
 Mesh networks are useful as a quick way to make a fully decentralised communications system which is not connected to or reliant upon the internet. Think festivals, hacker conferences, onboard ships at sea, disaster/war zones, small business internal office communications, protests, remote areas of the world, temporary "digital blackouts", scientific expeditions and off-world space colonies. The down side is that you can't access any internet content. The upside is that you can securely communicate with anyone on the local mesh. No ISPs. No payments or subscriptions beyond the cost of obtaining the hardware. Systems need to be within wifi range of each other for the mesh to be created. It can be an ultra-convenient way to do purely local communications.
293
 Mesh networks are useful as a quick way to make a fully decentralised communications system which is not connected to or reliant upon the internet. Think festivals, hacker conferences, onboard ships at sea, disaster/war zones, small business internal office communications, protests, remote areas of the world, temporary "digital blackouts", scientific expeditions and off-world space colonies. The down side is that you can't access any internet content. The upside is that you can securely communicate with anyone on the local mesh. No ISPs. No payments or subscriptions beyond the cost of obtaining the hardware. Systems need to be within wifi range of each other for the mesh to be created. It can be an ultra-convenient way to do purely local communications.
294
 </p>
294
 </p>
295
 
295
 
296
-<div id="outline-container-orgc6406cc" class="outline-2">
297
-<h2 id="orgc6406cc">What the system can do</h2>
298
-<div class="outline-text-2" id="text-orgc6406cc">
296
+<div id="outline-container-org5b8ad9d" class="outline-2">
297
+<h2 id="org5b8ad9d">What the system can do</h2>
298
+<div class="outline-text-2" id="text-org5b8ad9d">
299
 <ul class="org-ul">
299
 <ul class="org-ul">
300
 <li>Discovery of other users on the network</li>
300
 <li>Discovery of other users on the network</li>
301
 <li>Text based chat, one-to-one and in groups</li>
301
 <li>Text based chat, one-to-one and in groups</li>
316
 </div>
316
 </div>
317
 </div>
317
 </div>
318
 
318
 
319
-<div id="outline-container-orgf24c15c" class="outline-2">
320
-<h2 id="orgf24c15c">Disk Images</h2>
321
-<div class="outline-text-2" id="text-orgf24c15c">
319
+<div id="outline-container-orgb0c31bc" class="outline-2">
320
+<h2 id="orgb0c31bc">Disk Images</h2>
321
+<div class="outline-text-2" id="text-orgb0c31bc">
322
 </div>
322
 </div>
323
-<div id="outline-container-org88842fc" class="outline-3">
324
-<h3 id="org88842fc">Writing many images quickly</h3>
325
-<div class="outline-text-3" id="text-org88842fc">
323
+<div id="outline-container-orga0df2c1" class="outline-3">
324
+<h3 id="orga0df2c1">Writing many images quickly</h3>
325
+<div class="outline-text-3" id="text-orga0df2c1">
326
 <p>
326
 <p>
327
 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>.
327
 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>.
328
 </p>
328
 </p>
346
 </div>
346
 </div>
347
 </div>
347
 </div>
348
 </div>
348
 </div>
349
-<div id="outline-container-org4a8b638" class="outline-3">
350
-<h3 id="org4a8b638">Client images</h3>
351
-<div class="outline-text-3" id="text-org4a8b638">
349
+<div id="outline-container-org06fc865" class="outline-3">
350
+<h3 id="org06fc865">Client images</h3>
351
+<div class="outline-text-3" id="text-org06fc865">
352
 <div class="org-center">
352
 <div class="org-center">
353
 
353
 
354
 <div class="figure">
354
 <div class="figure">
397
 </div>
397
 </div>
398
 </div>
398
 </div>
399
 
399
 
400
-<div id="outline-container-org519744c" class="outline-3">
401
-<h3 id="org519744c">Router images</h3>
402
-<div class="outline-text-3" id="text-org519744c">
400
+<div id="outline-container-org7ab5db3" class="outline-3">
401
+<h3 id="org7ab5db3">Router images</h3>
402
+<div class="outline-text-3" id="text-org7ab5db3">
403
 <p>
403
 <p>
404
 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.
404
 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.
405
 </p>
405
 </p>
406
 </div>
406
 </div>
407
-<div id="outline-container-org909807a" class="outline-4">
408
-<h4 id="org909807a">Beaglebone Black</h4>
409
-<div class="outline-text-4" id="text-org909807a">
407
+<div id="outline-container-org7da3338" class="outline-4">
408
+<h4 id="org7da3338">Beaglebone Black</h4>
409
+<div class="outline-text-4" id="text-org7da3338">
410
 <div class="org-center">
410
 <div class="org-center">
411
 
411
 
412
 <div class="figure">
412
 <div class="figure">
443
 </div>
443
 </div>
444
 </div>
444
 </div>
445
 
445
 
446
-<div id="outline-container-org08c02eb" class="outline-2">
447
-<h2 id="org08c02eb">Building Disk Images</h2>
448
-<div class="outline-text-2" id="text-org08c02eb">
446
+<div id="outline-container-orgd14a53a" class="outline-2">
447
+<h2 id="orgd14a53a">Building Disk Images</h2>
448
+<div class="outline-text-2" id="text-orgd14a53a">
449
 <p>
449
 <p>
450
 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.
450
 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.
451
 </p>
451
 </p>
533
 </div>
533
 </div>
534
 </div>
534
 </div>
535
 
535
 
536
-<div id="outline-container-org0dec35a" class="outline-2">
537
-<h2 id="org0dec35a">Customisation</h2>
538
-<div class="outline-text-2" id="text-org0dec35a">
536
+<div id="outline-container-orga7f35d3" class="outline-2">
537
+<h2 id="orga7f35d3">Customisation</h2>
538
+<div class="outline-text-2" id="text-orga7f35d3">
539
 <p>
539
 <p>
540
 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.
540
 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.
541
 </p>
541
 </p>
545
 </p>
545
 </p>
546
 </div>
546
 </div>
547
 </div>
547
 </div>
548
-<div id="outline-container-orgfce6a77" class="outline-2">
549
-<h2 id="orgfce6a77">How to use it</h2>
550
-<div class="outline-text-2" id="text-orgfce6a77">
548
+<div id="outline-container-orgc64234b" class="outline-2">
549
+<h2 id="orgc64234b">How to use it</h2>
550
+<div class="outline-text-2" id="text-orgc64234b">
551
 <p>
551
 <p>
552
 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.
552
 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.
553
 </p>
553
 </p>
557
 </p>
557
 </p>
558
 </div>
558
 </div>
559
 
559
 
560
-<div id="outline-container-org2a6eb8c" class="outline-3">
561
-<h3 id="org2a6eb8c">Boot trouble</h3>
562
-<div class="outline-text-3" id="text-org2a6eb8c">
560
+<div id="outline-container-orgd1e0849" class="outline-3">
561
+<h3 id="orgd1e0849">Boot trouble</h3>
562
+<div class="outline-text-3" id="text-orgd1e0849">
563
 <p>
563
 <p>
564
 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.
564
 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.
565
 </p>
565
 </p>
569
 </p>
569
 </p>
570
 </div>
570
 </div>
571
 </div>
571
 </div>
572
-<div id="outline-container-org92cd6d5" class="outline-3">
573
-<h3 id="org92cd6d5">Set the Date</h3>
574
-<div class="outline-text-3" id="text-org92cd6d5">
572
+<div id="outline-container-org5bdaa4d" class="outline-3">
573
+<h3 id="org5bdaa4d">Set the Date</h3>
574
+<div class="outline-text-3" id="text-org5bdaa4d">
575
 <p>
575
 <p>
576
 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.
576
 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.
577
 </p>
577
 </p>
581
 </p>
581
 </p>
582
 </div>
582
 </div>
583
 </div>
583
 </div>
584
-<div id="outline-container-org2aa12f0" class="outline-3">
585
-<h3 id="org2aa12f0">Check network status</h3>
586
-<div class="outline-text-3" id="text-org2aa12f0">
584
+<div id="outline-container-org22eba27" class="outline-3">
585
+<h3 id="org22eba27">Check network status</h3>
586
+<div class="outline-text-3" id="text-org22eba27">
587
 <p>
587
 <p>
588
 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.
588
 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.
589
 </p>
589
 </p>
607
 </div>
607
 </div>
608
 </div>
608
 </div>
609
 
609
 
610
-<div id="outline-container-org2f1dfa6" class="outline-3">
611
-<h3 id="org2f1dfa6">Chat System</h3>
612
-<div class="outline-text-3" id="text-org2f1dfa6">
610
+<div id="outline-container-org96bd2e7" class="outline-3">
611
+<h3 id="org96bd2e7">Chat System</h3>
612
+<div class="outline-text-3" id="text-org96bd2e7">
613
 <p>
613
 <p>
614
 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.
614
 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.
615
 </p>
615
 </p>
668
 </div>
668
 </div>
669
 </div>
669
 </div>
670
 
670
 
671
-<div id="outline-container-org75993b2" class="outline-3">
672
-<h3 id="org75993b2">Sharing Files</h3>
673
-<div class="outline-text-3" id="text-org75993b2">
671
+<div id="outline-container-org7ad938e" class="outline-3">
672
+<h3 id="org7ad938e">Social Network</h3>
673
+<div class="outline-text-3" id="text-org7ad938e">
674
+<p>
675
+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.
676
+</p>
677
+
678
+<p>
679
+Double click on the "Social" icon to open the app, then add your nickname and optionally a description. If you want to choose an avatar image some can be found within the directory <b>/usr/share/freedombone/avatars</b>.
680
+</p>
681
+
682
+<div class="org-center">
683
+
684
+<div class="figure">
685
+<p><img src="images/patchwork_setup.jpg" alt="patchwork_setup.jpg" />
686
+</p>
687
+</div>
688
+</div>
689
+
690
+<p>
691
+Other Patchwork users on the mesh will appear automatically under the <b>local</b> list and you can select and follow them if you wish. It's also possible to select the dark theme from <b>settings</b> on the drop down menu if you prefer.
692
+</p>
693
+
694
+<div class="org-center">
695
+
696
+<div class="figure">
697
+<p><img src="images/patchwork_public.jpg" alt="patchwork_public.jpg" />
698
+</p>
699
+</div>
700
+</div>
701
+
702
+<p>
703
+The Secure Scuttlebutt protocol which Patchwork is based upon is intended to be robust to intermittent network connectivity, so you can write posts when out of range and they will sync once you are back in the network.
704
+</p>
705
+</div>
706
+</div>
707
+
708
+<div id="outline-container-org434316e" class="outline-3">
709
+<h3 id="org434316e">Sharing Files</h3>
710
+<div class="outline-text-3" id="text-org434316e">
674
 <p>
711
 <p>
675
 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.
712
 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.
676
 </p>
713
 </p>
685
 </div>
722
 </div>
686
 </div>
723
 </div>
687
 
724
 
688
-<div id="outline-container-org86cab79" class="outline-3">
689
-<h3 id="org86cab79">Blogging</h3>
690
-<div class="outline-text-3" id="text-org86cab79">
725
+<div id="outline-container-org95bbdc4" class="outline-3">
726
+<h3 id="org95bbdc4">Blogging</h3>
727
+<div class="outline-text-3" id="text-org95bbdc4">
691
 <p>
728
 <p>
692
 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.
729
 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.
693
 </p>
730
 </p>