annotate contrib/README @ 474:e8c1ff19705e

Updated information
author Sebastien Decugis <sdecugis@nict.go.jp>
date Fri, 06 Aug 2010 16:50:42 +0900
parents 90294e7e986c
children e9c0bdedf2eb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
327
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
1 This file describes the content of the "contrib" directory.
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
2 For information about the freeDiameter project, please refer
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
3 to top-level README file.
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
4
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
5 - update_copyright.sh : This script will simply update the copyright information
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
6 in all source files in the freeDiameter mercurial repository, based
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
7 on the last modification time. Thought I might share it if other people find
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
8 it useful for their own project...
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
9
328
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 327
diff changeset
10
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 327
diff changeset
11 - debian : This directory contains the packaging information to create native Debian / Ubuntu
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 327
diff changeset
12 packages. It requires debhelper >= 7.3.9 (support for cmake). To use, simply link the
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 327
diff changeset
13 debian folder from the main freeDiameter folder, then use your building script as
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 327
diff changeset
14 usual ('dh binary' or 'pdebuild' or ...).
474
e8c1ff19705e Updated information
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 328
diff changeset
15 If you simply intend to use freeDiameter package, the relevant information is located
e8c1ff19705e Updated information
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 328
diff changeset
16 at: http://www.freediameter.net/trac/wiki/DebRepository
328
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 327
diff changeset
17
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 327
diff changeset
18
327
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
19 - PKI : This directory contains useful material related to establishing a
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
20 Public Key Infrastructure (PKI) for deploying x509 certificates
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
21 and use these for TLS authentication of the freeDiameter nodes.
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
22
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
23 IMPORTANT: Please note that these solutions are NOT suitable
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
24 for use in a production environment! It allows easy deployment of
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
25 certificates for tests, and that is their sole purpose.
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
26
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
27 The directory contains:
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
28
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
29 - ca_script: a simple Makefile allowing you to generate a self-signed certificate (root)
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
30 and then issue new certificates and private keys for your users.
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
31 Run "make" without argument to get the help.
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
32
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
33 - ca_script2: An evolution of the previous Makefile. This one allows you
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
34 to create a hierarchy of CA and certificates.
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
35
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
36 - phpki-0.82.patch : This patch is to be applied to PHPki to customize the use for freeDiameter.
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
37 PHPki (http://sourceforge.net/projects/phpki/) is a PHP-based web interface
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
38 that provides more or less the same services as ca_script.
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
39
328
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 327
diff changeset
40
327
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
41 - OpenWRT : This directory contains the scripts and documentation related to
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
42 the integration of freeDiameter RADIUS/Diameter gateway component in the openWRT
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
43 distribution (http://openwrt.org) -- the goal is to give the access point the
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
44 ability to "talk" Diameter instead of RADIUS.
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
45
474
e8c1ff19705e Updated information
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 328
diff changeset
46
e8c1ff19705e Updated information
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 328
diff changeset
47 - nightly_tests : This directory contains the scripts and documentation for the nightly
e8c1ff19705e Updated information
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 328
diff changeset
48 tests run on freeDiameter. The results are published at the following URL:
e8c1ff19705e Updated information
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 328
diff changeset
49 http://www.freediameter.net/CDash/index.php?project=freeDiameter
e8c1ff19705e Updated information
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 328
diff changeset
50
"Welcome to our mercurial repository"