Author: poeml Date: Fri Jul 31 22:13:10 2009 New Revision: 7750 URL: http://svn.mirrorbrain.org/viewvc/mirrorbrain?view=revision&revision=7750 Log: docs/installation: - move the mod_asn and troubleshooting sections off the opensuse-specific notes. - add a note to the rather empty configuration section. Added: trunk/docs/installation/mod_asn.rst trunk/docs/installation/troubleshooting.rst Modified: trunk/docs/configuration.rst trunk/docs/index.rst trunk/docs/installation/index.rst trunk/docs/installation/opensuse.rst Modified: trunk/docs/configuration.rst ============================================================================== --- trunk/docs/configuration.rst Fri Jul 31 22:06:33 2009 (r7749) +++ trunk/docs/configuration.rst Fri Jul 31 22:13:10 2009 (r7750) @@ -4,8 +4,8 @@ To be written. - - +For now, please refer to the installation section, which contains most of the +information. Modified: trunk/docs/index.rst ============================================================================== --- trunk/docs/index.rst Fri Jul 31 22:06:33 2009 (r7749) +++ trunk/docs/index.rst Fri Jul 31 22:13:10 2009 (r7750) @@ -11,15 +11,15 @@ .. toctree:: intro - installation/index configuration - configuration_reference mirrors developer bugs changes +.. configuration_reference + Indices and tables ================== Modified: trunk/docs/installation/index.rst ============================================================================== --- trunk/docs/installation/index.rst Fri Jul 31 22:06:33 2009 (r7749) +++ trunk/docs/installation/index.rst Fri Jul 31 22:13:10 2009 (r7750) @@ -8,5 +8,7 @@ source opensuse gentoo + mod_asn + troubleshooting memcache Added: trunk/docs/installation/mod_asn.rst ============================================================================== --- /dev/null 00:00:00 1970 (empty, because file is newly added) +++ trunk/docs/installation/mod_asn.rst Fri Jul 31 22:13:10 2009 (r7750) @@ -0,0 +1,18 @@ + +Installing mod_asn +------------------ + +mod_asn is optional for MirrorBrain. MirrorBrain runs fine without it. If you +don't need mirror selection based on network prefix or autonomous system, you +don't need to install mod_asn. + +.. note:: + There was a bug in the :program:`mb` tool that it depended on the existance on + a database table named ``pfx2asn`` which is created when mod_asn is installed. The + bug was fixed in the 2.9.0 release. + +To install mod_asn, refer to the `its documentation`__. + +__ /mod_asn/docs/ + + Modified: trunk/docs/installation/opensuse.rst ============================================================================== --- trunk/docs/installation/opensuse.rst Fri Jul 31 22:06:33 2009 (r7749) +++ trunk/docs/installation/opensuse.rst Fri Jul 31 22:13:10 2009 (r7750) @@ -1,7 +1,7 @@ Installation on openSUSE Linux or SLE -================================================================================ +------------------------------------- Add the needed repositories (use the subdirectory matching your distribution): @@ -63,46 +63,3 @@ -******************************************************************************** -Installing mod_asn -******************************************************************************** - -mod_asn is optional for MirrorBrain. MirrorBrain runs fine without it. If you -don't need mirror selection based on network prefix or autonomous system, you -don't need to install mod_asn. - -.. note:: - There was a bug in the :program:`mb` tool that it depended on the existance on - a database table named ``pfx2asn`` which is created when mod_asn is installed. The - bug was fixed in the 2.9.0 release. - -To install mod_asn, refer to the `its documentation`__. - -__ /mod_asn/docs/ - - - -******************************************************************************** -Troubleshooting -******************************************************************************** - -If Apache doesn't start, or anything else seems wrong, make sure to check -Apache's error_log. It usually points into the right direction. - -A general note about Apache configuration which might be in order. With most -config directives, it is important to pay attention where to put them - the -order does not matter, but the context does. There is the concept of directory -contexts and vhost contexts, which must not be overlooked. Things can be -"global", or inside a <VirtualHost> container, or within a <Directory> -container. - -This matters because Apache applies the config recursively onto subdirectories, -and for each request it does a "merge" of possibly overlapping directives. -Settings in vhost context are merged only when the server forks, while settings -in directory context are merged for each request. This is also the reason why -some of mod_asn's config directives are programmed to be used in one or the -other context, for performance reasons. - -The install docs you are reading attempt to always point out in which context -the directives belong. - Added: trunk/docs/installation/troubleshooting.rst ============================================================================== --- /dev/null 00:00:00 1970 (empty, because file is newly added) +++ trunk/docs/installation/troubleshooting.rst Fri Jul 31 22:13:10 2009 (r7750) @@ -0,0 +1,28 @@ + +Troubleshooting +--------------- + +If Apache doesn't start, or anything else seems wrong, make sure to check +Apache's error_log. It usually points into the right direction. + +A general note about Apache configuration which might be in order. With most +config directives, it is important to pay attention where to put them - the +order does not matter, but the context does. There is the concept of directory +contexts and vhost contexts, which must not be overlooked. Things can be +"global", or inside a <VirtualHost> container, or within a <Directory> +container. + +This matters because Apache applies the config recursively onto subdirectories, +and for each request it does a "merge" of possibly overlapping directives. +Settings in vhost context are merged only when the server forks, while settings +in directory context are merged for each request. This is also the reason why +some of mod_asn's config directives are programmed to be used in one or the +other context, for performance reasons. + +The install docs you are reading attempt to always point out in which context +the directives belong. + +.. note:: To get help, please subscribe to the mirrorbrain mailing list, see + http://mirrorbrain.org/communication . Questions can be answered + there, and all kind of feedback is appreciated. + _______________________________________________ mirrorbrain-commits mailing list Archive: http://mirrorbrain.org/archive/mirrorbrain-commits/ Note: To remove yourself from this list, send a mail with the content unsubscribe to the address mirrorbrain-commits-request_at_mirrorbrain.orgReceived on Fri Jul 31 2009 - 20:13:12 GMT
This archive was generated by hypermail 2.2.0 : Fri Jul 31 2009 - 20:45:06 GMT