Browse Source

README for ip over usbsticks

Sebastian Lohff 8 years ago
parent
commit
7f7e137ed6
1 changed files with 36 additions and 3 deletions
  1. 36
    3
      tunnel/usbip/README

+ 36
- 3
tunnel/usbip/README View File

@@ -1,5 +1,38 @@
1
+USBIP
2
+=====
3
+This tunnel implements IP over USB sticks, writing each packet as a single file
4
+onto the USB stick.
1 5
 
2
-Installation
3
-============
4
-You need
6
+Installation and requirements
7
+=============================
5 8
  * python-pyudev
9
+
10
+In conf.py you need to configure a mountpoint and udev attributes, so that the
11
+USB stick can be found. If you are unsure about the udev attibutes use the
12
+listDevices.py script and plug in your USB stick. It will show you all
13
+available attributes.
14
+
15
+On all participating clients the 'usbNetworkDir' needs to be the same, so
16
+newly written network packets can be found.
17
+
18
+How it works
19
+============
20
+All outgoing network packets are written in plain into a file into 
21
+'usbNetworkDir' onto the USB stick. If the stick is not present, the packets
22
+will be queued until the USB stick is mounted. If a USB stick is mounted (and
23
+generated a UDEV-event), incoming traffic will be read from 'usbNetworkDir'.
24
+After reading a file (network packet) the file is deleted.
25
+
26
+Unmounting is kind of a problem: Even if a sync is executed and finished 
27
+properly, the stick might still be processing data, so pay attention to any
28
+signals or lights attached to the stick.
29
+
30
+What could be done
31
+==================
32
+ * implement support for multiple USB sticks
33
+
34
+Licensing
35
+=========
36
+Written by Sebastian Lohff <seba@seba-geek.de>
37
+Published under the GPLv3 or later
38
+

Loading…
Cancel
Save