Changeset 1887

Timestamp:

02/03/07 23:48:24 (1 year ago)

Author:

moseley

Message:

Update the script to generate httpd.conf
refresh the README to better describe the process of building the

site from scratch

TODO:

update the search script to search the archive -- so
there's only one script.

I finally realized why the archive search was separate and why
the hypermail archive was so ugly -- because the docs need to be
available locally in the distribution. So the external style sheet
won't work.

Also, at one time there was a "make search" Makefile target where someon
could index their local docs. The website archive search used this, too.
Good way to test that it works. So, need to look at how the docs are
available in the tarball (style sheets, headers, graphics, etc.)
Might be smart to use a different set of templates when generating
the tarball docs.

Yuck.

Looks like the site isn't going to get updated this weekend after all.

Files:

• swish_website/README (modified) (10 diffs)
• swish_website/bin/build (modified) (9 diffs)
• swish_website/etc/httpd.conf.tt (added)
• swish_website/etc/swish.config (modified) (1 diff)
• swish_website/lib/config/site (modified) (1 diff)

swish_website/README

@@ -8 +8 @@
-to review and then check in.
-
+Prerequisites
+-------------
+
+    HTML-Parser-3.56
+    HTML-Tree-3.23
+    HTML-FillInForm-1.06
+    hypermail-2.1.8
+    Pod-POM-0.17
+    swish-e-2.4.5
+    Template-Toolkit-2.15
+
+There are likely other dependencies, depending on your systems base
+configuration.
+
+Note, the versions were the current CPAN versions and don't necessarily reflect
+dependencies.
+
+
-Overview
---------
-
-The website generation has a few dependencies.  There are scripts to generate
-
+
+
-
-    - swish-e current release source
@@ -21 +40 @@
-
-    - archive (hypermail)
+        Not actually required to build the site, as the site just
+        points to the hypermail archive.  But, might in the future
+        use a single script to display the archive then it would be
+        a true dependency.
+
-        currently, procmail feeds new posts to hypermail to
-        add new posts to the archive.  The posts are also archived
-        in the "mbox" directory by month in mbox format.
-
-archive index
+indexes
-        When the archive is updated a flag is set and then cron
-
+
+
-
-    - swish-daily
@@ -41 +66 @@
--------------------
-
-
+
+
+
+
-
-        swish_daily_build/          - where the daily builds are created
@@ -55 +83 @@
-        indexes/                    - indexes for the archive and website
-
-        swish_website/              - source for building the site (more below)
-
-        pubilc_html                 - bulk of generated website.
-
-
-
-
+
+
+
+
+
+
+
+
+
-
-
@@ -73 +106 @@
-    But, to build a daily tarball that include the HTML docs the website code
-    needs to be installed.
+
+    So, the swish_website needs to be checked out from subversion first.
-
-    The swish-e configure script looks for the program "build-swish-docs" in the
@@ -92 +127 @@
-        The website isn't generated yet, but the code is needed before
-        building the daily tarballs.
+
+        This example places swish_website below $ROOT.  This is not a requirement,
+        but is nice if you want to keep everything in one place.
-
-            cvn co http://svn.swish-e.org/swish_website/ $ROOT/swish_website
@@ -192 +230 @@
-
-
+
+    public_html
+    -----------
+        Now the website can be created.  The bin/build script is used
+        to generate the website.  The script will detect when files
+        need to be generated, or passing --all will tell it to generate
+        the complete site.
+
+        There are a lot of options, and running build --help will list them.
+        The same build script is used when building from cvs to generate the
+        html docs for the tarball.
+
+        If the directories above are all in $ROOT and use the same names as
+        above, then the script can be called like this:
+
+            $ROOT/swish_website/bin/build --root $ROOT --all
+
+        (The --all is optional)
+
+        This is the same as calling the script and explicitly setting
+        all the directories:
+
+
+            $ROOT/swish_website/bin/build \
+                --dest      $ROOT/public_html \
+                --indexes   $ROOT/indexes \
+                --swishsrc  $ROOT/swish_release_build/latest_swish_build/source \
+                --develsrc  $ROOT/swish_daily_build/latest_swish_build/source \
+                --download  $ROOT/distribution \
+                --daily     $ROOT/swish-daily \
+                --all
+
+
+
+        httpd.conf
+        ----------
+
+            Setting up Apache is just a matter of pointing
+            Apache at public_html, and creating aliases
+            for the distribution, swish-daily, and the archive directories.
+
+            The same bin/build script can be used to generate an httpd.conf file.
+
+                $ROOT/swish_website/bin/build --root $ROOT --apache > httpd.conf
+
+
+            For debugging locally, say just the web site
+
+
+                $ROOT/swish_website/bin/build \
+                    --root      $ROOT \
+                    --apache    \
+                    --port      8080 \
+                    --ipaddr    `hostname` \
+                    --domain    `hostname` \
+                    --nodev_site \
+                    --nolists_site \
+                    --nosvn_site \
+                > httpd.test
+
+            The only reason to disable sites might be if you don't have
+            the modules installed locally.
+
+
+
-    indexes
-    -------
@@ -198 +301 @@
-        another for the website.
-
-
+
+
-
-            mkdir $ROOT/indexes
@@ -214 +318 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-    ./
-        -> src              - web source docs.
-        -> public_html      - output files.  This is DocumentRoot
-            distribution        - symlink to the swish-releases tarball directory[1]
-            swish-daily         - symlink to swish-daily tarball directory
-        -> bin              - bin/build script and other utilities
-        -> lib/config       - site config templates.
@@ -282 +437 @@
-        -> lib/pod_toc      - top-level index for pod docs
-
-[1] these two (three including the "old" dir) directories are read when
-building the index listings for the downloads, plus they must be available via
-the /distribution and /swish-daily URLs.  Originally, these were outside of
-document root (public_html) in dirs_public and accessed with Alias in
-httpd.conf.  And lib/config/site set their locations for generating the
-index.html pages listing the files.
-
-
-Requirements
-------------
-
-    Swish-e must be installed on the system and the program
-    swish-config must be in the path -- this is used to find where
-    helpers (e.g. perl modules) are installed.
-
-
-Building the site
------------------
-
-    Check out the "swish_website" project from CVS.  Once checked out you need to
-    initialize a few directories, and then build the site.
-
-        $ cd swish_website
-        $ mkdir -p public_html dirs_public/download/old dirs_public/swish-daily
-        $ bin/build -swishsrc=$HOME/swish-e -develsrc=$HOME/swish-e -archive=archive/index.swish-e
-
-    (Or symlink as needed -- which is what I did.)
-
-    Also in lib/config/site you might want to define where swish-daily and
-    the download dirs are set.  Currently to /distribution and /swish-daily.
-    The download and swish-daily pages link files to those dirs.
-
-    You need Template Toolkit, Pod::POM (from CPAN) and anything else it
-    complains about.
-
-    Those output directories can be overridden.  see bin/build --help  for
-    help.  "dirs_public" can be set in lib/conifg/site.
-
-    From the top-level directory* (where this README file is located)
-    run:
-
-        bin/build -all -swishsrc=$HOME/swish-e -v
-
-    (assuming that's where the swish-e source is located)
-
-    That builds both the website and the pod docs and writes them
-    to the "public_html" directory.
-
-    * Actually, from anywhere -- directories are determined relative to
-    where the /bin/build program is found.
-
-    Running without the -all switch will cause only the changed files to be
-    rebuilt.  Normally you run with -all.
-
-    Note: the docs/index.html file can only be correctly built if ALL the pods
-    are processed (using -all).  So do not rm public_html/docs/index.html and expect
-    it to be rebuilt automatically.
-
-    For a bit more info, run:
-
-        bin/build -help
-
-

swish_website/bin/build

@@ -4 +4 @@
-use warnings;
-use FindBin qw'$Bin $RealBin';
+use Template;
-
-
@@ -72 +73 @@
-
-
+my @argv = @ARGV;  # save for later.
+
+
+my %default_paths = (  # relative to --root
+    dest        => 'public_html',
+    indexes     => 'indexes',
+    swishsrc    => 'swish_release_build/latest_swish_build/source',
+    develsrc    => 'swish_daily_build/latest_swish_build/source',
+    download    => 'distribution',
+    daily       => 'swish-daily',
+    archive     => 'archive',
+);
+
+
+
-
-my %default_config = (
-
-
-
-
-
-
-
+
+
+
+
+
-                          # added to INCLUDE_PATH
+    web_site    => 1,
+    dev_site    => 1,
+    lists_site  => 1,
+    svn_site    => 1,
-);
-
@@ -91 +109 @@
-$0 usage:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    -src=<dir>      = top-level directory of website source
-                      Default: $default_config{src}
-                      \$src/src and \$src/lib are INCLUDE_PATH
-    -dest=<dir>     = destination directory for website
-                      Default: $default_config{dest}
-    -swishsrc=<dir> = toplevel directory of swish-e source package
-    -poddest        = where pods are stored (must set -swishsrc)
-                      Setting poddest will disable website generation
-                      Default: $default_config{poddest}
-    -podonly        = says do not write website files, only pod files
-                      (set automatically when -poddest != website dir
-
-
-
-
+
-    -websitesrc     = default dir where website src content is located
-                      Default: $default_config{websitesrc}
-                      Should never be used.
-
-    -develsrc=<src> = Directory of development.
-
-    -archive=<dir>  = Path to directory where indexes are stored
-    -download=<dir> = Path to directory where downloads are located
-    -daily=<dir>    = Path to directory where daily builds are located
-
-    -- options you don't need --
@@ -153 +172 @@
-
-
+    -- Apache config file generation -
+    (Defaults are set in the template and may not match below)
+
+    -apache         = Only generate Apache configuration file.
+                      The file is sent to stdout.
+
+    domain          = Override the domain name [swish-e.org]
+    module_dir      = Location of Apache modules [modules]
+    user            = Apache user [apache]
+    group           = Apache group [apache]
+    logs            = Location of log files [logs]
+    pid_file        = Location of apache pid file [run/httpd.pid]
+    ipaddr          = IP address for Listen statement [*]
+    port            = Port to listen on [80]
+    trac_doc_root   = Path do DocumentRoot for trac [/opt/trac/htdocs]
+    trac_env        = Trac environment [/opt/trac]
+    trac_password   = Trac password file [/opt/svn/swish/conf/dav_svn.passwd]
+    svn_repo        = Path to Subversion Repository [/opt/svn/swish]
+
+    web_site        = Boolean to include website [true]
+    dev_site        = Boolean to include trac site [true]
+    lists_site      = Boolean to include mailman site [true]
+    svn_site        = Boolean to include svn repo [true]
+
+
-    Script exits false (1) if no files are actually processed.
-    Exits false even if -all -dryrun is used.
@@ -164 +208 @@
-
-my @options = qw(
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-);
-
@@ -205 +272 @@
-
-
+
+# Set defaults
+
+if ( $config->{root} )  {
+    my $root = File::Spec->rel2abs( $config->{root} );
+
+    for my $option ( keys %default_paths ) {
+        next if $config->{$option};
+        my $dir = File::Spec->catfile( $root, $default_paths{$option} );
+
+        if ( -d $dir ) {
+            $config->{$option} = $dir;
+        } else {
+            warn "Could not set option '--$option=$dir': $!\n";
+        }
+    }
+}
+
+
+
-$config->{poddest} = File::Spec->catfile( $config->{dest}, 'docs' )
-    unless $config->{poddest};
+
+
+# Generate apache config
+if ( $config->{apache} ) {
+
+    my $tt = Template->new(
+        INCLUDE_PATH => File::Spec->catfile( $config->{src}, 'etc' ),
+    );
+
+    my $stash = {
+        %$config,
+        script      => $0,
+        arguments   => join( ' ', @argv ),
+    };
+
+    my $template = $config->{template} || 'httpd.conf.tt';
+
+    $tt->process( $template, $stash ) || die $tt->error;
+
+    exit 0;
+}
+
-
-
@@ -270 +379 @@
-
-
-
+e
-    my @includes = map { 
-                    File::Spec->file_name_is_absolute( $_ )
@@ -332 +441 @@
-
-
-archive
-archive
-archive
-List archive index [$index]
-archive
+indexes
+indexes
+indexes
+indexes setting of [$index] is
+indexes
-    }
-
@@ -760 +869 @@
-    no strict 'refs';
-    for (@$options ) {
-
+_
-        my $method = $1;
-        *{$method} = sub { return shift->{$method} || undef };

swish_website/etc/swish.config

@@ -9 +9 @@
-PropertyNames section
-
-IndexFile public_html/search/index.swish-e
-
-# Add these metanames to allow searching list archive, too

swish_website/lib/config/site

@@ -36 +36 @@
-    swish = {
-        current_version     = this.swish_current_version || '2.4.5'
-'index
-archive
+self.config.indexes _ '/archive
+indexes _ '/index.swish-e'
-        version             = this.swish_version
-    };