Changeset 1703


Ignore:
Timestamp:
02/26/10 10:17:24 (11 years ago)
Author:
landlord
Message:

Documentation update for web interface

Location:
trunk/Distribution/doc
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/Distribution/doc/man/oscam.conf.5

    r1577 r1703  
    162162.RS 3n
    163163time to hide clients in the monitor if not sending requests, 0 = disabled, default:0
     164.RE
     165.PP
     166.SS "The [webif] section" \fI(only if web interface module enabled)\fR
     167\fBhttpport\fP = \fBport\fP
     168.RS 3n
     169port for web interface, 0 = disabled, default:none, \fIrequired\fR
     170.RE
     171.PP
     172\fBhttpuser\fP = \fBusername\fP
     173.RS 3n
     174username for password protection, default:none
     175.RE
     176.PP
     177\fBhttppwd\fP = \fBpassword\fP
     178.RS 3n
     179password for password protection, default:none
     180.RE
     181.PP
     182\fBhttpcss\fP = \fBpath\fP
     183.RS 3n
     184path for external CSS file, default:none
     185.RE
     186.PP
     187\fBhttptpl\fP = \fBpath\fP
     188.RS 3n
     189path for external templates, default:none
     190.RE
     191.PP
     192\fBhttprefresh\fP = \fBseconds\fP
     193.RS 3n
     194status refresh in seconds, default:none
     195.RE
     196.PP
     197\fBhttptpl\fP = \fBpath\fP
     198.RS 3n
     199path for external templates, default:none
     200.RE
     201.PP
     202\fBhttphideidleclients\fP = \fB0\fP|\fB1\fP
     203.RS 3n
     2041 = enables hiding clients after idle time set in parameter \fBhideclient_to\fP, default:0
     205.RE
     206.PP
     207\fBhttpscript\fP = \fBpath\fP
     208.RS 3n
     209path to an executable script which you wish to start from web interface, default:none
     210.RE
     211.PP
     212\fBhttpallowed\fP = \fBIP address\fP|\fBIP address range\fP[,\fBIP address\fP|\fBIP address range]\fP...
     213.RS 3n
     214http web interface connections allowed, default:none
     215 example: httpallowed = 127.0.0.1,192.168.0.0-192.168.255.255
    164216.RE
    165217.SS "The [camd33] section"
     
    481533                             63 = debug all
    482534 version                 = show OSCam version
     535.SH WEB INTERFACE
     536.TP 3n
     537\(bu
     538template system
     539
     540The web interface allows you to create your own template. For developing your
     541own template request the orignal template with the non-linked page
     542\fBsavetemplates.html\fP. Store your own template in the directory specified
     543by \fBhttptpl\fP.
     544.TP 3n
     545\(bu
     546SSL connection to the web interface
     547
     548The Apache module \fBmod_proxy\fP can be used to proxy requests to the web
     549interface. With this module it's also possible to use a SSL connection to
     550the web interface.
     551
     552 ProxyRequests Off
     553  <Proxy *>
     554   Order deny,allow
     555   Allow from all
     556  </Proxy>
     557  ProxyPass /oscam/ http://localhost:8080/
     558  ProxyPassReverse /oscam/ http://localhost:8080/
     559
     560For further information please read the Apache documentation.
     561.TP 3n
     562\(bu
     563known issues
     564
     565Login is not possible by now with the Safari browser because of incorrect
     566stale flag handling. Increasing the AUTHNONCEVALIDSECS in oscam-http.h would
     567be a workaround, but also a small security risk.
    483568.SH EXAMPLES
    484569 [global]
  • trunk/Distribution/doc/txt/oscam.conf.txt

    r1577 r1703  
    122122      disabled, default:0
    123123
     124
     125   The [webif] section (only if web interface module enabled)
     126       httpport = port
     127      port for web interface, 0 = disabled, default:none, required
     128
     129       httpuser = username
     130      username for password protection, default:none
     131
     132       httppwd = password
     133      password for password protection, default:none
     134
     135       httpcss = path
     136      path for external CSS file, default:none
     137
     138       httptpl = path
     139      path for external templates, default:none
     140
     141       httprefresh = seconds
     142      status refresh in seconds, default:none
     143
     144       httptpl = path
     145      path for external templates, default:none
     146
     147       httphideidleclients = 0|1
     148      1  =  enables  hiding clients after idle time set in parameter hide
     149      client_to, default:0
     150
     151       httpscript = path
     152      path to an executable script which you wish to start from web inter
     153      face, default:none
     154
     155       httpallowed  =  IP  address|IP  address  range[,IP  address|IP  address
     156       range]...
     157      http web interface connections allowed, default:none
     158       example: httpallowed = 127.0.0.1,192.168.0.0-192.168.255.255
     159
    124160   The [camd33] section
    125161       port = 0|port
     
    129165      bind service to specified IP address, default:all
    130166
    131        nocrypt  = IP address|IP address range[,IP address|IP address range]...
     167       nocrypt = IP address|IP address range[,IP address|IP address range]...
    132168      unsecured camd 3.3x client connection, default:none
    133169
     
    160196      bind service to specified IP address, default:all
    161197
    162        allowed = IP address|IP address range[,IP address|IP address range]...
     198       allowed  = IP address|IP address range[,IP address|IP address range]...
    163199      client connections allowed from, default:none
    164200
     
    180216      bind service to specified IP address, default:all
    181217
    182        allowed  = IP address|IP address range[,IP address|IP address range]...
     218       allowed = IP address|IP address range[,IP address|IP address range]...
    183219      client connections allowed from, default:none
    184220
     
    293329
    294330       boxtype = dbox2|dreambox|ufs910
    295       set  boxtype,  auto  detection  of  DVB   API   will   be   aspired,
     331      set   boxtype,   auto   detection   of  DVB  API  will  be  aspired,
    296332      default:dreambox
    297333
     
    301337
    302338       numusers = quantity
    303       anti-cascading:  user  per  account,  0  =  anti-cascading disabled,
     339      anti-cascading: user  per  account,  0  =  anti-cascading disabled,
    304340      default:0
    305341
     
    347383                     4 = traffic from/to the reader
    348384                     8 = traffic from/to the clients
    349                     16  =  traffic to the reader-device on IFD
     385                    16 = traffic to the reader-device  on IFD
    350386       layer
    351                     32 = traffic to the reader-device  on I/O
     387                    32  =  traffic to the reader-device on I/O
    352388       layer
    353389                    63 = debug all
    354390    version         = show OSCam version
     391
     392WEB INTERFACE
     393     template system
     394
     395      The web interface allows you to create your own template. For devel
     396      oping  your  own template request the orignal template with the non-
     397      linked page savetemplates.html.  Store  your  own  template  in  the
     398      directory specified by httptpl.
     399
     400     SSL connection to the web interface
     401
     402      The Apache module mod_proxy can be used to proxy requests to the web
     403      interface. With this module its also possible to use a SSL  connec
     404      tion to the web interface.
     405
     406       ProxyRequests Off
     407        <Proxy *>
     408         Order deny,allow
     409         Allow from all
     410        </Proxy>
     411        ProxyPass /oscam/ http://localhost:8080/
     412        ProxyPassReverse /oscam/ http://localhost:8080/
     413
     414      For further information please read the Apache documentation.
     415
     416     known issues
     417
     418      Login  is  not  possible  by  now with the Safari browser because of
     419      incorrect stale flag handling. Increasing the AUTHNONCEVALIDSECS  in
     420      oscam-http.h  would be a workaround, but also a small security risk.
    355421
    356422EXAMPLES
     
    385451
    386452SEE ALSO
    387        list_smargo(1),      oscam(1),      oscam.user(5),     oscam.server(5),
     453       list_smargo(1),     oscam(1),      oscam.user(5),      oscam.server(5),
    388454       oscam.srvid(5),   oscam.guess(5),   oscam.cert(5),   oscam.services(5),
    389455       oscam.ird(5), oscam.ac(5)
Note: See TracChangeset for help on using the changeset viewer.