[Home]

Summary:ASTERISK-22499: ARI documentation - point to HTTP server configuration sample and wiki docs where appropriate
Reporter:Rusty Newton (rnewton)Labels:
Date Opened:2013-09-10 13:56:52Date Closed:2014-03-18 18:34:41
Priority:TrivialRegression?
Status:Closed/CompleteComponents:Documentation
Versions:SVN 12.0.0-alpha1 Frequency of
Occurrence
Related
Issues:
is related toASTERISK-22008 Config framework docs should display the see-also information in CLI output.
Environment:Attachments:
Description:This is something maybe obvious to an existing Asterisk user, but for someone new to Asterisk it would be helpful to explicitly state in ARI documentation where you configure the HTTP server it uses.

From IRC:
{noformat}
<Pierri> Hi, I didn't find any mention on this page (https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Configuration_res_ari) on which web server ARI is going to exposed. In fewer words I don't know on which port it is going to be exposed.
<file> it uses the built-in Asterisk HTTP server
<Pierri> configured on "http.conf" right?
<file> yes.
<Pierri> Hmm... If I am not mistaken, this information is not on documentation. Maybe that could be made more explicit.
<newtonr> Pierri, that is a good idea. I don't see anything obvious in the ARI documentation, so I'll create an issue in the tracker for it.
{noformat}

Perhaps we should add something in {{ari.conf}} and in the XML module help that would then show up here https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Configuration_res_ari and in the CLI.

[Edit]
Pierri added:
{noformat}
<Pierri> Please, if possible, include a note telling that ARI resources are made available under "http://asteriskurlhere/ari/". I think that isn't clear too.
{noformat}
Comments:By: Matt Jordan (mjordan) 2013-09-12 18:54:58.706-0500

While I'm fine with this, the appropriate way to handle this is to actually tie this in with a <see-also> field. Right now, the DTD handles this for a <configObject>, but it won't actually show up until ASTERISK-22008 is worked.
By: Rusty Newton (rnewton) 2014-03-18 18:34:12.325-0500

Created https://wiki.asterisk.org/wiki/display/AST/Asterisk+Builtin+mini-HTTP+Server.

Added a note and see-also to the "enabled" config option for res_ari. One of the see-also items links to the wiki page. Went ahead and also linked a few other relevant wiki pages to the new wiki page.