diff options
author | Christian Grothoff <christian@grothoff.org> | 2010-03-24 15:08:11 +0000 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2010-03-24 15:08:11 +0000 |
commit | e3820dded23c07ccddacbae87c862800e6174ccb (patch) | |
tree | 5584097866e57e578ef2d46cf5461bef654d9a9c /README | |
parent | 3aea10e56e9f4b4971dd2626bd4f69ea796787e2 (diff) | |
download | gnunet-e3820dded23c07ccddacbae87c862800e6174ccb.tar.gz gnunet-e3820dded23c07ccddacbae87c862800e6174ccb.zip |
fix
Diffstat (limited to 'README')
-rw-r--r-- | README | 126 |
1 files changed, 59 insertions, 67 deletions
@@ -9,15 +9,11 @@ primary application for GNUnet is anonymous file-sharing. GNUnet is | |||
9 | currently developed by a worldwide group of independent free software | 9 | currently developed by a worldwide group of independent free software |
10 | developers. GNUnet is a part of the GNU project (http://www.gnu.org/). | 10 | developers. GNUnet is a part of the GNU project (http://www.gnu.org/). |
11 | 11 | ||
12 | This is a BETA release. While there are no known significant bugs, we | 12 | This is an ALPHA release. There are known and significant bugs as |
13 | are still changing significant aspects of the system in any other | 13 | well as many missing features in this release. |
14 | version. While we believe that the system is usable, quite a few | ||
15 | important features -- which would improve performance make the life of | ||
16 | users easier -- are still missing. Also, the documentation may not be | ||
17 | adequate for inexperienced users. | ||
18 | 14 | ||
19 | For a longer description of the GNUnet System see our webpages | 15 | For a longer description of the GNUnet System see our webpages |
20 | http://www.gnu.org/software/gnunet/ and http://gnunet.org/. | 16 | http://www.gnu.org/software/gnunet/ and http://ng.gnunet.org/. |
21 | 17 | ||
22 | 18 | ||
23 | Dependencies: | 19 | Dependencies: |
@@ -26,23 +22,20 @@ Dependencies: | |||
26 | For the impatient, here is the list of immediate dependencies for | 22 | For the impatient, here is the list of immediate dependencies for |
27 | running GNUnet: | 23 | running GNUnet: |
28 | 24 | ||
29 | - libextractor >= 0.5.23 | 25 | - libextractor >= 0.6.1 |
30 | - libmicrohttpd >= 0.4.2 | 26 | - libmicrohttpd >= 0.4.6 |
31 | - libgcrypt >= 1.2 | 27 | - libgcrypt >= 1.2 |
32 | - libgmp >= 4.0 | 28 | - libgmp >= 4.0 |
33 | - libcurl >= 7.15.4 | 29 | - libcurl >= 7.15.4 |
34 | - libltdl >= 2.2 (part of GNU libtool) | 30 | - libltdl >= 2.2 (part of GNU libtool) |
35 | - mysql >= 5.0 (strongly recommended) | ||
36 | - sqlite >= 3.0 (alternative to MySQL) | 31 | - sqlite >= 3.0 (alternative to MySQL) |
37 | 32 | - mysql >= ??? (not yet supported) | |
38 | Certain gnunet-setup plugins would also like to have: | 33 | - postgres >= ??? (not yet supported) |
39 | - GTK >= 2.6.0 | ||
40 | - Qt >= 4.0 | ||
41 | 34 | ||
42 | Recommended autotools for compiling the SVN version are: | 35 | Recommended autotools for compiling the SVN version are: |
43 | - autoconf >= 2.59 | 36 | - autoconf >= 2.59 |
44 | - automake >= 1.9.4 | 37 | - automake >= 1.11.1 |
45 | - libtool >= 2.2 (only in Debian experimental) | 38 | - libtool >= 2.2 |
46 | 39 | ||
47 | See also README.debian for a list of Debian packages. | 40 | See also README.debian for a list of Debian packages. |
48 | 41 | ||
@@ -52,32 +45,34 @@ How to install? | |||
52 | 45 | ||
53 | The fastest way is to use a binary package if it is available for your | 46 | The fastest way is to use a binary package if it is available for your |
54 | system. For a more detailed description, read the installation | 47 | system. For a more detailed description, read the installation |
55 | instructions on the webpage at http://gnunet.org/documentation.php3. | 48 | instructions on the webpage at https://ng.gnunet.org/installation. |
56 | |||
57 | 49 | ||
58 | If you install from source, you need to install libextractor | 50 | If you install from source, you need to install GNU libextractor first |
59 | first (download from http://gnunet.org/libextractor/). Then | 51 | (download from http://www.gnu.org/software/libextractor/). We also |
60 | you can start the actual GNUnet compilation process with: | 52 | recommend installing GNU libmicrohttpd. Then you can start the actual |
53 | GNUnet compilation process with: | ||
61 | 54 | ||
62 | $ ./configure --prefix=$HOME --with-extractor=$HOME | 55 | $ ./configure --prefix=$HOME --with-extractor=$HOME |
63 | $ make | 56 | $ make |
64 | # make install | 57 | # make install |
65 | # gnunet-setup # (note: does not yet exist!) | 58 | # sudo -u gnunet gnunet-setup # (note: does not yet exist!) |
66 | # gnunet-arm -s | 59 | # sudo -u gnunet gnunet-arm -s |
67 | 60 | ||
68 | This will compile and install GNUnet to ~/bin/, ~/lib/ and ~/man/. | 61 | This will compile and install GNUnet to ~/bin/, ~/lib/ and ~/man/. |
69 | gnunet-setup will create the configuration; this step is | 62 | gnunet-setup will create the configuration; this step is interactive. |
70 | interactive. You can run gnunet-setup as root for a system-wide | 63 | You can run gnunet-setup as root for a system-wide installation or as |
71 | installation or as a particular user to create a personal | 64 | a particular user to create a personal installation. It is |
72 | installation. If you do not want to run gnunetd as root, gnunet-setup | 65 | recommended that you add a user "gnunet" to run "gnunet-arm". You can |
73 | can be used to add a user "gnunet". Data will then be stored in | 66 | then still run the end-user applications as another user. If you |
74 | /var/lib/gnunet and gnunetd will run as that user. Note that | 67 | create a user "gnunet", it is recommended that you edit the |
75 | additional, per-user configuration files (~/.gnunet/gnunet.conf) also | 68 | configuration file slightly so that data can be stored in |
76 | need to be created by each user by running gnunet-setup without the -d | 69 | "/var/lib/gnunet"; you may also want to use "/etc/gnunet.conf" for the |
77 | option. Depending on your operating system the wizards of | 70 | configuration in this case. |
78 | gnunet-setup can also be used to create an init script that starts | 71 | |
79 | gnunetd each time the system boots. For more general information | 72 | Note that additional, per-user configuration files |
80 | about the GNU build process read the INSTALL file. | 73 | (~/.gnunet/gnunet.conf) need to be created by each user (for example, |
74 | by running gnunet-setup). For more general information about the GNU | ||
75 | build process read the INSTALL file. | ||
81 | 76 | ||
82 | GNUnet requires the GNU MP library (http://www.gnu.org/software/gmp/) | 77 | GNUnet requires the GNU MP library (http://www.gnu.org/software/gmp/) |
83 | and libgcrypt. You can specify the path to libgcrypt by passing | 78 | and libgcrypt. You can specify the path to libgcrypt by passing |
@@ -96,31 +91,24 @@ $ aclocal -I /usr/local/share/aclocal | |||
96 | Configuration | 91 | Configuration |
97 | ============= | 92 | ============= |
98 | 93 | ||
99 | // FIXME: update this section once we have gnunet-setup! | 94 | // FIXME: update this section once we have gnunet-setup! GNUnet uses |
100 | GNUnet uses two types of configuration files, one for the daemon | 95 | two types of configuration files, one for the daemon (called |
101 | (called gnunetd.conf) and one for each user (gnunet.conf). You can | 96 | gnunetd.conf) and one for each user (gnunet.conf). You can create and |
102 | create and edit these configuration files with the gnunet-setup tool. | 97 | edit these configuration files with the gnunet-setup tool. The |
103 | You need to add the option "-d" to gnunet-setup in order to edit | ||
104 | gnunetd.conf (by default, gnunet-setup will edit gnunet.conf). The | ||
105 | defaults that are created the first time you run gnunet-setup are | 98 | defaults that are created the first time you run gnunet-setup are |
106 | usually ok, you may want to adjust the limitations (space consumption, | 99 | usually ok, you may want to adjust the limitations (space consumption, |
107 | bandwidth, etc.) though. The configuration files are human-readable; | 100 | bandwidth, etc.) though. The configuration files are human-readable; |
108 | gnunetd's configuration is typically located at "/etc/gnunetd.conf". | 101 | GNUnet's configuration is typically located at |
109 | The per-user configuration file should be at "~/.gnunet/gnunet.conf". | 102 | "~/.gnunet/gnunet.conf". |
110 | A default version of the per-user configuration will automatically | ||
111 | be created whenever you run any tool that needs that particular | ||
112 | cofniguration file. | ||
113 | 103 | ||
114 | You MUST create /etc/gnunet.conf explicitly before starting gnunetd, | 104 | You MUST create "~/.gnunet/gnunet.conf" explicitly before starting |
115 | and the recommended way to do this is to run gnunet-setup -d (plus | 105 | GNUnet, and the recommended way to do this is to run gnunet-setup. |
116 | possibly options to specify which user interface you would perfer). | 106 | You can also create an empty configuration file, in which case |
107 | default values will be used for everything. | ||
117 | 108 | ||
118 | If you want to use a different configuration file, pass the name of | 109 | If you want to use a different configuration file, pass the name of |
119 | the configuration file as an argument with the option "-c" to any | 110 | the configuration file as an argument with the option "-c" to any |
120 | GNUnet application. Sending a SIGHUP to the gnunetd process will | 111 | GNUnet application. |
121 | cause gnunetd to re-read the configuration file. Note that not all | ||
122 | options can be changed at runtime this way (e.g. to change any port | ||
123 | number, you must fully restart gnunetd). | ||
124 | 112 | ||
125 | 113 | ||
126 | Usage | 114 | Usage |
@@ -134,25 +122,27 @@ whenever it is started. If you want to create an alternative URL for | |||
134 | others to use, the file can be generated on any machine running | 122 | others to use, the file can be generated on any machine running |
135 | GNUnet by periodically executing | 123 | GNUnet by periodically executing |
136 | 124 | ||
137 | $ cat $GNUNETD_HOME/data/hosts/* > the_file | 125 | $ cat $SERVICEHOME/data/hosts/* > the_file |
126 | |||
127 | and offering 'the_file' via your web server. Alternatively, you can | ||
128 | run the build-in web server by adding '-p' to the OPTIONS value | ||
129 | in the "hostlist" section of gnunet.conf. | ||
138 | 130 | ||
139 | If the solution with the URL is not feasible for your situation, you | 131 | If the solution with the URL is not feasible for your situation, you |
140 | can also add hosts manually. The GNUnet webpage has a public | 132 | can also add hosts manually. Simply copy the hostkeys to |
141 | directory of hostkeys under http://gnunet.org/hosts/. You | 133 | "$SERVICEHOME/data/hosts/" (where $SERVICEHOME is the directory |
142 | can of course use any other source for these files. Copy the hostkeys | 134 | specified in the /etc/gnunet.conf configuration file). |
143 | to "$GNUNETD_HOME/data/hosts/" (where $GNUNETD_HOME is the | ||
144 | directory specified in the /etc/gnunet.conf configuration file). | ||
145 | 135 | ||
146 | Now start the local node using "gnunet-arm -s". GNUnet should run 24/7 if | 136 | Now start the local node using "gnunet-arm -s". GNUnet should run 24/7 if |
147 | you want to maximize your anonymity. You may start it as a service | 137 | you want to maximize your anonymity. |
148 | with "/etc/init.d/gnunet start". To publish files on GNUnet, use | ||
149 | the "gnunet-publish" command. | ||
150 | 138 | ||
139 | // FIXME: gnunet-gtk is not yet supported in 0.9.x | ||
151 | The GTK user interface is shipped separately from GNUnet. After | 140 | The GTK user interface is shipped separately from GNUnet. After |
152 | downloading and installing gnunet-gtk, you can invoke the GUI with: | 141 | downloading and installing gnunet-gtk, you can invoke the GUI with: |
153 | 142 | ||
154 | $ gnunet-gtk | 143 | $ gnunet-gtk |
155 | 144 | ||
145 | // FIXME: gnunet-qt is not yet supported in 0.9.x | ||
156 | For Qt/KDE users, there is also a QT user interface (also shipped | 146 | For Qt/KDE users, there is also a QT user interface (also shipped |
157 | separately). If you install gnunet-qt, you can invoke the GUI with: | 147 | separately). If you install gnunet-qt, you can invoke the GUI with: |
158 | 148 | ||
@@ -167,8 +157,10 @@ This will display a list of results to the console. Then use | |||
167 | $ gnunet-download -o FILENAME GNUNET_URI | 157 | $ gnunet-download -o FILENAME GNUNET_URI |
168 | 158 | ||
169 | to retrieve a file. The GNUNET_URI is printed by gnunet-search | 159 | to retrieve a file. The GNUNET_URI is printed by gnunet-search |
170 | together with a description. | 160 | together with a description. To publish files on GNUnet, use the |
161 | "gnunet-publish" command. | ||
171 | 162 | ||
163 | // FIXME: auto-share is not yet supported in 0.9.x | ||
172 | In order to share files, the easiest way is to create a directory | 164 | In order to share files, the easiest way is to create a directory |
173 | with the files (and directories) that you want to share and run | 165 | with the files (and directories) that you want to share and run |
174 | 166 | ||
@@ -181,7 +173,7 @@ Hacking GNUnet | |||
181 | ============== | 173 | ============== |
182 | 174 | ||
183 | Contributions are welcome, please submit bugs to | 175 | Contributions are welcome, please submit bugs to |
184 | https://gnunet.org/mantis/. Please make sure to run contrib/report.sh | 176 | https://gnunet.org/bugs/. Please make sure to run contrib/report.sh |
185 | and include the output with your bug reports. More about how to | 177 | and include the output with your bug reports. More about how to |
186 | report bugs can be found in the GNUnet FAQ on the webpage. Submit | 178 | report bugs can be found in the GNUnet FAQ on the webpage. Submit |
187 | patches via E-Mail to gnunet-developers@gnu.org. | 179 | patches via E-Mail to gnunet-developers@gnu.org. |
@@ -203,7 +195,7 @@ $ make check | |||
203 | If any testcases fail to pass on your system, run "contrib/report.sh" | 195 | If any testcases fail to pass on your system, run "contrib/report.sh" |
204 | and report the output together with information about the failing | 196 | and report the output together with information about the failing |
205 | testcase to the Mantis bugtracking system at | 197 | testcase to the Mantis bugtracking system at |
206 | https://gnunet.org/mantis/. | 198 | https://gnunet.org/bugs/. |
207 | 199 | ||
208 | 200 | ||
209 | Running http on port 80 | 201 | Running http on port 80 |
@@ -237,8 +229,8 @@ Stay tuned | |||
237 | 229 | ||
238 | * http://www.gnu.org/software/gnunet/ | 230 | * http://www.gnu.org/software/gnunet/ |
239 | * http://gnunet.org/ | 231 | * http://gnunet.org/ |
240 | * https://gnunet.org/mantis/ | 232 | * https://gnunet.org/bugs/ |
241 | * https://gnunet.org/drupal/ | 233 | * https://ng.gnunet.org/ |
242 | * http://mail.gnu.org/mailman/listinfo/gnunet-developers | 234 | * http://mail.gnu.org/mailman/listinfo/gnunet-developers |
243 | * http://mail.gnu.org/mailman/listinfo/help-gnunet | 235 | * http://mail.gnu.org/mailman/listinfo/help-gnunet |
244 | * http://mail.gnu.org/mailman/listinfo/info-gnunet | 236 | * http://mail.gnu.org/mailman/listinfo/info-gnunet |