diff options
author | russell <russell@f38db490-d61c-443f-a65b-d21fe96a405b> | 2007-03-15 22:25:12 +0000 |
---|---|---|
committer | russell <russell@f38db490-d61c-443f-a65b-d21fe96a405b> | 2007-03-15 22:25:12 +0000 |
commit | 3bc7e211a435c49aa70ad227799bd7b0c40356a1 (patch) | |
tree | d8e5262f1e1a9faad716b36f59a6b3fe65c288bd /doc/ajam.txt | |
parent | a63acaa328b9937677f3f5c4d861889a6e369034 (diff) |
Merge changes from svn/asterisk/team/russell/LaTeX_docs.
* Convert most of the doc directory into a single LaTeX formatted document
so that we can generate a PDF, HTML, or other formats from this
information.
* Add a CLI command to dump the application documentation into LaTeX format
which will only be include if the configure script is run with
--enable-dev-mode.
* The PDF turned out to be close to 1 MB, so it is not included. However, you
can simply run "make asterisk.pdf" to generate it yourself. We may include
it in release tarballs or have automatically generated ones on the web site,
but that has yet to be decided.
git-svn-id: http://svn.digium.com/svn/asterisk/branches/1.4@58931 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'doc/ajam.txt')
-rw-r--r-- | doc/ajam.txt | 91 |
1 files changed, 0 insertions, 91 deletions
diff --git a/doc/ajam.txt b/doc/ajam.txt deleted file mode 100644 index d3babd0c2..000000000 --- a/doc/ajam.txt +++ /dev/null @@ -1,91 +0,0 @@ -Asynchronous Javascript Asterisk Manger (AJAM) -============================================== - -AJAM is a new technology which allows web browsers or other HTTP enabled -applications and web pages to directly access the Asterisk Manger -Interface (AMI) via HTTP. Setting up your server to process AJAM -involves a few steps: - -Setup the Asterisk HTTP server ------------------------------- - -1) Uncomment the line "enabled=yes" in /etc/asterisk/http.conf to enable - Asterisk's builtin micro HTTP server. - -2) If you want Asterisk to actually deliver simple HTML pages, CSS, - javascript, etc. you should uncomment "enablestatic=yes" - -3) Adjust your "bindaddr" and "bindport" settings as appropriate for - your desired accessibility - -4) Adjust your "prefix" if appropriate, which must be the beginning of - any URI on the server to match. The default is "asterisk" and the - rest of these instructions assume that value. - -Allow Manager Access via HTTP ------------------------------ - -1) Make sure you have both "enabled = yes" and "webenabled = yes" setup - in /etc/asterisk/manager.conf - -2) You may also use "httptimeout" to set a default timeout for HTTP - connections. - -3) Make sure you have a manager username/secret - -Once those configurations are complete you can reload or restart -Asterisk and you should be able to point your web browser to specific -URI's which will allow you to access various web functions. A complete -list can be found by typing "show http" at the Asterisk CLI. - -examples: - -http://localhost:8088/asterisk/manager?action=login&username=foo&secret=bar - -This logs you into the manager interface's "HTML" view. Once you're -logged in, Asterisk stores a cookie on your browser (valid for the -length of httptimeout) which is used to connect to the same session. - -http://localhost:8088/asterisk/rawman?action=status - -Assuming you've already logged into manager, this URI will give you a -"raw" manager output for the "status" command. - -http://localhost:8088/asterisk/mxml?action=status - -This will give you the same status view but represented as AJAX data, -theoretically compatible with RICO (http://www.openrico.org). - -http://localhost:8088/asterisk/static/ajamdemo.html - -If you have enabled static content support and have done a make install, -Asterisk will serve up a demo page which presents a live, but very -basic, "astman" like interface. You can login with your username/secret -for manager and have a basic view of channels as well as transfer and -hangup calls. It's only tested in Firefox, but could probably be made -to run in other browsers as well. - -A sample library (astman.js) is included to help ease the creation of -manager HTML interfaces. - -Note that for the demo, there is no need for *any* external web server. - -Integration with other web servers ----------------------------------- - -Asterisk's micro HTTP server is *not* designed to replace a general -purpose web server and it is intentionally created to provide only the -minimal interfaces required. Even without the addition of an external -web server, one can use Asterisk's interfaces to implement screen pops -and similar tools pulling data from other web servers using iframes, -div's etc. If you want to integrate CGI's, databases, PHP, etc. you -will likely need to use a more traditional web server like Apache and -link in your Asterisk micro HTTP server with something like this: - -ProxyPass /asterisk http://localhost:8088/asterisk - -This is a fairly new technology so I'd love to hear if it's useful for -you! - -Mark - |