add documentation

This commit is contained in:
Simon Morlat 2016-08-12 18:02:37 +02:00
parent 6f86bc95c7
commit 6cf8e8c547
2 changed files with 57 additions and 12 deletions

View file

@ -1,4 +1,12 @@
[app] [app]
#Hide in the assistant the button to configure an external SIP account.
hide_assistant_custom_account=0
#Hide in the assistant the button to create a new SIP account
hide_assistant_create_account=0
#contact_display_username_only=1 #contact_display_username_only=1
#contact_filter_on_default_domain=1 #contact_filter_on_default_domain=1
#debug_popup_magic=**00** #debug_popup_magic=**00**
@ -11,15 +19,42 @@ publish_presence=0
password_length=-1 password_length=-1
username_length=-1 username_length=-1
[in_app_purchase]
#set to 1 if in-app purchases are to be shown in the application
enabled=1
#specify here the id of the sip account in-app purchase service to be shown in the shop section of the app
paid_account_id=sipAccount_12m
#the url of the inapp/account management server, for submitting the receipt and validating the account.
receipt_validation_url=https://www.linphone.org/inapp.php
#for future use, to specify the full list of paying services to show in the shop view
products_list=sipAccount_12m
#minimum period of time between notifications to the user about his expiring/expired account, in seconds.
expiry_check_period=30
#period of time before account expiry, to start notifying the user about expiration arriving, in seconds.
warn_before_expiry_period=160
#for test only, simulate an account expiry after the specified number of seconds
expiry_time_test=180
[sip]
sip_random_port=0
[misc] [misc]
#by default it is set to 30 by liblinphone #by default it is set to 30 by liblinphone
history_max_size=-1 history_max_size=-1
[sip] #whether SIP passwords are to be encrypted in configuration storage file
sip_random_port=0
store_ha1_passwd=0 store_ha1_passwd=0
#handle_content_encoding=none #handle_content_encoding=none
[sound] [sound]
dtmf_player_amp=0.007 dtmf_player_amp=0.007
echocancellation=0 echocancellation=0
@ -29,13 +64,3 @@ ringer_dev_id=AQ: Audio Queue Device
[video] [video]
display_filter_auto_rotate=0 display_filter_auto_rotate=0
[in_app_purchase]
enabled=1
paid_account_id=sipAccount_12m
receipt_validation_url=https://www.linphone.org/inapp.php
products_list=sipAccount_12m
expiry_check_period=30
warn_before_expiry_period=160
expiry_time_test=180

20
doc/CUSTOMIZING.txt Normal file
View file

@ -0,0 +1,20 @@
# Assistant configuration
The assistant allows to create a new sip account on a pre-defined SIP service using an xml-rpc connection,
as well as configuring an existing SIP account.
The files Resources/assistant_linphone_create.rc and Resources/assistant_linphone_existing.rc contain the
information necessary to create and configure the SIP accounts, most notabily:
* proxy_default_values/reg_identity to define the SIP identity
* sip/rls_uri to define the SIP URI of the presence server
* assistant/domain to specify the SIP domain
* assistant/xmlrpc_url to specify the https url of the account creation service
# In-app purchase configuration
The Resources/linphonerc.factory, section [in_app_purchase] is the entry point for configuring
the in-app purchases available in the application, as well as parameters for account expiry notifications.
Refer to the inlined comments in this configuration for description of all configurables.