mirror of
https://github.com/ChronosX88/netsukuku.git
synced 2024-12-22 17:01:46 +00:00
Simplified and listed as deprecated the old stuff.
This commit is contained in:
parent
83db8acdde
commit
b82fa51cf6
120
README.md
120
README.md
@ -14,13 +14,14 @@ itself autonomously. It is designed to handle an unlimited number of nodes
|
||||
with minimal CPU and memory resources.
|
||||
|
||||
Thanks to this feature it can be easily
|
||||
used to build a worldwide distributed, anonymous and not controlled network,
|
||||
used to build a worldwide distributed, anonymous and decentralised network,
|
||||
separated from the Internet, without the support of any servers, ISPs or
|
||||
authority controls.
|
||||
authorities.
|
||||
|
||||
This net is composed by computers linked physically each other, therefore it
|
||||
This net is composed by computers linked physically each other, Therefore it
|
||||
isn't build upon any existing network. Netsukuku builds only the routes which
|
||||
connects all the computers of the net.
|
||||
connects all the computers of the net.
|
||||
Although it can route through the internet if needed.
|
||||
In other words, Netsukuku replaces the level 3 of the model iso/osi with
|
||||
another routing protocol.
|
||||
|
||||
@ -36,44 +37,46 @@ http://netsukuku.freaknet.org/files/doc/misc/Ntk_features_list
|
||||
|
||||
Just search what ever you want to know, And be amazed with doxygen's glory! ^-^
|
||||
|
||||
In order to join to Netsukuku you have to use NetsukukuD, which is the daemon
|
||||
implementing the Npv7 protocol.
|
||||
|
||||
Before doing anything, please read the documentation in doc/ or in
|
||||
http://netsukuku.freaknet.org
|
||||
|
||||
|
||||
# Get the code!
|
||||
|
||||
|
||||
$git clone git@github.com:Netsukuku/netsukuku.git
|
||||
|
||||
If that doesn't work, Try this!
|
||||
|
||||
$git clone https://github.com/Netsukuku/netsukuku.git
|
||||
|
||||
If even that doesn't work, Download the .zip from this page.
|
||||
|
||||
In order to join to Netsukuku, Just install it and run it! Connect as many
|
||||
nodes together as you want!
|
||||
|
||||
# Build and install
|
||||
|
||||
The dependencies of netsukuku can be gathered by running this command.
|
||||
## Get the code!
|
||||
|
||||
# sudo apt-get install zlibc libgmp-dev openssl libssl-dev libgee-dev libpth-dev libgcrypt11-dev autoconf cmake autogen mawk gawk
|
||||
git clone git@github.com:Netsukuku/netsukuku.git
|
||||
|
||||
To compile the code you can use scons or just go with the old school way:
|
||||
The dependencies of netsukuku can be installed by running this command.
|
||||
|
||||
sudo apt-get install zlibc libgmp-dev openssl libssl-dev libgee-dev libpth-dev libgcrypt11-dev autoconf cmake autogen mawk gawk
|
||||
|
||||
To compile the code you can do this:
|
||||
|
||||
# autoreconf -i
|
||||
# ./configure && make
|
||||
# sudo make install
|
||||
autoreconf -i
|
||||
./configure && make
|
||||
sudo make install
|
||||
|
||||
But SCons is cooler:
|
||||
http://www.scons.org/
|
||||
(You should have installed at least the 2.4 version of Python in order to
|
||||
avoid dirty bugs in scons)
|
||||
## Once installed
|
||||
|
||||
You can go to the libgmp/zlib/openssl websites below if you wish,
|
||||
As they are dependenices of netsukuku.
|
||||
In order to start netsukuku on eth0, It is preferred to run:
|
||||
|
||||
sudo ntkd -D -i eth0 -dd
|
||||
|
||||
CURRENTLY NON-FUNCTIONAL:
|
||||
|
||||
However, There are more options, Such as:
|
||||
|
||||
sudo ntkd -D -i eth0 -r -I -dd
|
||||
|
||||
This will run netsukuku in restricted mode and share your internet connection.
|
||||
|
||||
(Netsukuku should be able to use any network interface you have, Even VPNs that emulate ethernet
|
||||
such as tinc.)
|
||||
|
||||
## Manual Dependencies
|
||||
|
||||
You can manually download the dependencies of netsukuku if you want,
|
||||
Or use them for development.
|
||||
|
||||
Here they are!
|
||||
|
||||
@ -81,6 +84,15 @@ for the libgmp: http://www.swox.com/gmp/
|
||||
the openssl library here: http://openssl.org
|
||||
and finally the zlibs: http://zlib.net
|
||||
|
||||
## Old stuff
|
||||
|
||||
You can use this, But, I don't know if it works anymore.
|
||||
|
||||
SCons is a cooler way to install netsukuku:
|
||||
http://www.scons.org/
|
||||
(You should have installed at least the 2.4 version of Python in order to
|
||||
avoid dirty bugs in scons)
|
||||
|
||||
Then go in the src/ directory and type:
|
||||
|
||||
$ scons --help
|
||||
@ -107,6 +119,8 @@ may want to reinstall it with another MANDIR path), you have to run:
|
||||
|
||||
# Static Binaries and Packages
|
||||
|
||||
These packages are old, We will update them soon, Or you can if you want.
|
||||
|
||||
If you prefer to just install Netsukuku, without compiling it, you can
|
||||
download the static binaries suitable to your platform. They come packed in
|
||||
various formats (.tgz, .deb, .ipk).
|
||||
@ -120,6 +134,7 @@ The packages repository is at:
|
||||
|
||||
# Kernel dependencies
|
||||
|
||||
I'm not sure if we need to do any of this anymore, But it is probably useful.
|
||||
|
||||
(The following probably is already, If not will be soon, Unnecessary/automated.)
|
||||
|
||||
@ -142,6 +157,8 @@ These options are taken from linux-2.6.14.
|
||||
and these from linux-2.6.16.19.
|
||||
|
||||
Core Netfilter Configuration
|
||||
|
||||
(I vaugely remember getting a conntrack error in the past, But it is gone now.)
|
||||
|
||||
CONFIG_NETFILTER_XT_MATCH_CONNTRACK=y
|
||||
NETFILTER_XT_TARGET_CONNMARK=y
|
||||
@ -166,8 +183,7 @@ Before doing anything do:
|
||||
$ man ntkd
|
||||
$ man andna
|
||||
|
||||
when you feel confortable and you are ready to dare type with root
|
||||
priviledges:
|
||||
when you feel confortable and you are ready to dare run as root:
|
||||
|
||||
# ntkd
|
||||
|
||||
@ -184,8 +200,18 @@ option.
|
||||
|
||||
# Where to get in touch with us
|
||||
|
||||
## IRC
|
||||
|
||||
This is still true and active! Please join!
|
||||
|
||||
We live night and day in IRC, come to see us on channel
|
||||
#netsukuku
|
||||
on the FreeNode irc server (irc.freenode.org).
|
||||
|
||||
## Mailing list
|
||||
|
||||
These mailing list should mostly still work, But they are not very active.
|
||||
|
||||
Subscribe to the netsukuku mailing to get help, be updated on the latest news
|
||||
and discuss on its development.
|
||||
|
||||
@ -197,13 +223,6 @@ or use the web interface:
|
||||
You can browse the archive here:
|
||||
http://lists.dyne.org/netsukuku/
|
||||
http://dir.gmane.org/gmane.network.peer-to-peer.netsukuku
|
||||
|
||||
|
||||
## IRC
|
||||
|
||||
We live night and day in IRC, come to see us on channel
|
||||
#netsukuku
|
||||
on the FreeNode irc server (irc.freenode.org).
|
||||
|
||||
|
||||
# Bug report
|
||||
@ -213,6 +232,10 @@ on the FreeNode irc server (irc.freenode.org).
|
||||
|
||||
If you encounter any bug, please report it.
|
||||
Use the online bug track system:
|
||||
https://github.com/Netsukuku/netsukuku/issues
|
||||
|
||||
The rest is inactive, Please just use the link above until further notice.
|
||||
|
||||
http://bugs.dyne.org/
|
||||
or the mailing list:
|
||||
http://lists.dyne.org/netsukuku/
|
||||
@ -222,12 +245,17 @@ and explain what the problem is and if possible a way to reproduce it.
|
||||
# Hack the code
|
||||
|
||||
Feel free to debug, patch, modify and eat the code. Then submit your results
|
||||
to the mailing list ^_-
|
||||
to the mailing list. ^_-
|
||||
|
||||
However, It is preferred that you make your own github fork, And show it to us in the IRC or issues page.
|
||||
Although, For smaller changes, You could use pastebin.com
|
||||
But please note! Tell us exactly which file you are editing in pastebin, And tell us which line you are editing.
|
||||
|
||||
There is a lot to code too! If you are a Kung Foo coder, get on board and
|
||||
help the development writing some nice poems. For a start you can take a look
|
||||
help the development! For a start you can take a look
|
||||
at the src/TODO file.
|
||||
|
||||
Still valuable! ^^^^
|
||||
|
||||
# License and that kind of stuff...
|
||||
|
||||
@ -235,3 +263,5 @@ All the Netsukuku code is released under the GPL-2, please see the COPYING
|
||||
file for more information.
|
||||
|
||||
The authors of Netsukuku and NetsukukuD are listed in the file AUTHORS.
|
||||
|
||||
This should be ammended in the future, As more authors come on-board.
|
||||
|
Loading…
Reference in New Issue
Block a user