Sip settings

Version 26 (Adrian Georgescu, 07/13/2010 02:59 pm)

1 19 Adrian Georgescu
== sip-settings ==
2 1 Adrian Georgescu
3 22 Adrian Georgescu
[[TOC(SipTesting*, sip_*, xcap_*, depth=2)]]
4 1 Adrian Georgescu
5 23 Adrian Georgescu
> This script is available in ''sipclients'' package that must be installed separately from SIP SIMPLE client SDK package.
6 20 Adrian Georgescu
7 1 Adrian Georgescu
=== Description ===
8 1 Adrian Georgescu
9 24 Adrian Georgescu
Manages the [wiki:SipConfigurationAPI configuration] used by the middleware and Command Line Tools. 
10 1 Adrian Georgescu
11 1 Adrian Georgescu
{{{
12 19 Adrian Georgescu
adigeo@ag-imac3:~$sip-settings 
13 19 Adrian Georgescu
Usage: sip-settings [--general|--account] [options] command [arguments]
14 19 Adrian Georgescu
       sip-settings --general show
15 19 Adrian Georgescu
       sip-settings --general set key1=value1 [key2=value2 ...]
16 19 Adrian Georgescu
       sip-settings --account list
17 19 Adrian Georgescu
       sip-settings --account add user@domain password
18 19 Adrian Georgescu
       sip-settings --account delete user@domain|ALL
19 19 Adrian Georgescu
       sip-settings --account show [user@domain|ALL]
20 19 Adrian Georgescu
       sip-settings --account set [user@domain|ALL] key1=value1|DEFAULT
21 19 Adrian Georgescu
       sip-settings --account default user@domain
22 1 Adrian Georgescu
23 1 Adrian Georgescu
This script is used to manage the SIP SIMPLE middleware settings.
24 1 Adrian Georgescu
25 10 Adrian Georgescu
Options:
26 16 Adrian Georgescu
  -h, --help            show this help message and exit
27 16 Adrian Georgescu
  -c FILE, --config-file=FILE
28 16 Adrian Georgescu
                        The path to a configuration file to use. This
29 16 Adrian Georgescu
                        overrides the default location of the configuration
30 16 Adrian Georgescu
                        file.
31 16 Adrian Georgescu
  -a, --account         Manage SIP accounts' settings
32 16 Adrian Georgescu
  -g, --general         Manage general SIP SIMPLE middleware settings
33 1 Adrian Georgescu
}}}
34 9 Adrian Georgescu
35 9 Adrian Georgescu
To use the command line tools you must create at least one SIP account:
36 9 Adrian Georgescu
37 9 Adrian Georgescu
{{{
38 19 Adrian Georgescu
sip-settings --account add user@domain password
39 1 Adrian Georgescu
}}}
40 25 Adrian Georgescu
]
41 25 Adrian Georgescu
42 26 Adrian Georgescu
You can make an account the default account for outgoing calls with:
43 25 Adrian Georgescu
44 25 Adrian Georgescu
{{{
45 25 Adrian Georgescu
sip-settings -a default user@domain
46 25 Adrian Georgescu
}}}
47 25 Adrian Georgescu
48 26 Adrian Georgescu
Individual settings for the account can be set with:
49 25 Adrian Georgescu
50 25 Adrian Georgescu
{{{
51 25 Adrian Georgescu
sip-settings -a set user@domain key=value
52 25 Adrian Georgescu
}}}
53 25 Adrian Georgescu
54 25 Adrian Georgescu
To see which per account settings are available, use:
55 25 Adrian Georgescu
56 25 Adrian Georgescu
{{{
57 25 Adrian Georgescu
sip-settings -a show
58 25 Adrian Georgescu
}}}
59 25 Adrian Georgescu
60 25 Adrian Georgescu
The settings are organized in a hierarchy. Use dotted notation for the keys. 
61 25 Adrian Georgescu
For instance, the outbound_proxy setting in the sip group is written 
62 25 Adrian Georgescu
sip.outbound_proxy. Use the dotted form in the command-line:
63 25 Adrian Georgescu
64 25 Adrian Georgescu
{{{
65 25 Adrian Georgescu
sip-settings -a set user@domain sip,outbound_proxy=proxy.sipthor.net
66 25 Adrian Georgescu
}}}
67 25 Adrian Georgescu
68 25 Adrian Georgescu
Global settings are arranged the same way; for instance, to change the global 
69 25 Adrian Georgescu
outbound ringtone:
70 25 Adrian Georgescu
71 25 Adrian Georgescu
{{{
72 25 Adrian Georgescu
sip-settings -g set sounds.audio_outbound=/path/to/wav
73 25 Adrian Georgescu
}}}