Add a note about viewing the default set of documentation using the built-in http...
[asterisk/asterisk.git] / configs / http.conf.sample
1 ;
2 ; Asterisk Builtin mini-HTTP server
3 ;
4 ;
5 ; Note about Asterisk documentation:
6 ;   If Asterisk was installed from a tarball, then the HTML documentation should
7 ;   be installed in the static-http/docs directory which is
8 ;   (/var/lib/asterisk/static-http/docs) on linux by default.  If the Asterisk
9 ;   HTTP server is enabled in this file by setting the "enabled", "bindaddr",
10 ;   and "bindport" options, then you should be able to view the documentation
11 ;   remotely by browsing to:
12 ;       http://<server_ip>:<bindport/asterisk/static/docs/index.html
13 ;
14 [general]
15 ;
16 ; Whether HTTP/HTTPS interface is enabled or not.  Default is no.
17 ; This also affects manager/rawman/mxml access (see manager.conf)
18 ;
19 ;enabled=yes
20 ;
21 ; Address to bind to, both for HTTP and HTTPS.  Default is 0.0.0.0
22 ;
23 bindaddr=127.0.0.1
24 ;
25 ; Port to bind to for HTTP sessions (default is 8088)
26 ;
27 ;bindport=8088
28 ;
29 ; Prefix allows you to specify a prefix for all requests
30 ; to the server.  The default is "asterisk" so that all
31 ; requests must begin with /asterisk
32 ;
33 ;prefix=asterisk
34 ;
35 ; Whether Asterisk should serve static content from http-static
36 ; Default is no.
37 ;
38 ;enablestatic=yes
39 ;
40 ; Redirect one URI to another.  This is how you would set a
41 ; default page.  
42 ;   Syntax: redirect=<from here> <to there>
43 ; For example, if you are using the Asterisk-gui,
44 ; it is convenient to enable the following redirect:
45 ;
46 ;redirect = / /asterisk/static/config/cfgbasic.html
47 ;
48 ; HTTPS support. In addition to enabled=yes, you need to
49 ; explicitly enable ssl, define the port to use,
50 ; and have a certificate somewhere.
51 ; sslenable=yes         ; enable ssl - default no.
52 ; sslbindport=4433      ; port to use - default is 8089
53 ; sslbindaddr=0.0.0.0   ; address to bind to - default is bindaddr.
54 ;
55 ; sslcert=/tmp/foo.pem  ; path to the certificate
56 ;
57 ; To produce a certificate you can e.g. use openssl
58 ;       openssl req -new -x509 -days 365 -nodes -out /tmp/foo.pem -keyout /tmp/foo.pem
59 ;
60
61 ; The post_mappings section maps URLs to real paths on the filesystem.  If a
62 ; POST is done from within an authenticated manager session to one of the
63 ; configured POST mappings, then any files in the POST will be placed in the
64 ; configured directory.
65 ;
66 ;[post_mappings]
67 ;
68 ; In this example, if the prefix option is set to "asterisk", then using the
69 ; POST URL: /asterisk/uploads will put files in /var/lib/asterisk/uploads/.
70 ;uploads = /var/lib/asterisk/uploads/
71 ;