[prev in list] [next in list] [prev in thread] [next in thread] 

List:       slide-dev
Subject:    cvs commit: jakarta-slide/src/doc conf-lib.xml installation.xml
From:       cmlenz () apache ! org
Date:       2001-09-27 14:56:37
[Download RAW message or body]

cmlenz      01/09/27 07:56:37

  Modified:    src/doc  conf-lib.xml installation.xml
  Log:
  - Added installation/configuration hints for the admin webapp
  - Updated the explanation of the init-parameters of the WebdavServlet
  - Some typos eliminated
  
  Revision  Changes    Path
  1.20      +51 -12    jakarta-slide/src/doc/conf-lib.xml
  
  Index: conf-lib.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-slide/src/doc/conf-lib.xml,v
  retrieving revision 1.19
  retrieving revision 1.20
  diff -u -r1.19 -r1.20
  --- conf-lib.xml	2001/09/11 00:37:36	1.19
  +++ conf-lib.xml	2001/09/27 14:56:37	1.20
  @@ -105,9 +105,9 @@
         <section name="WebDAV Server">
           
           <p>
  -          The WebDAV module is a Servlet and requires a property configured 
  -          Servlet 2.2 implementation. It also requires JAXP and a JAXP 
  -          compliant XML parser.
  +          The WebDAV module is a Servlet and requires a properly configured 
  +          Servlet 2.2 container. It also requires JAXP, a JAXP compliant XML
  +          parser and JDOM.
           </p>
           
           <p>
  @@ -117,21 +117,60 @@
           
           <p>
             Parameters can be specified to configure the servlet. They
  -          are defined in the web application descriptor of the web application.
  -          See the Servlet API documentation for more details about web 
  -          applications and the web.xml file. The parameters are :
  +          are defined in the web application descriptor of the web application
  +          (WEB-INF/web.xml). See the Servlet API documentation for more details
  +          about web applications and the web.xml file. The parameters are:
             <ul>
  -            <li>namespace: Specify the name of the namespace which will be
  -              accessed in the Slide domain. Defaults to "webdav".</li>
  -            <li>domain: Path in the web application where the domain 
  +            <li><b>domain:</b> Path in the web application where the domain 
                 configuration file is. Defaults to "/Domain.xml".</li>
  -            <li>manager: Path of the manager servlet in the web application.
  -              Defaults to "/manager/".</li>
  +            <li><b>namespace:</b> Name of the namespace which will be accessed 
  +              in the Slide domain. Defaults to the default namespace.</li>
  +            <li><b>scope:</b> The scope of the Slide namespace that should be 
  +              exposed by this servlet. For example, if you want to expose only 
  +              the /files collection via WebDAV, set this parameter to '/files'.
  +              In that case, any URLs of the form '/context-path/servlet-path/*'
  +              will be mapped to '/files/*' in the Slide namespace. The default 
  +              value is an empty string, meaning that the entire namespace will 
  +              be exposed.</li>
  +            <li><b>depth-limit:</b> Determines the depth limit for PROPFIND and
  +              other methods, to avoid performance hits on the server for 
  +              requests with infinite depth.</li>
  +            <li><b>default-mime-type:</b> The MIME type that should be used for
  +              resources of unknown type. For example, if a WebDAV client 
  +              uploads a file (via PUT) without specifying the Content-Type 
  +              header, the MIME type defined here will be used. Defaults to 
  +              'application/octet-stream'.</li>
  +            <li><b>default-servlet:</b> By default, the WebDAV servlet is 
  +              mapped as default servlet of the web application context (the 
  +              url-pattern in servlet-mapping is '/'). If you want to change 
  +              that mapping so the servlet is no longer the default servlet, you
  +              must change this initialization parameter to indicate the 
  +              situation to the servlet, by setting it to 'false'. The default 
  +              value is 'true'.</li>
             </ul>
           </p>
           
         </section>
   
  +      <section name="Administration Webapp">
  +        
  +        <p>
  +          The Slide administration webapp is based on the Jakarta Struts web 
  +          application framework, a custom Slide tag library and JSP pages. One 
  +          instance of the administration webapp can be used to administrate a 
  +          single Slide namespace, so you'll need multiple instances to 
  +          administrate multiple namespaces.
  +        </p>
  +        
  +        <p>
  +          By default, the administration webapp will be set to access the 
  +          default namespace. To change this behaviour, change the 
  +          <b>namespace</b> context parameter in the applications web.xml file 
  +          to the name of the namespace that should be accessed.
  +        </p>
  +        
  +      </section>
  +
         <section name="The Domain configuration file">
           
           <p>
  @@ -141,7 +180,7 @@
           
           <p>
             Slide needs a configuration file to initialize the 
  -          <a href="domain.xml">domain</a>. This configuration file defines
  +          <a href="domain.html">domain</a>. This configuration file defines
             the namespaces which are part of this domain, the services associated
             with them, and the namespaces data configuration. This file uses the
             XML language for its syntax. The XML elements and attributes used by
  
  
  
  1.21      +24 -0     jakarta-slide/src/doc/installation.xml
  
  Index: installation.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-slide/src/doc/installation.xml,v
  retrieving revision 1.20
  retrieving revision 1.21
  diff -u -r1.20 -r1.21
  --- installation.xml	2001/09/20 13:10:54	1.20
  +++ installation.xml	2001/09/27 14:56:37	1.21
  @@ -157,6 +157,30 @@
       
     </section>
     
  +  <section name="Administration Webapp">
  +    
  +    <p>
  +      Slide includes a web application for administration of a namespace. The 
  +      current feature set includes user management and killing (forced removal)
  +      of locks. The administration webapp requires Jakarta Struts 1.0 (see 
  +      <a href="http://jakarta.apache.org/struts/">
  +      http://jakarta.apache.org/struts/</a>) and a servlet container that 
  +      supports version 2.2 or later of the servlet API. A WAR file containing 
  +      the administration webapp (webapp/slide-admin.war) is included in the 
  +      binary distribution.
  +    </p>
  +    
  +    <p>
  +      <i>Please note that the administration webapp does not take care of 
  +      locating the domain configuration file and initializing the domain - it 
  +      is expected that this is done for example by the Slide WebDAV servlet or 
  +      the Slide Realm for Catalina. Also the WAR file does not contain the core
  +      Slide JAR files, because those need to be in a location shared by all 
  +      web applications that access Slide.</i>
  +    </p>
  +    
  +  </section>
  +  
     <section name="Installing the Server">
   
       <subsection name="JServ">
  
  
  

[prev in list] [next in list] [prev in thread] [next in thread] 

Configure | About | News | Add a list | Sponsored by KoreLogic