Aiccu/Installation

From SixXS Wiki

Jump to: navigation, search

Main topic page: Aiccu.

Currently in draft form. Steps have not yet been validated.

Contents

Introduction

The first thing thing to do is to take a look at the downloads section of Aiccu, to see what installation type you should be using, since a number of platforms have binary packages or package installers that know about Aiccu. If your only solution is a source distribution, or you want to compile from source, then follow the instruction in the "Compiling from Source" section below.

Once you have installed, configured and activated aiccu, you will probably want to test it. With an IPv6 compliant web browser (such as Opera 9.5, Firefox 3, Safari 3 or IE7), point your web browser to http://www.kame.net to see the dancing turtle. If it is static then you should check your configuration. Another site you can test with is http://ipv6.google.com/ (this has an IPv6 address only).

One thing that is worth noting is that you are asked to keep your tunnel up. You will me e-mailed if your tunnel is down for a certain amount of time.

Compiling from Source

Note: If you are on MacOS X you will need to make sure that you have XCode tools installed, before you start.

  • Check the tunnel driver page, to see if you need to download the tunnel driver.
  • Download the source tarball from the downloads section (it is the first in the list).
  • Extract the archive. This can be done from the terminal (note the file name may be slighly different):
 tar -zxf aiccu_current.tar.gz
  • Change into the aiccu directory:
 cd aiccu
  • Make the project:
 make
  • Install the project. (By default this installs into /usr/sbin, though if you want it elsewhere you will need to edit the Makefile, notebly the line 'DESTDIR=')
 sudo make install

Configuration

If you are using the standard configuration for aiccu, then you will need to create, or edit the /etc/aiccu.conf file. Below is a sample configuration, which you can paste in. You will want to modify the values for username, password and tunnel_id. This configuration uses AYIYA, since it is assumed that you are stuck behind a NAT. If you don't have a username and password then you will need to register for one. You can see what tunnels are assigned to you on you SixXS home page and if you don't have one, then follow the 'request tunnel' link on the page.

# AICCU Configuration
 
# Login information - register for account at: http://www.sixxs.net/signup/create
username <your nichandle/username>
password <your password>
 
# Protocol and server to use for setting up the tunnel (defaults: none)
#protocol <tic|tsp|l2tp>
#server <server to use>
protocol tic
server tic.sixxs.net
 
# Interface names to use
# ipv6_interface is the name of the interface that will be used as a tunnel interface.
# On *BSD the ipv6_interface should be set to gifX (eg gif0) for proto-41 tunnels
# or tunX (eg tun0) for AYIYA tunnels.
# The value sixxs also works, at least on OpenWRT
# ipv6_interface tun0 
ipv6_interface tun0
 
# The tunnel_id to use - request one at: http://noc.sixxs.net/home
# (only required when there are multiple tunnels in the list)
#tunnel_id Txxxx
 
# Be verbose?
verbose false
 
# Daemonize?
daemonize true
 
# Automatic Login and Tunnel activation?
automatic true
 
# Require TLS?
# When set to true, if TLS is not supported on the server
# the TIC transaction will fail.
# When set to false, it will try a starttls, when that is
# not supported it will continue.
# In any case if AICCU is build with TLS support it will
# try to do a 'starttls' to the TIC server to see if that
# is supported.
requiretls false

Running

To run aiccu, you use the aiccu command. Assuming standard location:

 cd /usr/sbin
 sudo aiccu start

If you run into trouble change the daemonize entry to false and the verbose entry to true, in the aiccu.conf file, as this will help you see what's failing. Some possibilities are listed in the FAQ, or if you don't find an answer there, then there is always the forum.

When everything is up and running you should see your tunnel when you run:

ifconfig -a

Additionally, if you visit The Kame Project web site, you should see an animated turtle, if you are reaching the site via IPv6.

Additional

MacOS X

If you wish to have AICCU start when the machine starts create a file called /Library/LaunchAgents/net.sixxs.Aiccu.plist and add the following text:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
	<key>Label</key>
	<string>net.sixxs.Aiccu</string>
	<key>ProgramArguments</key>
	<array>
		<string>/usr/sbin/aiccu</string>
		<string>start</string>
		<string>/etc/aiccu.conf</string>
	</array>
	<key>RunAtLoad</key>
	<true/>
</dict>
</plist>

Then you can enter sudo launchctl load /Library/LaunchAgents/net.sixxs.Aiccu.plist in the terminal to start up Aiccu immediately or simply reboot your Mac. Note that is important you don't change this configuration to 'keep it running all the time no matter what happens', since this is not accepted behaviour by the SixXS servers, since if AICCU does not start, it has a reason not to start which it gives on either the stdout or in the (sys)log file. The TIC server *will* automatically disable accounts which are detected to run in this mode.

OpenWRT

See: Installing on OpenWRT