Navigation

Changeset 660:a8269458d5b1 in freeDiameter


Ignore:
Timestamp:
Jan 14, 2011, 4:25:59 PM (13 years ago)
Author:
Sebastien Decugis <sdecugis@nict.go.jp>
Branch:
default
Phase:
public
Message:

Updated documentation

Files:
9 edited

Legend:

Unmodified
Added
Removed

  • INSTALL

    r643 r660  
    3232# make
    3333
    34 When the tests are not disabled, you can run them with:
     34When the tests are enabled, you can run them with:
    3535# make tests
    3636

  • INSTALL.FreeBSD

    r643 r660  
    2626    # make install
    2727   
    28  b) or from package (don't forget to set your PACKAGEROOT appropriately: set PACKAGEROOT=ftp://ftp.jp.freebsd.org):
     28 b) or from package (don't forget to set your PACKAGEROOT appropriately. Ex: set PACKAGEROOT=ftp://ftp.jp.freebsd.org):
    2929    # pkg_add -v -r cmake
    3030       
    … …  
    9696   
    97974) run the test
    98   # freeDiameter/tests/testappacct -d
     98  # tests/testappacct -d
    9999  or
    100100  # make test

  • INSTALL.Ubuntu

    r643 r660  
    7373freeDiameter has been tested on the following distributions (compiled from source as described bellow):
    7474Ubuntu Intrepid, Jaunty, Karmic, Lucid, Maverick, Natty.
    75 Debian Lenny.
     75Debian Lenny (with small patch, see ticket #24).
    7676
    7777Ubuntu Hardy support is known to be broken.

  • LICENSE

    r461 r660  
    33Software License Agreement (BSD License)
    44
    5 Copyright (c) 2009, WIDE Project and NICT
     5Copyright (c) 2008-2011, WIDE Project and NICT
    66All rights reserved.
    77
    … …  
    3535
    3636
    37 The following files have been contributed by Alexandre Westfahl, see source files for copyright information:
     37The following authors have contributed the following files. See source files for copyright information.
     38
     39 * Alexandre Westfahl:
    3840  extensions/dict_sip/*
    3941  extensions/app_sip/*
    4042  extensions/app_radgw/rgwx_sip.c
    4143
    42 The following files have been contributed by Souheil Ben Ayed, see source files for copyright information:
    43    extensions/app_diameap/*
     44 * Souheil Ben Ayed:
     45  extensions/app_diameap/*
    4446
     47 * Francois Bard:
     48  extensions/dict_mip6a/*
     49  extensions/dict_mip6i/*
     50  extensions/dict_nas_mipv6/*
     51  extensions/dict_rfc5777/*

  • README

    r335 r660  
    1212
    1313The 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
     14 - libfdproto : this shared library provides the functions to manipulate Diameter
     15      messages and dictionary. This library is meant to be re-used by other projects
    1616      that would require parsing or manipulating Diameter messages.
    1717     
    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, ...
     18 - libfdcore : this shared library contains the core of the framework. It establishes
     19      the network connections with other Diameter peers and performs the tasks described
     20      in Diameter Base Protocol, such as watchdogs, basic routing, ... It also handles
     21      the loading of extensions (see bellow).
     22     
     23 - freeDiameterd : this simple daemon parses the command line and initializes the
     24      freeDiameter framework. Use it for your Diameter server & agent components.
     25      In case of Diameter clients, you probably will prefer linking the libfdcore
     26      directly with your client application that must be made Diameter-aware.
    2127     
    2228 - 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.
     29      freeDiameterd framework. Extensions can provide the handling of a Diameter
     30      server application, but also advanced routing features, peer management, etc.
    2531
    2632

  • contrib/OpenWRT/packages/freeDiameter/Makefile

    r580 r660  
    1111
    1212PKG_NAME:=freeDiameter
    13 PKG_REV:=578
     13PKG_REV:=660
    1414PKG_VERSION:=r$(PKG_REV)
    1515PKG_RELEASE:=1

  • contrib/debian/changelog

    r654 r660  
     1freediameter (1.1.0) UNRELEASED; urgency=low
     2
     3  * Source package restructured. Most of the
     4    framework now contained in the libfdcore library.
     5    libfreeDiameter renamed as libfdproto.
     6    This closes #15.
     7  * API version bumped to version 4 accordingly.
     8  * Improved fd_dict_new() when the same object already exists.
     9  * Improvements to dict_legacy_xml extension.
     10
     11 -- Sebastien Decugis <sdecugis@nict.go.jp>  Fri, 14 Jan 2011 16:04:41 +0900
     12
    113freediameter (1.0.4) UNRELEASED; urgency=low
    214

  • contrib/debian/control

    r658 r660  
    1414Depends: ${shlibs:Depends}, ${misc:Depends}
    1515Description: The freeDiameter libraries.
    16  This package contains the libraries required by all freeDiameter components.
     16 This package contains the freeDiameter framework core libraries,
     17 required by all freeDiameter components.
    1718 It may also be useful for other projects which need to
    1819 perform operations on Diameter messages.
    1920 .
     21 The freeDiameter framework provides support for the Diameter
     22 Base Protocol. Without any extension, the framework can only
     23 be used as a Diameter routing agent. You probably want to
     24 install some freeDiameter extension(s) to extend its
     25 features, and also the freediameter-daemon package that
     26 will initialize the framework for you.
     27 .
    2028 See 'freeDiameter-dev' package to retrieve the API for the library.
    2129
    … …  
    2331Architecture: any
    2432Section: contrib/devel
    25 Depends: freediameter-daemon (= ${binary:Version}), libsctp-dev, libgnutls-dev, libgcrypt-dev
     33Depends: freediameter-common (= ${binary:Version}), libsctp-dev, libgnutls-dev, libgcrypt-dev
    2634Description: This package provides the development files for freeDiameter.
    2735
    … …  
    3240  freediameter-dictionary-mip6, freediameter-dictionary-legacy
    3341Description: The freeDiameter daemon.
    34  The freeDiameter daemon provides support for the Diameter
    35  Base Protocol. Without any extension, the daemon can only
    36  be used as a Diameter routing agent. You probably want to
    37  install some freeDiameter extension(s) to extend its
    38  features.
    39  .
    40  The daemon is shipped with a small set of extensions, for
     42 This daemon is a simple loader for the freeDiameter framework.
     43 It is shipped with a small set of extensions, for
    4144 example to configure the routing behavior. See the
    42  examples for more details.
     45 examples in /usr/share/freediameter* for more details.
    4346
    4447Package: freediameter-debug-tools
    4548Architecture: any
    4649Section: contrib/debug
    47 Depends: ${misc:Depends}, freediameter-daemon (= ${binary:Version})
     50Depends: ${misc:Depends}, freediameter-common (= ${binary:Version})
    4851Suggests: python, libmysqlclient16
    4952Description: freeDiameter debug tools.
    … …  
    5558Package: freediameter-dictionary-rfc4005
    5659Architecture: any
    57 Depends: ${misc:Depends}, freediameter-daemon (= ${binary:Version})
     60Depends: ${misc:Depends}, freediameter-common (= ${binary:Version})
    5861Description: RFC4005 (NASREQ) dictionary support.
    5962 This freeDiameter extension provides the dictionary support
    … …  
    6871Package: freediameter-dictionary-rfc4072
    6972Architecture: any
    70 Depends: ${misc:Depends}, freediameter-dictionary-rfc4005 (= ${binary:Version})
     73Depends: ${misc:Depends}, freediameter-common (= ${binary:Version}), freediameter-dictionary-rfc4005 (= ${binary:Version})
    7174Description: RFC4072 (Diameter EAP) dictionary support.
    7275 This freeDiameter extension provides the dictionary support
    … …  
    8184Package: freediameter-dictionary-rfc4740
    8285Architecture: any
    83 Depends: ${misc:Depends}
     86Depends: ${misc:Depends}, freediameter-common (= ${binary:Version})
    8487Description: RFC4740 (Diameter SIP) dictionary support.
    8588 This freeDiameter extension provides the dictionary support
    … …  
    9497Package: freediameter-dictionary-mip6
    9598Architecture: any
    96 Depends: ${misc:Depends}
     99Depends: ${misc:Depends}, freediameter-common (= ${binary:Version})
    97100Description: Diameter Mobile IPv6 application dictionary support.
    98101 This package contains a set of extensions to provide the support
    … …  
    109112Package: freediameter-dictionary-legacy
    110113Architecture: any
    111 Depends: ${misc:Depends}, libxml2
     114Depends: ${misc:Depends}, freediameter-common (= ${binary:Version}), libxml2
    112115Description: Legacy XML dictionary files support.
    113116 This freeDiameter extension allows the use of XML dictionary
    … …  
    126129Package: freediameter-radius-gateway
    127130Architecture: any
    128 Depends: ${misc:Depends}, freediameter-daemon (= ${binary:Version}), freediameter-dictionary-rfc4072 (= ${binary:Version}), freediameter-dictionary-rfc4740 (= ${binary:Version})
     131Depends: ${misc:Depends}, freediameter-common (= ${binary:Version})
     132Suggests: freediameter-dictionary-rfc4072 (= ${binary:Version}), freediameter-dictionary-rfc4740 (= ${binary:Version})
    129133Description: RADIUS/Diameter extensible gateway.
    130134 This freeDiameter extension implements a RADIUS to Diameter
    … …  
    141145                Requests For Comments: RADIUS: 2865, 3162, 2868,
    142146                2869, 3579; Diameter: 4005, 4072.
     147                Requires freediameter-dictionary-rfc4072.
    143148  - sip.rgwx  : Convert Access-Request to Diameter SIP messages.
    144149                Requests For Comments: Diameter: 4740.
     150                Requires freediameter-dictionary-rfc4740.
    145151  - acct.rgwx : Converts Accounting-Request (2866) to Diameter
    146152                ACR (3588).
     153                Requires freediameter-dictionary-rfc4072.
    147154 .
    148155 In order to use this extension, your main freeDiameter
    … …  
    155162Package: freediameter-accounting-server
    156163Architecture: any
    157 Depends: ${misc:Depends}, freediameter-daemon (= ${binary:Version}), libpq5
     164Depends: ${misc:Depends}, freediameter-common (= ${binary:Version}), libpq5
    158165Suggests: freediameter-dictionary-rfc4072
    159166Description: freeDiameter simple Accounting server.
    … …  
    175182Package: freediameter-eap-server
    176183Architecture: any
    177 Depends: ${misc:Depends}, freediameter-daemon (= ${binary:Version}), libmysqlclient16, freediameter-dictionary-rfc4072 (= ${binary:Version})
     184Depends: ${misc:Depends}, freediameter-common (= ${binary:Version}), libmysqlclient16, freediameter-dictionary-rfc4072 (= ${binary:Version})
    178185Description: freeDiameter Diameter EAP server implementation.
    179186 This freeDiameter extension implements a Diameter EAP server.
    … …  
    190197Package: freediameter-sip-server
    191198Architecture: any
    192 Depends: ${misc:Depends}, freediameter-daemon (= ${binary:Version}), libmysqlclient16, freediameter-dictionary-rfc4740 (= ${binary:Version})
     199Depends: ${misc:Depends}, freediameter-common (= ${binary:Version}), libmysqlclient16, freediameter-dictionary-rfc4740 (= ${binary:Version})
    193200Description: freeDiameter Diameter SIP server implementation.
    194  This freeDiameter extension implements a Diameter SIP server.
     201 This freeDiameter extension implements a prototype
     202 Diameter SIP server.
    195203 See http://www.freediameter.net/trac/wiki/app_sip.fdx for
    196204 status information.

  • contrib/debian/copyright

    r335 r660  
    55
    66Files: *
    7 Copyright: 2008-2010, WIDE Project and NICT.
     7Copyright: 2008-2011, WIDE Project and NICT.
    88License: BSD
    99 Redistribution and use of this software in source and binary forms, with or without modification, are
Note: See TracChangeset for help on using the changeset viewer.