1.1 --- a/README.txt Wed Sep 14 00:11:35 2011 +0200
1.2 +++ b/README.txt Thu Sep 15 23:57:53 2011 +0200
1.3 @@ -30,22 +30,27 @@
1.4 moin_distribution A path to a MoinMoin distribution directory, which can
1.5 also be a clone of a MoinMoin repository.
1.6
1.7 -moin_data A path to the MoinMoin shared data, which may be installed
1.8 - from a system package in a directory such as
1.9 - /usr/share/moin.
1.10 -
1.11 prefix The directory prefix containing lib, bin and share
1.12 directories where MoinMoin is (or will be) installed.
1.13 Although this follows the layout of the /usr directory (on
1.14 Unix-based systems), it is likely that MoinMoin may be
1.15 - installed elsewhere
1.16 + installed elsewhere.
1.17 +
1.18 +site_packages The location of a directory which is either a Python
1.19 + site-packages directory or something providing a selection
1.20 + of different Python packages. If Python packages are
1.21 + installed outside the 'prefix' area, perhaps due to a
1.22 + distribution-specific mechanism, this setting should be
1.23 + used in addition to the 'prefix' setting. Otherwise, it can
1.24 + be omitted or left blank.
1.25
1.26 web_app_dir A directory where the moin.cgi program is (or will be)
1.27 installed.
1.28
1.29 web_static_dir A directory from which static resources are to be served.
1.30 This directory need only be specified in a limited hosting
1.31 - environment (see below for more details).
1.32 + environment (see below for more details), and only for
1.33 + MoinMoin 1.8.
1.34
1.35 web_site_dir The directory where sites available to the Apache Web
1.36 server are defined. This directory may just be a place
1.37 @@ -61,12 +66,38 @@
1.38 common_dir The directory in which the Wiki instance being configured
1.39 or managed resides (or will reside).
1.40
1.41 +farm_config A specific Wiki farm configuration file for multiple Wiki
1.42 + deployments. This overrides the 'common_dir' setting if
1.43 + used, indicating that a Wiki farm configuration must be
1.44 + edited when configuring a Wiki.
1.45 +
1.46 +site_config A specific configuration file location for a Wiki deployed
1.47 + within a Wiki farm. This overrides the 'common_dir' setting
1.48 + if used.
1.49 +
1.50 url_path The URL path (after the host details) of the Wiki.
1.51 +
1.52 superuser The superuser of the Wiki.
1.53 +
1.54 site_name The name of the Wiki.
1.55 +
1.56 +site_identifier An identifier used to refer to the site, typically derived
1.57 + from 'site_name' if left unspecified, and only really of use
1.58 + when an Apache site file needs to be written. In limited
1.59 + hosting environments, this setting has no effect.
1.60 +
1.61 front_page_name The name of the Wiki's front page.
1.62 +
1.63 theme_default The default theme of the Wiki.
1.64
1.65 +Working with MoinMoin System Installations
1.66 +------------------------------------------
1.67 +
1.68 +Where MoinMoin has already been installed using a package supplied by an
1.69 +operating system distribution (such as Debian, Red Hat, Ubuntu), there is no
1.70 +need to install the software itself. However, it is still necessary to set up
1.71 +Wiki instances.
1.72 +
1.73 Limited Hosting Environments
1.74 ----------------------------
1.75
1.76 @@ -86,62 +117,81 @@
1.77 web_static_dir = /path/to/www/htdocs
1.78 web_site_dir =
1.79
1.80 -Inside the static resources directory, a subdirectory will be created to hold
1.81 -any static content used by MoinMoin.
1.82 +If the web_static_dir setting is left blank, the static resources will be
1.83 +placed alongside the CGI script. Some environments have .cgi files served as
1.84 +CGI scripts and other files served statically.
1.85 +
1.86 +Inside the directory used to hold static resources, a subdirectory will be
1.87 +created to hold the static content used by MoinMoin.
1.88 +
1.89 +Wiki Farm Environments
1.90 +----------------------
1.91 +
1.92 +MoinMoin supports the notion of a Wiki farm where a single common configuration
1.93 +is overridden by configurations for individual Wiki instances. To work in such
1.94 +environments, specify the configuration settings in moinsetup.cfg as follows:
1.95 +
1.96 +farm_config = /path/to/farmconfig.py
1.97 +site_config = /path/to/wikiname.py
1.98
1.99 Examples
1.100 --------
1.101
1.102 Some of the more useful invocation methods are described below using examples.
1.103
1.104 -To set up MoinMoin and a Wiki instance:
1.105 +To set up MoinMoin and a Wiki instance (useful when installing MoinMoin
1.106 +yourself):
1.107
1.108 - python moinsetup.py setup
1.109 + python moinsetup.py -m setup
1.110
1.111 -To only set up a Wiki instance using a different configuration file:
1.112 +To set up only a Wiki instance (useful on a system with MoinMoin installed):
1.113 +
1.114 + python moinsetup.py -m setup_wiki
1.115
1.116 - python moinsetup.py -f new_wiki.cfg setup_wiki
1.117 +To set up only a Wiki instance, but using a different configuration file:
1.118 +
1.119 + python moinsetup.py -f mywiki.cfg -m setup_wiki
1.120
1.121 To change a Wiki configuration setting (for example, the default theme):
1.122
1.123 - python moinsetup.py reconfigure_moin theme_default mercurialwiki
1.124 + python moinsetup.py -m reconfigure_moin theme_default mercurialwiki
1.125
1.126 To install a theme from a directory containing a theme module, css and img
1.127 directories (for example, MercurialWikiTheme):
1.128
1.129 - python moinsetup.py install_theme /path/to/MercurialWikiTheme/themes/mercurialwiki
1.130 + python moinsetup.py -m install_theme /path/to/MercurialWikiTheme/themes/mercurialwiki
1.131
1.132 To install an extension package from a directory containing a setup.py script
1.133 (for example, EventAggregator):
1.134
1.135 - python moinsetup.py install_extension_package /path/to/EventAggregator
1.136 + python moinsetup.py -m install_extension_package /path/to/EventAggregator
1.137
1.138 To install actions from a directory containing action modules:
1.139
1.140 - python moinsetup.py install_actions /path/to/EventAggregator/actions
1.141 + python moinsetup.py -m install_actions /path/to/EventAggregator/actions
1.142
1.143 To install macros from a directory containing macro modules:
1.144
1.145 - python moinsetup.py install_macros /path/to/EventAggregator/macros
1.146 + python moinsetup.py -m install_macros /path/to/EventAggregator/macros
1.147
1.148 To install theme-related resources for an extension from a directory
1.149 containing css and img directories:
1.150
1.151 - python moinsetup.py install_theme_resources /path/to/EventAggregator
1.152 + python moinsetup.py -m install_theme_resources /path/to/EventAggregator
1.153
1.154 To add theme-related resources to existing stylesheets (for example, adding
1.155 the event-aggregator.css resource to the screen.css stylesheet for all
1.156 installed themes):
1.157
1.158 - python moinsetup.py edit_theme_stylesheet screen.css event-aggregator.css
1.159 + python moinsetup.py -m edit_theme_stylesheet screen.css event-aggregator.css
1.160
1.161 To make a page package containing pages to be added to a Wiki:
1.162
1.163 - python moinsetup.py make_page_package pages_dir pages.zip
1.164 + python moinsetup.py -m make_page_package pages_dir pages.zip
1.165
1.166 To install a page package in a Wiki:
1.167
1.168 - python moinsetup.py install_page_package pages.zip
1.169 + python moinsetup.py -m install_page_package pages.zip
1.170
1.171 Contact, Copyright and Licence Information
1.172 ------------------------------------------
1.173 @@ -171,9 +221,24 @@
1.174 New in moinsetup 0.3 (Changes since moinsetup 0.2)
1.175 --------------------------------------------------
1.176
1.177 - * Added a moin_data setting and made moin_distribution optional so that when
1.178 - MoinMoin is installed from a system package, the non-installation actions
1.179 - can still be performed.
1.180 + * Changed the command syntax to require -m (or --method=) before method
1.181 + names; improved the error reporting when settings are missing or
1.182 + inappropriate.
1.183 + * Flattened the Wiki instance hierarchy, putting the configuration, data,
1.184 + underlay and htdocs in the same top-level directory.
1.185 + * Changed the location of MoinMoin 1.9 resources, installing them in the
1.186 + prefix hierarchy and copying only static resources into Wiki instances.
1.187 + * Changed the handling of static resources with MoinMoin 1.9 to serve them
1.188 + separately just as MoinMoin 1.8 does; this makes performance much better
1.189 + when CGI is used under Apache.
1.190 + * Moved the editing of the moin script into the setup method so that no
1.191 + attempt is made to edit system programs.
1.192 + * Made moin_distribution optional so that when MoinMoin is installed from a
1.193 + system package, the non-installation actions can still be performed using
1.194 + shared data typically found in /usr/share/moin.
1.195 + * Added support for Wiki farms, separate library/site-packages directories,
1.196 + and site identifiers (based on site names).
1.197 + * Improved the MoinMoin version detection.
1.198
1.199 New in moinsetup 0.2 (Changes since moinsetup 0.1)
1.200 --------------------------------------------------