moinsetup

Changeset

36:7ccb4fa10b63
2011-06-25 Paul Boddie raw files shortlog changelog graph Added a description of limited hosting environments and the static content directory setting.
README.txt (file)
     1.1 --- a/README.txt	Sat May 28 21:42:15 2011 +0200
     1.2 +++ b/README.txt	Sat Jun 25 18:08:21 2011 +0200
     1.3 @@ -21,7 +21,7 @@
     1.4  Configuration
     1.5  -------------
     1.6  
     1.7 -The configuration file has two sections: installation and site. A brief
     1.8 +The configuration file has two sections: "installation" and "site". A brief
     1.9  description of the settings is given below.
    1.10  
    1.11  Installation settings influence the configuration, installation and
    1.12 @@ -39,24 +39,52 @@
    1.13  web_app_dir         A directory where the moin.cgi program is (or will be)
    1.14                      installed.
    1.15  
    1.16 +web_static_dir      A directory from which static resources are to be served.
    1.17 +                    This directory need only be specified in a limited hosting
    1.18 +                    environment (see below for more details).
    1.19 +
    1.20  web_site_dir        The directory where sites available to the Apache Web
    1.21                      server are defined. This directory may just be a place
    1.22                      where initial site definitions are written, and after
    1.23                      manual editing, such definitions may be copied to the
    1.24 -                    appropriate location.
    1.25 +                    appropriate location. If this directory is left
    1.26 +                    unspecified, a limited hosting environment will be
    1.27 +                    assumed.
    1.28 +
    1.29 +Except for the common_dir setting, site settings are generally only relevant
    1.30 +when configuring and installing a Wiki:
    1.31  
    1.32  common_dir          The directory in which the Wiki instance being configured
    1.33                      or managed resides (or will reside).
    1.34  
    1.35 -Site settings are generally only relevant when configuring and installing a
    1.36 -Wiki:
    1.37 -
    1.38  url_path            The URL path (after the host details) of the Wiki.
    1.39  superuser           The superuser of the Wiki.
    1.40  site_name           The name of the Wiki.
    1.41  front_page_name     The name of the Wiki's front page.
    1.42  theme_default       The default theme of the Wiki.
    1.43  
    1.44 +Limited Hosting Environments
    1.45 +----------------------------
    1.46 +
    1.47 +Sometimes, the hosting environment in which MoinMoin is to be deployed will be
    1.48 +restrictive or "limited", meaning that substantial configuration of the Web
    1.49 +server will not be possible for the user installing and configuring MoinMoin.
    1.50 +In such environments, users will typically be allowed to install content in
    1.51 +preconfigured directories for static and dynamic content. For example:
    1.52 +
    1.53 +/path/to/www/cgi-bin    a dynamic content directory, providing CGI scripts
    1.54 +/path/to/www/htdocs     a static content directory, providing Web pages
    1.55 +
    1.56 +To work in such environments, specify the configuration settings in
    1.57 +moinsetup.cfg as follows:
    1.58 +
    1.59 +web_app_dir     = /path/to/www/cgi-bin
    1.60 +web_static_dir  = /path/to/www/htdocs
    1.61 +web_site_dir    =
    1.62 +
    1.63 +Inside the static resources directory, a subdirectory will be created to hold
    1.64 +any static content used by MoinMoin.
    1.65 +
    1.66  Examples
    1.67  --------
    1.68  
    1.69 @@ -70,7 +98,7 @@
    1.70  
    1.71    python moinsetup.py -f new_wiki.cfg setup_wiki
    1.72  
    1.73 -To change a configuration setting (for example, the default theme):
    1.74 +To change a Wiki configuration setting (for example, the default theme):
    1.75  
    1.76    python moinsetup.py reconfigure_moin theme_default mercurialwiki
    1.77