networkingtestandutils/networkingexamples/webserver/Documentation/README.txt
changeset 0 af10295192d8
child 6 c64cefac6e99
equal deleted inserted replaced
-1:000000000000 0:af10295192d8
       
     1 //
       
     2 //    readme.txt - http server development notes
       
     3 //
       
     4 //    Portions Copyright (c) Symbian Software Ltd. 2007.
       
     5 //    Portions Copyright (C) 1999-2004 Nokia. * Nokia Core OS *
       
     6 //    Save as expressly licensed to you by Symbian Software Ltd, all rights reserved.
       
     7 //
       
     8 ////////////////////////////////////////////////////////////////
       
     9 
       
    10 Hi !
       
    11 
       
    12 I've put in the CVS a new version of the webserver.
       
    13 This versions suports GET(1), HEAD(1), PUT(2), DELETE(2), TRACE & OPTIONS Methods.
       
    14 It allows the webmaster to define the relationship between extension and content-type (see WSTYPES.CFG)
       
    15 It allows the webmaster to define his own HTML errors messages.
       
    16 
       
    17 This version has also 3 new files :
       
    18 
       
    19 ws.cfg 			-> This the configuration file of the webserver.
       
    20 wstypes.cfg		-> This file defines the relation ship between extension and content-types.
       
    21 webserver.log		-> This file is automatically generated by the webserver. It is used by the webmaster
       
    22 			   to undelete files which has been deleted by a PUT or DELETE method.
       
    23 By now, this files must be in the root directory. (\epoc32\wins\C\ in the emulator)
       
    24 
       
    25 WS.CFG
       
    26 ============
       
    27 
       
    28 BACKUP_PATH=\ws\backups\	-> Set the directory for security copies of deleted files by the PUT & DELETE methods.
       
    29 ERROR_PATH=\ws\error\		-> Set the directory where the user has his own HTML error messages.
       
    30 SERVER_PATH=\ws\		-> Set the root directory of the webserver.
       
    31 DEFAULT_RESOURCE=home.htm	-> Set the default resource name. 
       
    32 				   (e.g: http:://www.6pack.fi/tcpip/ => http:://www.6pack.fi/tcpip/home.htm)
       
    33 PORT=2080			-> Set the listen port.
       
    34 
       
    35 (Note: All the values which are not defined in ws.cfg are set with defaults values.)
       
    36 WSTYPES.CFG
       
    37 ===========
       
    38 
       
    39 <extension_name>	<content-type>
       
    40 (e.g:
       
    41 html	text/html
       
    42 htm	text/html
       
    43 txt	text/plain
       
    44 gif	image/gif
       
    45 jpg	image/jpeg
       
    46 js	application/octet-stream
       
    47 ps	application/postscript 
       
    48 )
       
    49 
       
    50 HTML error files
       
    51 ================
       
    52 
       
    53 The HTML error files must be named as "errorXXX.htm".
       
    54 The XXX is the error number. (eg: 404 Not found error will have a "error404.htm" HTML error file)
       
    55 If there is no error file definied the webserver will use its defaults HTML error messages.
       
    56 
       
    57 GET & HEAD Methods (1)
       
    58 ======================
       
    59 
       
    60 This version of the webserver doesn't allow queries in these methods.Although, it will support very soon.
       
    61 
       
    62 PUT & DELETE Methods (2)
       
    63 ========================
       
    64 
       
    65 These methods are allowed, but there is no authentication implemented yet. That means everybody can use these
       
    66 methods with out being authorized !!!
       
    67  
       
    68 /***************************************** NEW VERSION (8 - 2 - 2000) **************************************/
       
    69 WS.CFG (new fields) 
       
    70 ============
       
    71 
       
    72 DELETE_METHOD=[Yes/No]	-> Enable/Disable the delete method in the websever.
       
    73 CGI_PATH=\ws\cgi-bin\	-> Set the directory for CGIs.
       
    74 
       
    75 GET & HEAD Methods (1)
       
    76 ======================
       
    77 
       
    78 This version allows queries in these methods.
       
    79 Range Requests are supported.
       
    80 
       
    81 POST Method
       
    82 ============
       
    83 
       
    84 The Post method is supported.
       
    85 
       
    86 TRACE Method
       
    87 ============
       
    88 
       
    89 The Trace method is supported.
       
    90 
       
    91 OPTIONS Method
       
    92 ==============
       
    93 
       
    94 The Options method is supported.
       
    95 
       
    96 GENERAL Issues
       
    97 ===============
       
    98 
       
    99 Chuncked Enconding is NOT supported.
       
   100 Authentication is NOT supported.
       
   101 Restricted URI access is NOT supported.
       
   102 Multi-Host is NOT supported.
       
   103 
       
   104 /***************************************** NEW VERSION (24 - 3 - 2000) **************************************/
       
   105 
       
   106 WS.CFG & WSTYPES.CFG
       
   107 ====================
       
   108 
       
   109 These files are now located in \DATA\ directory.
       
   110 
       
   111 You can modify them through the new interface in the Webserver. Config data can only be changed with the WebServer
       
   112 stopped.
       
   113 
       
   114 GET & HEAD Methods 
       
   115 ==================
       
   116 
       
   117 Multi-range request are supported.
       
   118 
       
   119 GENERAL Issues
       
   120 ===============
       
   121 
       
   122 New User Interface.
       
   123 
       
   124 No Panic when config files are missing. Now, there are nice warnings.
       
   125 
       
   126 Console displays HTTP Request and Responses headers.It also displays remote addresses. 
       
   127 (These messages can be enable/disable) 
       
   128 
       
   129 Help is still under construction.
       
   130 
       
   131 Chuncked Enconding is NOT supported.
       
   132 Authentication is NOT supported.
       
   133 Restricted URI access is NOT supported.
       
   134 Multi-Host is NOT supported.