zoruk / 6rd Goto Github PK

0. WHAT IS THIS ?

	This software is an init script. It will configure a 6rd tunnel on a 
	Linux-based router.
	
1. WHAT IS REQUIRED ?

	- Linux >= 2.6.33 (uname -r)
	- iproute2 >= 2.6.33 (debian package "iproute")
	- bash >= 3 (bash --version)
	- cat & cut, but they are almost default features on linux.
	- wget or curl. Unless you have manually static public v4 configured.

2. WHERE IS IT KNOWN TO BE WORKING ?

	- Debian, with correct linux kernel & iproute2 (see 1.)
	- Ubuntu, with correct linux kernel & iproute2 (see 1.)

3. WHERE IS IT EXPECTED TO BE WORKING ?

	- Any linux-based distribution that fulfills requirement in 1.
	- Including OpenWRT if you install a correct kernel and iproute2.
	
4. WHERE WILL THIS _NOT_ WORK ?
	
	- *BSD
	- Windows *
	- MacOS *
	- Android * (could be working maybe later depending on their dev)
	- iPhone *
	- Other non-linux stuff
	
5. INSTALLATION ?

	- cp 6rd /etc/init.d/6rd
	- chmod 755 /etc/init.d/6rd
	- cp etc-default-6rd /etc/default/6rd
	
--- and : EDIT /etc/default/6rd !

	as root !
	
6. USAGE ?

	Well it's a init script so it will be started on startup, but you can :
	- /etc/init.d/6rd start/restart/stop
	
	as root !

7. AND RADVD ?

	The script is not configuring radvd, so you need to configure it separately.
	However, it will reload radvd after finishing the v6 config in order to force
	new RAs. You can configure for each lan iface the prefix ::/64, and radvd
	will automatically take the prefix configured on the interface.
	
8. WHAT IS THE LICENSE ?
	
This is a 3-Clause BSD Licence, GPL-Compatible
http://www.gnu.org/licenses/license-list.html#ModifiedBSD
Please be aware that the copyright information MUST be maintained.

(C) Carlos M. Martinez-Cagnazzo, 2008. Original 6to4 Script.
    http://cagnazzo.name/drupal/6to4

(C) Guillaume Leclanche, 2010-2011. Completed for 6rd and non-NATed routers.
    http://code.google.com/p/6rd

Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions are met:

- Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, 
this list of conditions and the following disclaimer in the documentation 
and/or other materials provided with the distribution.
- The names of the authors may not be used to endorse or promote products 
derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 
EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR  
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.