diff --git a/modules/http_client/doc/http_client_admin.xml b/modules/http_client/doc/http_client_admin.xml index adb22cadf11..bcb53352f84 100644 --- a/modules/http_client/doc/http_client_admin.xml +++ b/modules/http_client/doc/http_client_admin.xml @@ -28,6 +28,11 @@ connection definition. + The connections can either be defined with the "httpcon" module parameter + or in a separate configuration file, as specified by the "config_file" module + parameter. + + Like in SIP, the HTTP URL may need encoding to be transported safely over the network. Check the string encoding functions in the Transformation Cookbook (as used in the http_client_query example below). @@ -353,6 +358,52 @@ modparam("http_client", "httpcon", "apione=>http://atlanta.example.com") modparam("http_client", "httpcon", "apitwo=>http://atlanta.example.com/api/12") modparam("http_client", "httpcon", "apithree=>http://annabella:mysecret@atlanta.example.com/api/12") modparam("http_client", "httpcon", "apifour=>http://stockholm.example.com/api/getstuff;timeout=12") +... + + + +
+ <varname>config_file</varname> (string) + + The file name of a configuration file containing definitions + of http connections. This is an alternative to the + "httpcon" module parameter - especially when the number of + options per line gets too big. + + + If the file or directory name starts with a '.' the path will be relative to the + working directory (at runtime). If it starts + with a '/' it will be an absolute path and if it starts with anything + else the path will be relative to the main config file directory + (e.g.: for kamailio -f /etc/kamailio/kamailio.cfg it will be relative to /etc/kamailio/). + + + The following parameters can be set in the config file, for each connection: + + + url + username + password + failover + useragent + verify_peer + verify_host + client_cert + client_key + tlsversion + timeout + maxdatasize + http_follow_redirect + + See the "httpcon" module parameter for explanation of these settings. + + By default no config file is specified. + + + Set <varname>config_file</varname> parameter + +... +modparam("http_client", "config_file", "httpconnections.cfg) ...