README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

gnunet-web
==========

This is a port of [GNUnet] to the browser using [WebRTC] for peer-to-peer
communication.

Roadmap
-------
* Compile GNUnet using [emscripten].
* Write an HTTP(S) transport plugin using [CORS].
* Write a minimal UI that allows publishing, searching, and downloading via the
  file-sharing service.
* Release alpha.
* Write a WebRTC transport plugin.
    * Implement [RFC3264] over GNUnet.

What You Can Do Now
-------------------

### Try out the RTCPeerConnection demo ###
0. Execute `lein run`
1. Open two browsers to http://localhost:3000/ (let's call them Alice and Bob).
2. Alice presses "Create Offer" and waits a bit for ICE candidates to be
   collected.
3. Alice sends the Local Description to Bob.
4. Bob enters the description into the Remote Description box and presses
   "Set Remote Description as Offer".
5. Bob presses "Create Answer" and waits a bit for ICE candidates to be
   collected.
6. Bob sends the Local Description to Alice.
7. Alice enters the description into the Remote Description box and presses
   "Set Remote Description as Answer".
8. Alice and Bob wait for the ICE State to be connected.
9. Alice and Bob can send messages with the input box at the bottom of the page.

### Compile GNUnet with emscripten ###
0. Execute `./build-gnunet.sh`
1. Execute `lein run`
2. Open http://localhost:3000/gnunet.html

We're a long way from running GNUnet in the browser. Currently we have the
transport and ats services running as shared workers and the peerinfo service
provided by the browser window thread.

To debug a shared worker in chrome open chrome://inspect and click the
"inspect" link next to the http://localhost:3000/js/gnunet-service-transport.js
shared worker.

Eventually we will have each GNUnet service running in its own [Web Worker]
thread. The APIs used by the services to schedule tasks and communicate with
each other is being implemented in javascript.

  [gnunet]: https://gnunet.org
  [webrtc]: http://www.webrtc.org
  [emscripten]: https://github.com/kripken/emscripten
  [rfc3264]: http://www.ietf.org/rfc/rfc3264.txt
  [web worker]: http://www.w3.org/TR/workers/
  [cors]: http://www.w3.org/TR/access-control/