Browse Source

mesh documentation

Bob Mottram 8 years ago
parent
commit
61dfa15919
2 changed files with 101 additions and 58 deletions
  1. 34
    15
      doc/EN/mesh.org
  2. 67
    43
      website/EN/mesh.html

+ 34
- 15
doc/EN/mesh.org View File

22
 
22
 
23
 * Ready made images
23
 * Ready made images
24
 ** Client images
24
 ** Client images
25
-"Client" isn't exactly the right term, but it's a mesh peer with a user interface. These images can be copied to a USB drive and used with a laptop/netbook/desktop machine.
25
+"Client" isn't exactly the right term, but it's a mesh peer with a user interface. These images can be copied to a USB drive, then you can plug it into a laptop/netbook/desktop machine and boot from it. You will probably also need an Atheros USB wifi dongle, because most built-in wifi usually requires proprietary firmware.
26
 
26
 
27
-[[file:downloads/mesh-client.img.xz][mesh-client.img.xz]]
28
-
29
-GPG signature:
27
+#+begin_src bash
28
+wget https://freedombone.net/downloads/mesh-client-i386.img.xz
29
+wget https://freedombone.net/downloads/mesh-client-i386.img.xz.sig
30
+gpg --verify mesh-client-i386.img.xz.sig
31
+sha256sum mesh-client-i386.img.xz
32
+eaf87dcbb17b7d8328fde56005d396d423e51390e4163385c0ee8cfa0844d6f3
33
+unxz mesh-client-i386.img.xz
34
+dd bs=1M if=mesh-client-i386.img of=/dev/sdX conv=fdatasync
35
+#+end_src
30
 
36
 
31
-[[file:downloads/mesh-client.img.xz.sig][mesh-client.img.xz.sig]]
37
+If you're in an emergency and don't have Atheros wifi dongles then there is also an "insecure" image which contains some proprietary wifi drivers which may work with a wider range of laptops. Proprietary drivers *are not recommended* because they're unsupportable and may be exploitable or contain malicious antifeatures which fundamentally compromise the security of the network. However, the trade-off between security/maintainability and simply having the ability to communicate at all may be a valid one in some situations.
32
 
38
 
33
-sha256 hash
34
 #+begin_src bash
39
 #+begin_src bash
40
+wget https://freedombone.net/downloads/mesh-client-i386-insecure.img.xz
41
+wget https://freedombone.net/downloads/mesh-client-i386-insecure.img.xz.sig
42
+gpg --verify mesh-client-i386-insecure.img.xz.sig
43
+sha256sum mesh-client-i386-insecure.img.xz
35
 
44
 
45
+unxz mesh-client-i386-insecure.img.xz
46
+dd bs=1M if=mesh-client-i386-insecure.img of=/dev/sdX conv=fdatasync
36
 #+end_src
47
 #+end_src
37
 
48
 
38
 ** Router images
49
 ** Router images
39
-Mesh router image for the Beaglebone Black:
40
-
41
-[[file:downloads/mesh-router-beaglebone-black.img.xz][mesh-router-beaglebone-black.img.xz]]
42
-
43
-GPG signature:
44
-
45
-[[file:downloads/mesh-router-beaglebone-black.img.xz.sig][mesh-router-beaglebone-black.img.xz.sig]]
46
-
47
-sha256 hash
50
+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 move network traffic across the mesh. 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.
51
+*** Beaglebone Black
48
 #+begin_src bash
52
 #+begin_src bash
53
+wget https://freedombone.net/downloads/mesh-router-beaglebone-black.img.xz
54
+wget https://freedombone.net/downloads/mesh-router-beaglebone-black.img.xz.sig
55
+gpg --verify mesh-router-beaglebone-black.img.xz.sig
56
+sha256sum mesh-router-beaglebone-black.img.xz
49
 7e90e0489eff70d7211b2b9b891ba6da20670bedbbe6db3edbb41bc54f7c8679
57
 7e90e0489eff70d7211b2b9b891ba6da20670bedbbe6db3edbb41bc54f7c8679
58
+unxz mesh-router-beaglebone-black.img.xz
59
+dd bs=1M if=mesh-router-beaglebone-black.img of=/dev/sdX conv=fdatasync
50
 #+end_src
60
 #+end_src
51
 
61
 
52
 * To build the disk image yourself
62
 * To build the disk image yourself
109
 #+BEGIN_CENTER
119
 #+BEGIN_CENTER
