On Sat, May 10, 2008 at 8:01 PM, Vasiljevic Zoran <[EMAIL PROTECTED]> wrote: > Hi ! > > In the process of a spring-cleanup I wanted to attack > the gobal sample-config.tcl file that we deliver > with the server. The purpose of that file is obviously > dual: > > o. get a config file people can start with > o. declare and document each and every config option > > As it seems, we fail to meet any of those goals _really_. > One can use this file to start the server, right, but > thats about it. Any attempt to understand it, is not > going to bear fruits... > > I will reorganize this file as follows: > > o. write man page about the overal layout of the file
http://naviserver.sourceforge.net/n/naviserver/files/ns_config.html Maybe hoist the existing small examples into the section explains the command in the example, and add a new section at the bottom "Configuration File Structure", with the sections that are always present, such as "ns/parameters" etc. > o. write man page explaining server internal parameters I wonder if there are many parameters which wouldn't fit nicely on a page with their related commands? We've had a bit of a push to make config more dynamic, so for example all the ADP parameters are now can now be controlled by the ns_adp_ctl command and per-request by ns_register_adp: http://naviserver.sourceforge.net/n/naviserver/files/ns_register_adp.html Maybe the ns_limits page handles this better: http://naviserver.sourceforge.net/n/naviserver/files/ns_limits.html It uses the config section as definition item and shows a literal config file example with all keys. The keys are identically named to the options passed to the ns_limits_set command, which is documented above. Maybe ns_adp_ctl should be added to the ns_register_adp page, document the options for it, and reference that in the config section? Another example is the ns_ictl page: http://naviserver.sourceforge.net/n/naviserver/files/ns_ictl.html which currently has zero config, but the stuff you put there might be considered 'server internal parameters', like the path to private Tcl files and the path to the boot init.tcl file. > o. expand man pages for each module and put explanations > of module paramaters there The nslog module is not bad: http://naviserver.sourceforge.net/n/naviserver/files/ns_accesslog.html but maybe it should be moved from: doc/src/mann/ns_accesslog.man to: nslog/doc/src/mann/ns_accesslog.man so that it shows up as a module on the TOC page. Same with ns_proxy.man. > o. rewrite this file to include sample for configuring > two virtual servers I dunno... There needs to be a man page describing ns_serverpath, ns_pagepath, ns_hashpath, ns_serverpathproc ns_locationproc, with see-also of ns_url2file. It will have to explain the difference between virtual servers and mass virtual hosting, and show config params. Maybe this is enough to cover vhosting? > Vlad already started this right by providing a minimal > no-fuss config file for somebody that needs to pull up > the server fast with minimal config. What we need is > something similar to that for virtual servers in perhaps > 2 or 3 sample configurations. There is already a nsd-config.tcl and it's kind of a bad example because it has a very generic name and no comments at all. It's not clear why you would want to use it. Ideally simple-config.tcl would be expanded a little -- it's just a bit too simple -- and then you could cat it to config/sample-virtual-hosts.tcl and add only the bits that are relevant to the virtual hosting example. ------------------------------------------------------------------------- This SF.net email is sponsored by the 2008 JavaOne(SM) Conference Don't miss this year's exciting event. There's still time to save $100. Use priority code J8TL2D2. http://ad.doubleclick.net/clk;198757673;13503038;p?http://java.sun.com/javaone _______________________________________________ naviserver-devel mailing list naviserver-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/naviserver-devel
