freeDiameter: contrib/OpenWRT/HOWTO annotate

annotate contrib/OpenWRT/HOWTO @ 562:e837ef4bdf35

Remove local machine name from the file

author	Sebastien Decugis <sdecugis@nict.go.jp>
date	Thu, 16 Sep 2010 14:35:48 +0900
parents	d1cb0dadc22d
children	62ad61238af2

rev	line source
490 2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	1 This HOWTO describes how to generate a set of ipkg modules for
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	2 providing support of freeDiameter in an OpenWRT system.
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	3
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	4 This HOWTO is written for OpenWRT 10.03 (BackFire) and no guarantee is provided
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	5 that it will work for you. Be prepared to eventually brick your routeur...
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	6
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	7 Table of contents:
498 753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	8 0) Quick HOWTO: optimistic step-by-step instructions.
490 2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	9 1) Prerequisites: get the OpenWRT development environment ready.
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	10 2) Supplied packages: use the existing packages when possible (gnutls, ...)
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	11 3) Other dependencies: provide for additional missing dependencies (sctp ...)
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	12 4) freediameter package: now create the freeDiameter package
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	13 5) Configuration: how to set the configuration on the router.
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	14
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	15 This HOWTO will NOT cover how to install OpenWRT on your access device, nor
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	16 its basic configuration. Please refer to OpenWRT website for this type of HOWTOs.
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	17
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	18
498 753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	19 ==============================================
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	20 0) Quick HOWTO
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	21 ==============================================
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	22 The following instructions should allow you to put freeDiameter on your OpenWRT-compatible router.
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	23 In case something goes wrong, you should follow the detailed instructions in the remaining of
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	24 this file.
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	25
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	26 Be warned: playing with the software in your router may brick it, i.e. make it unusable forever.
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	27 Do it at your own risk.
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	28
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	29 1) Get the OpenWRT environment:
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	30 $ git clone git://nbd.name/openwrt.git
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	31 $ cd openwrt
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	32
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	33 2) Get the feeds
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	34 $ cp feeds.conf.default feeds.conf
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	35 $ echo "src-hg freediameter http://www.freediameter.net/hg/fD-OWRT-packages" >> feeds.conf
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	36 $ scripts/feeds update
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	37 $ scripts/feeds install freeDiameter
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	38
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	39 3) Configure your image
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	40 $ make menuconfig
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	41 (set Target System and Target Profile as needed for your equipment)
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	42
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	43 - Network --->
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	44 freeDiameter (M)
562 e837ef4bdf35 Remove local machine name from the file Sebastien Decugis <sdecugis@nict.go.jp> parents: 531 diff changeset	45 wpad (*)
e837ef4bdf35 Remove local machine name from the file Sebastien Decugis <sdecugis@nict.go.jp> parents: 531 diff changeset	46 wpad-mini ( )
498 753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	47
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	48 4) Build the image and packages, this takes a while
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	49 $ make world
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	50
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	51 5) Export the bin/* directory through a webserver.
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	52 We assume it is available at http://192.168.1.25/owrt
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	53
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	54 6) Flash the router with your new image -- THIS DESTROYS ALL CONFIG ON THE ROUTER!
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	55 $ ssh root@192.168.1.1
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	56 # cd /tmp
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	57 # wget http://192.168.1.25/owrt/openwrt-brcm47xx-squashfs.trx
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	58 ;; change the file name with yours
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	59 # mtd -r write openwrt-brcm47xx-squashfs.trx linux
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	60 ;; wait for reboot
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	61 $ telnet 192.168.1.1
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	62 # passwd
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	63 # sync
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	64
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	65 7) Update the opkg router's config to get your new packages
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	66 ssh root@192.168.1.1
562 e837ef4bdf35 Remove local machine name from the file Sebastien Decugis <sdecugis@nict.go.jp> parents: 531 diff changeset	67 # echo "src/gz localrepo http://192.168.1.25/owrt/packages" >> /etc/opkg.conf
498 753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	68 # opkg update
753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	69
531 d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	70 8) Install freeDiameter, you're done. Optionnaly, install also certtool on the router before, to
562 e837ef4bdf35 Remove local machine name from the file Sebastien Decugis <sdecugis@nict.go.jp> parents: 531 diff changeset	71 generate the TLS certificate automatically.
498 753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	72 # opkg install freeDiameter
490 2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	73
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	74 ==============================================
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	75 1) Prerequisites:
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	76 ==============================================
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	77
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	78 We will first need a working OpenWRT toolchain environment. You can retrieve
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	79 pre-compiled binaries of such toolchains ("Image builder") on the OpenWRT website. Anyway,
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	80 in case the architecture you are interested in is not listed, you can build
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	81 the full toolchain from source. This is the path we are following in this HOWTO.
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	82
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	83 a) Retrieve the latest OpenWRT source, using subversion or git.
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	84 Since I have to go through a proxy, I use the later here, svn being quite annoying with proxies.
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	85 Note, the following commands must not be run as root.
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	86 $ git clone git://nbd.name/openwrt.git
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	87 (Note: you might instead use "backfire.git" if you want to stick with an OpenWRT release.)
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	88 $ cd openwrt
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	89 $ cp feeds.conf.default feeds.conf
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	90
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	91 b) If you are using git, you have to edit the feeds.conf file to use git as well for packages.
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	92 Do the following modifications in this case:
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	93 $ vi feeds.conf
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	94 Comment out this line:
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	95 src-svn packages https://svn.openwrt.org/openwrt/packages
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	96 Add this line instead:
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	97 src-git packages git://nbd.name/packages.git
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	98
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	99 You can leave uncommented the luci (for GNUTLS) and Xwrt (webif) repositories. Since these repositories
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	100 use svn over http, you can use subversion even if you are behind a proxy.
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	101
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	102 c) Then issue the following command to update the package list:
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	103 $ scripts/feeds update
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	104
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	105 d) Now, let's already create the toolchain and basic image.
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	106 $ make menuconfig
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	107
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	108 This will open a menu for you. You must select the target you are building for.
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	109 See http://wiki.openwrt.org/toh/start for the table of hardware and associated information.
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	110 In my case, I am using a Buffalo WZR-HP-G300NH router. I therefore select these options:
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	111 - Target System --->
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	112 Atheros AR71xx/AR7240/AR913x
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	113 - Target Profile --->
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	114 Buffalo WZR-HP-G300NH
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	115
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	116 For many routeurs, the recommended kernel is a 2.4x version. I have NOT tried with such kernel,
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	117 and the SCTP support is likely to be different in this generation of kernels. I strongly recommend
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	118 to go with a 2.6x kernel, whenever possible.
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	119
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	120 e) Once configured, create the toolchain and default image (this takes a while):
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	121 $ make
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	122
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	123 After this command completes successfully, your build environment is ready.
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	124 The resulting image and packages are stored in the "bin/" subdirectory.
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	125 It is very convenient if you make this repository available in http to your routeur.
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	126
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	127 You should probably try at this early stage to flash your device with the image you have generated.
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	128 If the default basic image does not work, it is probably not worth adding new problems on top of it.
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	129
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	130 For troubleshooting, please consult OpenWRT documentation directly.
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	131 "make prereq" may help you building the initial image also.
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	132 See http://downloads.openwrt.org/docs/buildroot-documentation.html for additional information
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	133 concerning this step.
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	134
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	135 You should now be able to login on your routeur with telnet (first time) or ssh (after setting a password).
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	136
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	137 ==============================================
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	138 2) Supplied packages:
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	139 ==============================================
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	140
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	141 There are some dependencies of freeDiameter already available in the OpenWRT packages repository.
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	142 You can check for the available packages with the script:
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	143 $ ./scripts/feeds search <package>
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	144
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	145 We will now describe how to install these dependencies. At the time this HOWTO is written,
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	146 the OpenWRT repositories contain ipv6, gnutls, pthreads and hostapd. Follow these instruction to
491 6edd14e5f132 Fix SCTP support for OpenWRT, now it really works Sebastien Decugis <sdecugis@nict.go.jp> parents: 490 diff changeset	147 build them.
6edd14e5f132 Fix SCTP support for OpenWRT, now it really works Sebastien Decugis <sdecugis@nict.go.jp> parents: 490 diff changeset	148
6edd14e5f132 Fix SCTP support for OpenWRT, now it really works Sebastien Decugis <sdecugis@nict.go.jp> parents: 490 diff changeset	149 Alternatively, you can find these packages pre-compiled in the OpenWRT packages repository.
490 2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	150
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	151 a) GNU TLS packages
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	152 $ scripts/feeds install libgnutls
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	153
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	154 b) Select the following components in the menu:
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	155 $ make menuconfig
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	156 - Base system --->
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	157 libpthread (M)
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	158
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	159 - Network --->
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	160 hostapd (M)
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	161 wpad-mini ( )
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	162
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	163 - Libraries --->
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	164 SSL --->
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	165 libgnutls (M)
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	166
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	167 - Kernel modules --->
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	168 Network Support --->
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	169 kmod-ipv6 (M)
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	170
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	171 Quit and save the new config, then:
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	172 $ make world
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	173
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	174 This will add a bunch of modules in your bin directory that will be required for freeDiameter.
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	175 Since we are removing the wpad-mini daemon from the base image, this image (trx or bin file) is also recompiled.
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	176
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	177 Note that if you are setting your device as WPA supplicant also (wireless client), you can select wpad instead of hostapd.
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	178 (in any case, the -mini version is not suitable since we will use the RADIUS authentication).
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	179
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	180
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	181 You should now reflash your routeur with the new firmware image. The simplest way to achieve if your routeur has enough
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	182 flash memory is to:
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	183 - copy the new trx image to your routeur's /tmp (using wget or scp)
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	184 - run this command (on the device) -- replace <newfile.trx> with your actual filename:
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	185 root@OpenWrt:~# mtd -r write <newfile.trx> linux
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	186
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	187 WARNING: this will erase your existing configuration on the routeur.
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	188 In case you need to save it, you may try the sysupgrade command instead.
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	189
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	190 This will reboot the device after writing the new image file.
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	191 Afterwards, if you have set up the http server on your development machine properly
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	192 (let's assume it has IP address 192.168.1.25)
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	193 you can run the following command on your router:
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	194 root@OpenWrt:~# echo "src/gz mydev http://192.168.1.25/packages" >> /etc/opkg.conf
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	195 root@OpenWrt:~# opkg update
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	196
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	197 Install the newly compiled packages with:
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	198 root@OpenWrt:~# opkg install kmod-ipv6 hostapd libpthread
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	199
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	200 ==============================================
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	201 3) Missing packages:
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	202 ==============================================
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	203
531 d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	204 UPDATE: Starting from revision r22917, sctp and kmod-sctp are included in the OpenWRT distribution, and have been removed
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	205 from freeDiameter package. One may consider using a freeDiameter package prior to 2010/09/05 in order to get the sctp
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	206 package, or a more recent OpenWRT environment.
490 2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	207
531 d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	208 PREVIOUS SITUATION: If you are using components prior to 2010/09/05, the following applies:
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	209 P:
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	210 P: There are other dependencies for freeDiameter that are not provided by OpenWRT packages.
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	211 P: For convenience, we include these meta-packages in the freeDiameter distribution -- but they
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	212 P: might not be up-to-date.
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	213 P:
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	214 P: a) Adding the contributed directory to the feeds
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	215 P: Add the following line in your feeds.conf file:
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	216 P: src-link freediameter /path/to/freediameter/contrib/OpenWRT/packages/
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	217 P:
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	218 P: Then run:
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	219 P: $ scripts/feeds update
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	220 P:
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	221 P: This should allow you to install the missing dependencies as follow:
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	222 P:
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	223 P:
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	224 P: b) SCTP library (note: you might alternatively compile freeDiameter without SCTP support).
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	225 P: $ scripts/feeds install sctp
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	226 P:
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	227 P:
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	228 P: c) Select these components in the menu:
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	229 P: $ make menuconfig
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	230 P: - Libraries --->
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	231 P: sctp (M)
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	232 P:
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	233 P: Quit and save the new config, then:
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	234 P: $ make world
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	235 P:
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	236 P:
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	237 P: d) Install this on the router as well:
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	238 P: root@OpenWrt:~# opkg update
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	239 P: root@OpenWrt:~# opkg install sctp
490 2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	240
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	241
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	242 ==============================================
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	243 4) freediameter package:
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	244 ==============================================
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	245
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	246 Now, your environment should be ready to compile the freeDiameter ipkg package.
498 753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	247 $ scripts/feeds install freeDiameter
490 2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	248
498 753c9ed8f19a Initial working freeDiameter package Sebastien Decugis <sdecugis@nict.go.jp> parents: 491 diff changeset	249 Note that in order to build this package, you need to have cmake & flex on your compilation machine.
490 2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	250
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	251 $ make menuconfig
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	252 - Network --->
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	253 freeDiameter (M)
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	254
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	255 Quit and save the new config, then:
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	256 $ make world
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	257
531 d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	258 On your router, run:
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	259 # opkg update
d1cb0dadc22d SCTP support added upstream in OpenWRT: r22917 in openwrt, r22912 in packages Sebastien Decugis <sdecugis@nict.go.jp> parents: 498 diff changeset	260 # opkg install freeDiameter
490 2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	261
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	262
2577514b2546 Updated documentation (still incomplete) Sebastien Decugis <sdecugis@nict.go.jp> parents: 327 diff changeset	263

Mercurial > hg > freeDiameter

annotate contrib/OpenWRT/HOWTO @ 562:e837ef4bdf35