diff options
Diffstat (limited to 'README')
-rw-r--r-- | README | 50 |
1 files changed, 23 insertions, 27 deletions
@@ -23,6 +23,8 @@ fork! | |||
23 | 23 | ||
24 | Additional documentation about GNUnet can be found at | 24 | Additional documentation about GNUnet can be found at |
25 | https://gnunet.org/ and in the 'doc/' folder. | 25 | https://gnunet.org/ and in the 'doc/' folder. |
26 | Online documentation is provided at | ||
27 | 'https://docs.gnunet.org' and 'https://tutorial.gnunet.org'. | ||
26 | 28 | ||
27 | 29 | ||
28 | Dependencies: | 30 | Dependencies: |
@@ -32,7 +34,7 @@ These are the direct dependencies for running GNUnet: | |||
32 | 34 | ||
33 | - libmicrohttpd >= 0.9.42 | 35 | - libmicrohttpd >= 0.9.42 |
34 | - libgcrypt >= 1.6 | 36 | - libgcrypt >= 1.6 |
35 | - libgnurl >= 7.35.0 (recommended, available from https://gnunet.org/gnurl) | 37 | - libgnurl >= 7.35.0 (recommended, available from https://gnunet.org/en/gnurl.html) |
36 | - libcurl >= 7.35.0 (alternative to libgnurl) | 38 | - libcurl >= 7.35.0 (alternative to libgnurl) |
37 | - libunistring >= 0.9.2 | 39 | - libunistring >= 0.9.2 |
38 | - gnutls >= 3.2.12 (highly recommended a gnutls linked against libunbound) | 40 | - gnutls >= 3.2.12 (highly recommended a gnutls linked against libunbound) |
@@ -41,14 +43,17 @@ These are the direct dependencies for running GNUnet: | |||
41 | or | 43 | or |
42 | - libidn >= 1.0 | 44 | - libidn >= 1.0 |
43 | - libextractor >= 0.6.1 (highly recommended) | 45 | - libextractor >= 0.6.1 (highly recommended) |
44 | - openssl >= 1.0 (binary, used to generate X.509 certificate) | 46 | - openssl >= 1.0 (binary, used to generate X.509 certificate |
47 | for gnunet-gns-proxy-setup-ca) | ||
48 | - nss (certutil binary, for | ||
49 | gnunet-gns-proxy-setup-ca) | ||
45 | - libltdl >= 2.2 (part of GNU libtool) | 50 | - libltdl >= 2.2 (part of GNU libtool) |
46 | - sqlite >= 3.8 (default database, required) | 51 | - sqlite >= 3.8 (default database, required) |
47 | - mysql >= 5.1 (alternative to sqlite) | 52 | - mysql >= 5.1 (alternative to sqlite) |
48 | - postgres >= 9.5 (alternative to sqlite) | 53 | - postgres >= 9.5 (alternative to sqlite) |
49 | - Texinfo >= 5.2 [*1] | 54 | - Texinfo >= 5.2 [*1] |
50 | - makeinfo >= 4.8 (at least 4.8 at the time of writing is tested) | 55 | - makeinfo >= 4.8 |
51 | - which (for the bootstrap script) | 56 | - which (bootstrap script and some Makefiles) |
52 | - gettext | 57 | - gettext |
53 | - zlib | 58 | - zlib |
54 | - pkg-config | 59 | - pkg-config |
@@ -57,8 +62,8 @@ These are the direct dependencies for running GNUnet: | |||
57 | These are the dependencies for GNUnet's testsuite: | 62 | These are the dependencies for GNUnet's testsuite: |
58 | 63 | ||
59 | - Bash (optional (?), for some tests) | 64 | - Bash (optional (?), for some tests) |
60 | - python >= 2.7 (optional, only python 2.7 is supported) | 65 | - python >= 3.7 (optional, only python 3.7 is supported) |
61 | - python-future >= 2.7 (optional, only python 2.7 is supported) | 66 | - python-future >= 3.7 (optional, only python 3.7 is supported) |
62 | 67 | ||
63 | 68 | ||
64 | These are the optional dependencies: | 69 | These are the optional dependencies: |
@@ -67,13 +72,14 @@ These are the optional dependencies: | |||
67 | - libpulse >= 2.0 (optional, for experimental conversation tool) | 72 | - libpulse >= 2.0 (optional, for experimental conversation tool) |
68 | - libogg >= 1.3.0 (optional, for experimental conversation tool) | 73 | - libogg >= 1.3.0 (optional, for experimental conversation tool) |
69 | - libnss (optional, certtool binary (for convenient installation of GNS proxy)) | 74 | - libnss (optional, certtool binary (for convenient installation of GNS proxy)) |
70 | - python-future (optional, for some testcases and utilities) | 75 | - python2.7-future (optional, for gnunet-qr) |
71 | - python-zbar >= 0.10 (optional, for gnunet-qr) | 76 | - python-zbar >= 0.10 (optional, for gnunet-qr) |
72 | - TeX Live >= 2012 (optional, for gnunet-bcd[*]) | 77 | - TeX Live >= 2012 (optional, for gnunet-bcd[*]) |
73 | - texi2mdoc (optional, for automatic mdoc generation [*2]) | 78 | - texi2mdoc (optional, for automatic mdoc generation [*2]) |
74 | - libglpk >= 4.45 (optional, for experimental code) | 79 | - libglpk >= 4.45 (optional, for experimental code) |
75 | - perl5 (optional, for some utilities) | 80 | - perl5 (optional, for some utilities) |
76 | - python >= 2.7 (optional, for gnunet-qr, only python 2.7 is supported) | 81 | - guile 1.6.4 (or later up to 1.8?, optional for gnunet-download-manager) |
82 | - python2.7 >= 2.7 (optional, for gnunet-qr, only python 2.7 is supported) | ||
77 | - bluez (optional, for bluetooth support) | 83 | - bluez (optional, for bluetooth support) |
78 | - miniupnpc | 84 | - miniupnpc |
79 | - libpbc >= 0.5.14 (optional, for Attribute-Based Encryption and Identity Provider functionality) | 85 | - libpbc >= 0.5.14 (optional, for Attribute-Based Encryption and Identity Provider functionality) |
@@ -160,22 +166,12 @@ Building GNUnet from source | |||
160 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 166 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
161 | 167 | ||
162 | IMPORTANT: You can read further notes about compilation from source in | 168 | IMPORTANT: You can read further notes about compilation from source in |
163 | the 'doc/FILENAME' document, which includes notes about specific | 169 | the handbook under doc/handbook/, which includes notes about specific |
164 | requirements for operating systems aswell. If you are a package | 170 | requirements for operating systems aswell. If you are a package |
165 | mantainer for an Operating System we invite you to add your notes if | 171 | mantainer for an Operating System we invite you to add your notes if |
166 | you feel it is necessary and can not be covered in your Operating | 172 | you feel it is necessary and can not be covered in your Operating |
167 | System's documentation. | 173 | System's documentation. |
168 | 174 | ||
169 | If you are building GNUnet from source you are either interested | ||
170 | in furthering its development (we have further notes for developer | ||
171 | builds in our 'GNUnet Developer Handbook') or you don't trust other | ||
172 | people's binaries or your Operating System doesn't provide any | ||
173 | binary package (at the moment). | ||
174 | |||
175 | If you're on Gentoo you can build GNUnet using the recipes provided | ||
176 | in the 'youbroketheinternet' overlay. Other Operating Systems may | ||
177 | unintentionally require you to build GNUnet from source. | ||
178 | |||
179 | Two prominent examples which currently lack cross-compilation | 175 | Two prominent examples which currently lack cross-compilation |
180 | support in GNUnet (and native binaries) are MS Windows and Apple macOS. | 176 | support in GNUnet (and native binaries) are MS Windows and Apple macOS. |
181 | For macOS we recommend you to do the build process via Homebrew and a | 177 | For macOS we recommend you to do the build process via Homebrew and a |
@@ -199,7 +195,7 @@ If you install from source, you need to install GNU libextractor first | |||
199 | (download from https://www.gnu.org/software/libextractor/). We also | 195 | (download from https://www.gnu.org/software/libextractor/). We also |
200 | recommend installing GNU libmicrohttpd (download from | 196 | recommend installing GNU libmicrohttpd (download from |
201 | https://www.gnu.org/software/libmicrohttpd/). Furthermore we recommend | 197 | https://www.gnu.org/software/libmicrohttpd/). Furthermore we recommend |
202 | libgnurl (from https://gnunet.org/gnurl). | 198 | libgnurl (from https://gnunet.org/en/gnurl.html). |
203 | Then you can start the actual GNUnet compilation process with: | 199 | Then you can start the actual GNUnet compilation process with: |
204 | 200 | ||
205 | 201 | ||
@@ -311,7 +307,7 @@ Usage | |||
311 | ===== | 307 | ===== |
312 | 308 | ||
313 | For detailed usage notes, instructions and examples, refer to the | 309 | For detailed usage notes, instructions and examples, refer to the |
314 | included 'GNUnet User Handbook'. | 310 | included 'GNUnet Handbook'. |
315 | 311 | ||
316 | First, you must obtain an initial list of GNUnet hosts. Knowing a | 312 | First, you must obtain an initial list of GNUnet hosts. Knowing a |
317 | single peer is sufficient since after that GNUnet propagates | 313 | single peer is sufficient since after that GNUnet propagates |
@@ -372,7 +368,7 @@ Hacking GNUnet | |||
372 | ============== | 368 | ============== |
373 | 369 | ||
374 | Contributions are welcome. Please submit bugs you find to | 370 | Contributions are welcome. Please submit bugs you find to |
375 | https://gnunet.org/bugs/. | 371 | https://bugs.gnunet.org/ or our bugs mailinglist. |
376 | Please make sure to run the script "contrib/scripts/gnunet-bugreport" | 372 | Please make sure to run the script "contrib/scripts/gnunet-bugreport" |
377 | and include the output with your bug reports. More about how to | 373 | and include the output with your bug reports. More about how to |
378 | report bugs can be found in the GNUnet FAQ on the webpage. Submit | 374 | report bugs can be found in the GNUnet FAQ on the webpage. Submit |
@@ -392,7 +388,7 @@ $ make install | |||
392 | $ export $GNUNET_PREFIX=$SOMEWHERE | 388 | $ export $GNUNET_PREFIX=$SOMEWHERE |
393 | $ make check | 389 | $ make check |
394 | 390 | ||
395 | Some of the testcases require python >= 2.7, and the python modules | 391 | Some of the testcases require python >= 3.7, and the python modules |
396 | "python-future" (http://python-future.org/) and "pexpect" to be installed. | 392 | "python-future" (http://python-future.org/) and "pexpect" to be installed. |
397 | If any testcases fail to pass on your system, run | 393 | If any testcases fail to pass on your system, run |
398 | "contrib/scripts/gnunet-bugreport" (in the repository) or "gnunet-bugreport" | 394 | "contrib/scripts/gnunet-bugreport" (in the repository) or "gnunet-bugreport" |
@@ -457,9 +453,9 @@ Further Reading | |||
457 | There are currently 2 ways to get them: | 453 | There are currently 2 ways to get them: |
458 | 454 | ||
459 | * Using git: | 455 | * Using git: |
460 | git clone https://gnunet.org/git/bibliography.git | 456 | git clone https://git.gnunet.org/bibliography.git |
461 | * Using Drupal: | 457 | * Using Drupal: |
462 | https://gnunet.org/bibliography | 458 | https://old.gnunet.org/bibliography |
463 | 459 | ||
464 | The Drupal access will be replaced by a new interface to our | 460 | The Drupal access will be replaced by a new interface to our |
465 | bibliography in 2019. | 461 | bibliography in 2019. |
@@ -469,8 +465,8 @@ Stay tuned | |||
469 | ========== | 465 | ========== |
470 | 466 | ||
471 | * https://gnunet.org/ | 467 | * https://gnunet.org/ |
472 | * https://gnunet.org/bugs/ | 468 | * https://bugs.gnunet.org |
473 | * https://gnunet.org/git/ | 469 | * https://git.gnunet.org |
474 | * http://www.gnu.org/software/gnunet/ | 470 | * http://www.gnu.org/software/gnunet/ |
475 | * http://mail.gnu.org/mailman/listinfo/gnunet-developers | 471 | * http://mail.gnu.org/mailman/listinfo/gnunet-developers |
476 | * http://mail.gnu.org/mailman/listinfo/help-gnunet | 472 | * http://mail.gnu.org/mailman/listinfo/help-gnunet |