110
 This site can also be accessed via a Tor browser at [[http://4fvfozz6g3zmvf76.onion][4fvfozz6g3zmvf76.onion]]
120
 This site can also be accessed via a Tor browser at [[http://4fvfozz6g3zmvf76.onion][4fvfozz6g3zmvf76.onion]]
111
 #+END_CENTER
121
 #+END_CENTER
122
+
123
+* How to use it
124
+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.
125
+
126
+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 Tox chat and users icons appear. Select the users icon and you should see a list of users on the mesh. Select the Tox chat 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. The other user can then accept or decline your friend request.
127
+
128
+One important point is that by default sound and microphone is turned off. In the top right corner of the screen you can increase the sound volume and enable the microphone if you're doing voice chat.
129
+
130
+At present video doesn't work reliably, but text and voice chat do work well. In future IPFS or Tahoe-LAFS may be added to create a distributed filesystem for the mesh.

+ 67
- 43
website/EN/mesh.html View File

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
-<!-- 2016-08-29 Mon 23:23 -->
6
+<!-- 2016-08-30 Tue 11:52 -->
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>
255
 Mesh networks are useful as a quick way to make a fully decentralised communications system which is not connected to the internet. Think festivals, hacker conferences, onboard ships at sea, disaster/war zones, small business internal office communications, protests, remote areas of the world, scientific expeditions and off-world space colonies. All the cool stuff. 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.
255
 Mesh networks are useful as a quick way to make a fully decentralised communications system which is not connected to the internet. Think festivals, hacker conferences, onboard ships at sea, disaster/war zones, small business internal office communications, protests, remote areas of the world, scientific expeditions and off-world space colonies. All the cool stuff. 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.
256
 </p>
256
 </p>
257
 
257
 
258
-<div id="outline-container-orgad9257c" class="outline-2">
259
-<h2 id="orgad9257c">Ready made images</h2>
260
-<div class="outline-text-2" id="text-orgad9257c">
261
-</div><div id="outline-container-org58a10c8" class="outline-3">
262
-<h3 id="org58a10c8">Client images</h3>
263
-<div class="outline-text-3" id="text-org58a10c8">
258
+<div id="outline-container-orgd772d02" class="outline-2">
259
+<h2 id="orgd772d02">Ready made images</h2>
260
+<div class="outline-text-2" id="text-orgd772d02">
261
+</div><div id="outline-container-org3270ae2" class="outline-3">
262
+<h3 id="org3270ae2">Client images</h3>
263
+<div class="outline-text-3" id="text-org3270ae2">
264
 <p>
264
 <p>
265
-"Client" isn't exactly the right term, but it's a mesh peer with a user interface. These images can be copied to a USB drive and used with a laptop/netbook/desktop machine.
265
+"Client" isn't exactly the right term, but it's a mesh peer with a user interface. These images can be copied to a USB drive, then you can plug it into a laptop/netbook/desktop machine and boot from it. You will probably also need an Atheros USB wifi dongle, because most built-in wifi usually requires proprietary firmware.
266
 </p>
266
 </p>
267
 
267
 
268
-<p>
269
-<a href="downloads/mesh-client.img.xz">mesh-client.img.xz</a>
270
-</p>
268
+<div class="org-src-container">
271
 
269
 
272
-<p>
273
-GPG signature:
274
-</p>
270
+<pre class="src src-bash">wget https://freedombone.net/downloads/mesh-client-i386.img.xz
271
+wget https://freedombone.net/downloads/mesh-client-i386.img.xz.sig
272
+gpg --verify mesh-client-i386.img.xz.sig
273
+sha256sum mesh-client-i386.img.xz
274
+eaf87dcbb17b7d8328fde56005d396d423e51390e4163385c0ee8cfa0844d6f3
275
+unxz mesh-client-i386.img.xz
276
+dd <span class="org-variable-name">bs</span>=1M <span class="org-variable-name">if</span>=mesh-client-i386.img <span class="org-variable-name">of</span>=/dev/sdX <span class="org-variable-name">conv</span>=fdatasync
277
+</pre>
278
+</div>
275
 
279
 
276
 <p>
280
 <p>
277
-<a href="downloads/mesh-client.img.xz.sig">mesh-client.img.xz.sig</a>
281
+If you're in an emergency and don't have Atheros wifi dongles then there is also an "insecure" image which contains some proprietary wifi drivers which may work with a wider range of laptops. Proprietary drivers <b>are not recommended</b> because they're unsupportable and may be exploitable or contain malicious antifeatures which fundamentally compromise the security of the network. However, the trade-off between security/maintainability and simply having the ability to communicate at all may be a valid one in some situations.
278
 </p>
282
 </p>
279
 
283
 
280
-<p>
281
-sha256 hash
282
-</p>
283
 <div class="org-src-container">
284
 <div class="org-src-container">
284
 
285
 
285
-<pre class="src src-bash"></pre>
286
+<pre class="src src-bash">wget https://freedombone.net/downloads/mesh-client-i386-insecure.img.xz
287
+wget https://freedombone.net/downloads/mesh-client-i386-insecure.img.xz.sig
288
+gpg --verify mesh-client-i386-insecure.img.xz.sig
289
+sha256sum mesh-client-i386-insecure.img.xz
290
+
291
+unxz mesh-client-i386-insecure.img.xz
292
+dd <span class="org-variable-name">bs</span>=1M <span class="org-variable-name">if</span>=mesh-client-i386-insecure.img <span class="org-variable-name">of</span>=/dev/sdX <span class="org-variable-name">conv</span>=fdatasync
293
+</pre>
286
 </div>
294
 </div>
287
 </div>
295
 </div>
288
 </div>
296
 </div>
289
 
297
 
290
-<div id="outline-container-org9127982" class="outline-3">
291
-<h3 id="org9127982">Router images</h3>
292
-<div class="outline-text-3" id="text-org9127982">
293
-<p>
294
-Mesh router image for the Beaglebone Black:
295
-</p>
296
-
297
-<p>
298
-<a href="downloads/mesh-router-beaglebone-black.img.xz">mesh-router-beaglebone-black.img.xz</a>
299
-</p>
300
-
301
-<p>
302
-GPG signature:
303
-</p>
304
-
298
+<div id="outline-container-orgec62337" class="outline-3">
299
+<h3 id="orgec62337">Router images</h3>
300
+<div class="outline-text-3" id="text-orgec62337">
305
 <p>
301
 <p>
306
-<a href="downloads/mesh-router-beaglebone-black.img.xz.sig">mesh-router-beaglebone-black.img.xz.sig</a>
307
-</p>
308
-
309
-<p>
310
-sha256 hash
302
+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 move network traffic across the mesh. 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.
311
 </p>
303
 </p>
304
+</div>
305
+<div id="outline-container-org1fddd6f" class="outline-4">
306
+<h4 id="org1fddd6f">Beaglebone Black</h4>
307
+<div class="outline-text-4" id="text-org1fddd6f">
312
 <div class="org-src-container">
308
 <div class="org-src-container">
313
 
309
 
314
-<pre class="src src-bash">7e90e0489eff70d7211b2b9b891ba6da20670bedbbe6db3edbb41bc54f7c8679
310
+<pre class="src src-bash">wget https://freedombone.net/downloads/mesh-router-beaglebone-black.img.xz
311
+wget https://freedombone.net/downloads/mesh-router-beaglebone-black.img.xz.sig
312
+gpg --verify mesh-router-beaglebone-black.img.xz.sig
313
+sha256sum mesh-router-beaglebone-black.img.xz
314
+7e90e0489eff70d7211b2b9b891ba6da20670bedbbe6db3edbb41bc54f7c8679
315
+unxz mesh-router-beaglebone-black.img.xz
316
+dd <span class="org-variable-name">bs</span>=1M <span class="org-variable-name">if</span>=mesh-router-beaglebone-black.img <span class="org-variable-name">of</span>=/dev/sdX <span class="org-variable-name">conv</span>=fdatasync
315
 </pre>
317
 </pre>
316
 </div>
318
 </div>
317
 </div>
319
 </div>
318
 </div>
320
 </div>
319
 </div>
321
 </div>
322
+</div>
320
 
323
 
321
-<div id="outline-container-org6b10959" class="outline-2">
322
-<h2 id="org6b10959">To build the disk image yourself</h2>
323
-<div class="outline-text-2" id="text-org6b10959">
324
+<div id="outline-container-orgfb30373" class="outline-2">
325
+<h2 id="orgfb30373">To build the disk image yourself</h2>
326
+<div class="outline-text-2" id="text-orgfb30373">
324
 <p>
327
 <p>
325
 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.
328
 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.
326
 </p>
329
 </p>
420
 </div>
423
 </div>
421
 </div>
424
 </div>
422
 </div>
425
 </div>
426
+
427
+<div id="outline-container-org4311dfe" class="outline-2">
428
+<h2 id="org4311dfe">How to use it</h2>
429
+<div class="outline-text-2" id="text-org4311dfe">
430
+<p>
431
+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.
432
+</p>
433
+
434
+<p>
435
+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 Tox chat and users icons appear. Select the users icon and you should see a list of users on the mesh. Select the Tox chat 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. The other user can then accept or decline your friend request.
436
+</p>
437
+
438
+<p>
439
+One important point is that by default sound and microphone is turned off. In the top right corner of the screen you can increase the sound volume and enable the microphone if you're doing voice chat.
440
+</p>
441
+
442
+<p>
443
+At present video doesn't work reliably, but text and voice chat do work well. In future IPFS or Tahoe-LAFS may be added to create a distributed filesystem for the mesh.
444
+</p>
445
+</div>
446
+</div>
423
 </div>
447
 </div>
424
 <div id="postamble" class="status">
448
 <div id="postamble" class="status">
425
 
449