Navigation


Changeset 325:5133b45e3305 in freeDiameter


Ignore:
Timestamp:
May 20, 2010, 2:23:11 PM (14 years ago)
Author:
Sebastien Decugis <sdecugis@nict.go.jp>
Branch:
default
Phase:
public
Message:

Updated documentation

Files:
3 edited

Legend:

Unmodified
Added
Removed
  • INSTALL

    r304 r325  
    88# make
    99
    10 Note: instead of passing options on the command line, you can use a CMake front-end (for example ccmake or cmake-gui)
    11 or edit the CCmakeCache.txt file directly. If your cmake installation is recent, you can also do:
     10You can pass options to instruct cmake about which components to compile on the command-line.
     11You can also use a CMake front-end (for example ccmake or cmake-gui) or edit the CCmakeCache.txt file directly.
     12If your cmake installation is recent, the edit_cache target is a good help as well:
    1213# mkdir build
    1314# cd build
    1415# cmake ../
     16# make help
    1517# make edit_cache
    1618# make
    1719
    18 
    19 You can enable the unary tests by doing:
     20You can enable the unit tests by doing:
    2021# cmake -DSKIP_TESTS:BOOL=OFF ../
    2122# make
     
    2324
    2425Note that there are dependencies on external tools that may not be enforced by the configure script.
    25 See the specific INSTALL.distro files matching your situation.
    26 
    27 You can configure which extensions to build with CMake:
    28 IGNORE_ALL_EXTENSIONS:BOOL=OFF    (or the following are ignored)
    29 BUILD_SAMPLE:BOOL=ON
    30 BUILD_DICT_NASREQ:BOOL=ON
    31 BUILD_APP_RADGW:BOOL=ON
    32 ...
    33 
    34 You can change the default configuration file pathname:
    35 DEFAULT_CONF_FILE:STRING=/path/to/some/freeDiameter.conf
    36 
    37 Build binary with symbols, for debug:
    38 CMAKE_BUILD_TYPE:STRING=Debug
     26See the specific INSTALL.* files for additional information.
  • INSTALL.Ubuntu

    r320 r325  
    11See INSTALL file for general instructions on building freeDiameter.
    22
    3 On Ubuntu / Debian, the following packages are required (aptitude install ...):
     3
     4freeDiameter has native support for Debian packaging. All related files
     5are in the directory "debian" of the distribution.
     6
     7The following packages are required to compile freeDiameter from source:
    48 cmake make gcc flex bison libsctp1 libsctp-dev libgnutls-dev libgcrypt-dev
    59 
     
    913In order to build app_acct extension, you will also need the package libpq-dev.
    1014
    11 Tested not working: Ubuntu Hardy (too old).
    12 Tested working: Ubuntu Intrepid, Jaunty, Karmic, Lucid. Debian Lenny.
     15
     16If your debhelper environment is recent, the following commands should
     17generate the freeDiameter packages for you:
     18
     19# Install the dependencies for building the source:
     20sudo apt-get -y install mercurial cmake make gcc bison flex libsctp-dev libgnutls-dev libgcrypt-dev libpq-dev ssl-cert debhelper fakeroot
     21
     22# Retrieve the latest version of the source package
     23cd
     24hg clone http://aaa.koganei.wide.ad.jp/hg/freeDiameter
     25cd freeDiameter
     26
     27# Build the packages
     28fakeroot dh binary
     29
     30# Install the packages
     31cd ..
     32sudo dpkg -i *.deb
     33
     34
     35# The following lines may help you getting started.... (execute as root)
     36ln -s /etc/ssl/certs/ssl-cert-snakeoil.pem /etc/ssl/certs/freeDiameter.pem
     37ln -s /etc/ssl/private/ssl-cert-snakeoil.key /etc/ssl/private/freeDiameter.key
     38zcat /usr/share/doc/freediameter-daemon/examples/freediameter.conf.sample.gz > /etc/freeDiameter/freeDiameter.conf
     39echo "Identity=\"localhost.localdomain\";" >> /etc/freeDiameter/freeDiameter.conf
     40freeDiameterd
     41
     42===========================================
     43
     44freeDiameter has been tested on the following distributions:
     45Ubuntu Intrepid, Jaunty, Karmic, Lucid.
     46Debian Lenny.
     47
     48(Ubuntu Hardy support is broken)
    1349
    1450
    1551===========================================-
    16 Step by step instructions (with no prerequisite):
     52Step by step instructions without using the debhelper tools:
    1753
    18541) Install all packages dependencies
    19 # apt-get install mercurial cmake make gcc bison flex libsctp-dev libgnutls-dev libgcrypt-dev
     55# sudo apt-get install mercurial cmake make gcc bison flex libsctp-dev libgnutls-dev libgcrypt-dev
    2056
    21572) (OPTION) If you will compile modules that require postgresql, also install:
    22 # apt-get install libpq-dev
     58# sudo apt-get install libpq-dev
    2359
    24603) (OPTION) If you want a more user-friendly interface, install this:
    25 # apt-get install cmake-curses-gui
     61# sudo apt-get install cmake-curses-gui
    2662
    27634) Retrieve the source files
     
    3369
    34706) Configure and generate the Makefiles
    35  a) If you did not install ccmake in step 3:
    3671# cmake ../freeDiameter
    37 
    38  b) If you did install ccmake:
    39 # ccmake ../freeDiameter
    40 - press 'c' (configure)
    41 - toggle the values as needed (ex: BUILD_APP_RADGW=ON, ...)
    42 - press 'c' again. New items may appear, iterate the process
    43 - press 'c' and 'g' to complete the process
     72# make edit_cache
    4473
    45747) Compile all files:
    4675# make
    4776
    48 8) See available targets:
     778) (OPTION) See available targets:
    4978# make help
    5079
     
    5281# make test
    5382
     8310) Install the software in configured locations:
     84# sudo make install
     85
    5486
    5587===========================================
    5688
    57 # You can alternatively do:
    58 apt-get -y install mercurial cmake make gcc bison flex libsctp-dev libgnutls-dev libgcrypt-dev libpq-dev ssl-cert debhelper
    59 cd /usr/src
    60 hg clone http://aaa.koganei.wide.ad.jp/hg/freeDiameter
    61 cd freeDiameter
    62 dh binary
    63 
    64 cd ..
    65 dpkg -i *.deb
    66 
    67 ln -s /etc/ssl/certs/ssl-cert-snakeoil.pem /etc/ssl/certs/freeDiameter.pem
    68 ln -s /etc/ssl/private/ssl-cert-snakeoil.key /etc/ssl/private/freeDiameter.key
    69 zcat /usr/share/doc/freediameter-daemon/examples/freediameter.conf.sample.gz > /etc/freeDiameter/freeDiameter.conf
    70 echo "Identity=\"localhost.localdomain\";" >> /etc/freeDiameter/freeDiameter.conf
    71 freeDiameterd
  • README

    r74 r325  
    1 The freeDiameter daemon implements the Diameter base protocol.
    2 Loadable extensions add the logic of Diameter applications and advanced use of the daemon.
     1freeDiameter is an implementation of Diameter.
     2
     3Diameter is a protocol designed to carry Authentication, Authorization and
     4Accounting (AAA) payload. It is an evolution of the RADIUS protocol (as the
     5name suggests).
     6
     7Diameter is an extensible protocol. RFC3588 (currently under revision) defines the
     8Base Protocol that all Diameter nodes must support, while other documents define
     9the additional protocol support for specific applications. Such applications include
     10for example Network Access Servers (RFC4005), EAP (RFC4072), ...
     11
     12
     13The implementation consists in several components:
     14 - libfreeDiameter : the shared library provides the functions to manipulate Diameter
     15      messages and dictionary. This library is meant to be re-used for other projects
     16      that would require parsing or manipulating Diameter messages.
     17     
     18 - freeDiameterd : the daemon establishes the network connections with other Diameter
     19      peers and performs the tasks described in Diameter Base Protocol, such as
     20      watchdogs, basic routing, ...
     21     
     22 - extensions : the extensions provide the mean to augment the features of the
     23      freeDiameterd daemon. Extensions can provide the handling of a Diameter
     24      application, but also advanced routing features, peer management, etc.
     25
     26
    327See http://aaa.koganei.wide.ad.jp/ for more information on the project.
     28
    429freeDiameter was previously known as the "waaad" project (WIDE AAA Daemon)
    530
     
    1136
    1237See INSTALL for information on building and using this software.
    13 
    14 --------------
    15 Known possible bugs:
    16  - management of the Host-IP-Address values in CER/CEA may be strange (for TCP and SCTP)
    17  
Note: See TracChangeset for help on using the changeset viewer.