]> git.defcon.no Git - hermes/blob - doc/README
Added doc/ directory for documentation et.al.
[hermes] / doc / README
1 ABOUT HERMES
2 -------------------------
3
4 Hermes is a framework for managing a Kamailio SIP VoIP infrastructure. It is
5 designed to manage user accounts, SIP aliases, E164 phone number aliases and
6 automatic provisioning of hardphones. Hermes provides an API as a foundation
7 for its own user interface, and for integration with other systems. The API is
8 implemented as HTTP-REST using JSON. The user interface focuses on dayly
9 administration tasks (user management, alias handling, phone registration) and
10 not on Kamailio server management.
11
12
13 CONFIGURING THE FRONTEND/UI
14 -------------------------
15 TBD
16
17 CONFIGURING THE API
18 -------------------------
19
20 The API needs to be configured separately from the UI.
21 API configuration is done by creating the PHP file
22 $install_path/api/config.php. A sample configuration file
23 is provided as $install_path/api/config.php.sample.
24 If config.php is not present, the API may fail in
25 in somewhat unpredictable ways ...
26
27 sql_server -> Your MySQL server ...
28 sql_username -> Username for MySQL access
29 Needs RW access to kamailio and provision db's
30 sql_password -> Password for the above username
31 kamailio_db -> Database name of kamailio db.
32 provision_db -> Database name of provision db.
33
34 standard_dialplan -> Dialling pattern to use for new users
35 default_domain -> What domain should always be listed first
36 permit_multiple_e164alias -> Currently not used ...
37
38 The following configuration options define SQL table names
39 for respective data-sets, values for the sample-data.sql
40 are listed... :
41
42 kamailio_domain_table (domain)
43 kamailio_subscriber_table (subscriber)
44 kamailio_alias_table (dbaliases)
45 provision_users_table (users)
46 provision_phones_table (phones)
47 provision_servers_table (servers)
48 numbers_table (numbers)
49