moinsetup

README.txt

58:a5aec502083f
2012-07-10 Paul Boddie Added support for separate static resources URL paths. Fixed .htaccess positioning where static resource directories are in use. Added edit/event log file ownership/permissions configuration in the postinstall scripts.
     1 Introduction
     2 ------------
     3 
     4 The moinsetup script is a utility separate from MoinMoin which attempts to
     5 assist in the configuration and deployment of MoinMoin and extensions. It can
     6 automate the installation of MoinMoin according to recommended practices,
     7 create and initialise new Wiki instances, install extensions, themes and
     8 related resources, and perform certain configuration changes.
     9 
    10 Important Notices
    11 -----------------
    12 
    13 Release 0.3 of moinsetup changes the Wiki instance directory hierarchy so that
    14 the top-level directory, instead of containing the conf and wikidata
    15 directories, contains the Wiki configuration file (unless located elsewhere -
    16 see the site_config setting) plus data, underlay and htdocs directories. See
    17 the migration section below for details.
    18 
    19 Release 0.3 also changes the moinsetup command syntax to require -m (or
    20 --method=) before method names. This fixes a critical ambiguity issue with
    21 option processing.
    22 
    23 Usage
    24 -----
    25 
    26 Running moinsetup as follows will provide a list of methods available:
    27 
    28   python moinsetup.py
    29 
    30 Before any work can be done by the program, a configuration file needs to be
    31 created. See the supplied moinsetup.cfg file for an example file which can
    32 be modified and used for this purpose.
    33 
    34 An alternative configuration file is specified using the -f option:
    35 
    36   python moinsetup.py -f mywiki.cfg
    37 
    38 Configuration files provide information about the MoinMoin installation and a
    39 particular Wiki instance and Web site where the instance is published.
    40 
    41 Migration from moinsetup 0.2
    42 ----------------------------
    43 
    44 The Wiki instance directory hierarchy has changed in moinsetup 0.3 as
    45 illustrated below:
    46 
    47 wiki (old)
    48   conf
    49     (wikiconfig.py)
    50     data
    51     underlay
    52   wikidata
    53     ... (htdocs)
    54 
    55 wiki (new)
    56   (wikiconfig.py)
    57   data
    58   underlay
    59   (htdocs)
    60 
    61 Since the contents of wikidata is generally superfluous, since the files are
    62 mostly shared resources, that directory is no longer created and such shared
    63 resources are no longer copied into it. The htdocs directory is copied since
    64 it can be convenient to maintain a separate collection of static files so that
    65 they can be updated with theme-related changes without modifying common system
    66 files.
    67 
    68 To migrate old Wiki instance layouts, run the following command:
    69 
    70   python moinsetup.py -m migrate_instance
    71 
    72 Add an optional argument after the method name to run the migration method in
    73 test mode:
    74 
    75   python moinsetup.py -m migrate_instance test
    76 
    77 This will just print the actions to be taken when migrating the instance.
    78 
    79 Configuration
    80 -------------
    81 
    82 The configuration file has two sections: "installation" and "site". A brief
    83 description of the settings is given below.
    84 
    85 Installation settings influence the configuration, installation and
    86 customisation of a Wiki and are generally not optional:
    87 
    88 moin_distribution   A path to a MoinMoin distribution directory, which can
    89                     also be a clone of a MoinMoin repository.
    90 
    91 prefix              The directory prefix containing lib, bin and share
    92                     directories where MoinMoin is (or will be) installed.
    93                     Although this follows the layout of the /usr directory (on
    94                     Unix-based systems), it is likely that MoinMoin may be
    95                     installed elsewhere.
    96 
    97 site_packages       The location of a directory which is either a Python
    98                     site-packages directory or something providing a selection
    99                     of different Python packages. If Python packages are
   100                     installed outside the 'prefix' area, perhaps due to a
   101                     distribution-specific mechanism, this setting should be
   102                     used in addition to the 'prefix' setting. Otherwise, it can
   103                     be omitted or left blank.
   104 
   105 web_app_dir         A directory where the moin.cgi program is (or will be)
   106                     installed.
   107 
   108 web_static_dir      A directory from which static resources are to be served.
   109                     This directory need only be specified in a limited hosting
   110                     environment (see below for more details).
   111 
   112 web_site_dir        The directory where sites available to the Apache Web
   113                     server are defined. This directory may just be a place
   114                     where initial site definitions are written, and after
   115                     manual editing, such definitions may be copied to the
   116                     appropriate location. If this directory is left
   117                     unspecified, a limited hosting environment will be
   118                     assumed.
   119 
   120 Except for the common_dir setting, site settings are generally only relevant
   121 when configuring and installing a Wiki:
   122 
   123 common_dir          The directory in which the Wiki instance being configured
   124                     or managed resides (or will reside).
   125 
   126 farm_config         A specific Wiki farm configuration file for multiple Wiki
   127                     deployments. This overrides the 'common_dir' setting if
   128                     used, indicating that a Wiki farm configuration must be
   129                     edited when configuring a Wiki.
   130 
   131 site_config         A specific configuration file location for a Wiki deployed
   132                     within a Wiki farm. This overrides the 'common_dir' setting
   133                     if used.
   134 
   135 url_path            The URL path (after the host details) of the Wiki.
   136 
   137 static_url_path     The URL path (after the host details) of the Wiki's static
   138                     resources. This is only required if a limited hosting
   139                     environment enforces separate "htdocs" and "cgi-bin"
   140                     directories, and the static resources must be placed in
   141                     the "htdocs" directory.
   142 
   143 superuser           The superuser of the Wiki.
   144 
   145 site_name           The name of the Wiki.
   146 
   147 site_identifier     An identifier used to refer to the site, typically derived
   148                     from 'site_name' if left unspecified, and only really of use
   149                     when an Apache site file needs to be written. In limited
   150                     hosting environments, this setting has no effect.
   151 
   152 front_page_name     The name of the Wiki's front page.
   153 
   154 theme_default       The default theme of the Wiki.
   155 
   156 Working with MoinMoin System Installations
   157 ------------------------------------------
   158 
   159 Where MoinMoin has already been installed using a package supplied by an
   160 operating system distribution (such as Debian, Red Hat, Ubuntu), there is no
   161 need to install the software itself. However, it is still necessary to set up
   162 Wiki instances. The moinsetup.cfg.debian file in the examples directory could
   163 be used as a starting point for configuring Wiki instances on Debian systems.
   164 
   165 Limited Hosting Environments
   166 ----------------------------
   167 
   168 Sometimes, the hosting environment in which MoinMoin is to be deployed will be
   169 restrictive or "limited", meaning that substantial configuration of the Web
   170 server will not be possible for the user installing and configuring MoinMoin.
   171 In such environments, users will typically be allowed to install content in
   172 preconfigured directories for static and dynamic content. For example:
   173 
   174 /path/to/www/cgi-bin    a dynamic content directory, providing CGI scripts
   175 /path/to/www/htdocs     a static content directory, providing Web pages
   176 
   177 To work in such environments, specify the configuration settings in
   178 moinsetup.cfg as follows:
   179 
   180 web_app_dir     = /path/to/www/cgi-bin
   181 web_static_dir  = /path/to/www/htdocs
   182 web_site_dir    =
   183 
   184 url_path        = /mysite/cgi-bin
   185 static_url_path = /mysite
   186 
   187 If the web_static_dir setting is left blank, the static resources will be
   188 placed alongside the CGI script. Some environments have .cgi files served as
   189 CGI scripts and other files served statically; in such cases, static_url_path
   190 can also be left blank.
   191 
   192 Inside the directory used to hold static resources, a subdirectory will be
   193 created to hold the static content used by MoinMoin.
   194 
   195 Wiki Farm Environments
   196 ----------------------
   197 
   198 MoinMoin supports the notion of a Wiki farm where a single common configuration
   199 is overridden by configurations for individual Wiki instances. To work in such
   200 environments, specify the configuration settings in moinsetup.cfg as follows:
   201 
   202 farm_config     = /path/to/farmconfig.py
   203 site_config     = /path/to/wikiname.py
   204 
   205 Examples
   206 --------
   207 
   208 Some of the more useful invocation methods are described below using examples.
   209 
   210 To set up MoinMoin and a Wiki instance (useful when installing MoinMoin
   211 yourself):
   212 
   213   python moinsetup.py -m setup
   214 
   215 To set up only a Wiki instance (useful on a system with MoinMoin installed):
   216 
   217   python moinsetup.py -m setup_wiki
   218 
   219 To set up only a Wiki instance, but using a different configuration file:
   220 
   221   python moinsetup.py -f mywiki.cfg -m setup_wiki
   222 
   223 To change a Wiki configuration setting (for example, the default theme):
   224 
   225   python moinsetup.py -m reconfigure_moin theme_default mercurialwiki
   226 
   227 To install a theme from a directory containing a theme module, css and img
   228 directories (for example, MercurialWikiTheme):
   229 
   230   python moinsetup.py -m install_theme /path/to/MercurialWikiTheme/themes/mercurialwiki
   231 
   232 To install an extension package from a directory containing a setup.py script
   233 (for example, EventAggregator):
   234 
   235   python moinsetup.py -m install_extension_package /path/to/EventAggregator
   236 
   237 To install actions from a directory containing action modules:
   238 
   239   python moinsetup.py -m install_actions /path/to/EventAggregator/actions
   240 
   241 To install macros from a directory containing macro modules:
   242 
   243   python moinsetup.py -m install_macros /path/to/EventAggregator/macros
   244 
   245 To install theme-related resources for an extension from a directory
   246 containing css and img directories:
   247 
   248   python moinsetup.py -m install_theme_resources /path/to/EventAggregator
   249 
   250 To add theme-related resources to existing stylesheets (for example, adding
   251 the event-aggregator.css resource to the screen.css stylesheet for all
   252 installed themes):
   253 
   254   python moinsetup.py -m edit_theme_stylesheet screen.css event-aggregator.css
   255 
   256 To make a page package containing pages to be added to a Wiki:
   257 
   258   python moinsetup.py -m make_page_package pages_dir pages.zip
   259 
   260 To install a page package in a Wiki:
   261 
   262   python moinsetup.py -m install_page_package pages.zip
   263 
   264 Contact, Copyright and Licence Information
   265 ------------------------------------------
   266 
   267 See the following Web page for more information about this work:
   268 
   269 http://moinmo.in/ScriptMarket/moinsetup
   270 
   271 The author can be contacted at the following e-mail address:
   272 
   273 paul@boddie.org.uk
   274 
   275 Copyright and licence information can be found in the docs directory - see
   276 docs/COPYING.txt and docs/gpl-3.0.txt for more information.
   277 
   278 Dependencies
   279 ------------
   280 
   281 moinsetup has the following basic dependencies:
   282 
   283 Packages                    Release Information
   284 --------                    -------------------
   285 
   286 CMDsyntax                   Tested with 0.91
   287                             Source: http://www.boddie.org.uk/david/Projects/Python/CMDSyntax/index.html
   288 
   289 New in moinsetup 0.4 (Changes since moinsetup 0.3)
   290 --------------------------------------------------
   291 
   292   * Added edit and event log permissions/ownership commands to the postinstall
   293     scripts.
   294   * Fixed the .htaccess file location for limited hosting environments, using
   295     the static resources directory in preference to the application directory.
   296   * Added support for separate static URL paths enforced by limited hosting
   297     environments.
   298 
   299 New in moinsetup 0.3 (Changes since moinsetup 0.2)
   300 --------------------------------------------------
   301 
   302   * Changed the command syntax to require -m (or --method=) before method
   303     names; improved the error reporting when settings are missing or
   304     inappropriate.
   305   * Flattened the Wiki instance hierarchy, putting the configuration, data,
   306     underlay and htdocs in the same top-level directory. (See the migration
   307     section in the documentation for information on updating the hierarchy.)
   308   * Changed the location of MoinMoin 1.9 resources, installing them in the
   309     prefix hierarchy and copying only static resources into Wiki instances.
   310   * Changed the handling of static resources with MoinMoin 1.9 to serve them
   311     separately just as MoinMoin 1.8 does; this makes performance much better
   312     when CGI is used under Apache.
   313   * Moved the editing of the moin script into the setup method so that no
   314     attempt is made to edit system programs.
   315   * Made moin_distribution optional so that when MoinMoin is installed from a
   316     system package, the non-installation actions can still be performed using
   317     shared data typically found in /usr/share/moin.
   318   * Added support for Wiki farms, separate library/site-packages directories,
   319     and site identifiers (based on site names).
   320   * Improved the MoinMoin version detection.
   321   * Added an event handler installation action.
   322 
   323 New in moinsetup 0.2 (Changes since moinsetup 0.1)
   324 --------------------------------------------------
   325 
   326   * Improved OpenID configuration, supporting MoinMoin 1.9, and added support
   327     for other authentication methods.
   328   * Added support for ACL-capable filesystems when setting Wiki permissions.
   329     It can be more convenient to retain read/write access to the installed
   330     files while also granting the Web server user (who need not be in a common
   331     group) access to read and modify the files.
   332   * Added support for configurations employing a separate static resources
   333     directory (such as a typical "htdocs" directory).
   334   * Added a parser installation action.
   335   * Added support for page attachments in the page-packaging action.
   336 
   337 Release Procedures
   338 ------------------
   339 
   340 Update the moinsetup.py __version__ attribute.
   341 Change the version number and package filename/directory in the documentation.
   342 Update the release notes (see above).
   343 Tag, export.
   344 Archive, upload.
   345 Update the ScriptMarket (see above for the URL).