web commit by http://id.loopysoft.com/matt/

1 files changed, 180 insertions, 0 deletions

diff --git a/doc/SharedHosting.mdwn b/doc/SharedHosting.mdwn
new file mode 100644
index 000000000..b2b3fe296
--- /dev/null
+++ b/doc/SharedHosting.mdwn
@@ -0,0 +1,180 @@
+# Introduction
+I had some trouble installing ikiwiki on to a shared hosting service (DreamHost) and figured I'd post the results, since it was pretty rough to get installed.  These instructions should work for Perl generally (some of the docs are borrowed from Catalyst's docs), but are tailored for Ikiwiki.  There are a few items I'll file as bugs, as well, to aid future installation, but frankly the problems appear to be with installing perl as a non-root user, not anything specific to iki.
+
+**Note: CPAN seems to die without warning, or die after successfully install modules.  It appears to just like dying.  If you encounter this, retry the last command after restarting CPAN.** Unfortunately, this doc can't cover how to fix any other problems with CPAN beyond what you find here.
+
+# Fixing CPAN
+[These instructions are paraphrased from Catalyst's documentation](http://dev.catalystframework.org/wiki/Dreamhost) :
+
+We're going to assume that you're installing CPAN and other Perl modules into ~/site/perl.
+
+In your .bashrc/.bash_profile/.profile, add:
+
+    export PERL5LIB=~/site/perl/share/perl/5.8:~/site/perl/share/perl/5.8.4:~/site/perl/lib/perl5:~/site/perl/lib/perl/5.8.4
+
+You probably want to add *~/site/perl/bin/* to your path, as well, since Ikiwiki's scripts are put in there.
+
+Make sure to source your modified file (or logout/login).  Next, run :
+
+    perl -MCPAN -e shell 
+
+and say no to manual configuration.  (Ed : I assume this sets up a basic CPAN with the existing site config.)
+
+Exit CPAN shell and restart, then run :
+
+    o conf makepl_arg PREFIX=~/site/perl
+    o conf commit
+    install CPAN
+
+Exit CPAN shell and restart, say no to manual configuration.  Note that I used defaults except for the mbuildpl_arg parameter, which I set to *--install-base=~/site/perl/*.  I believe this obviates the need for the first configuration parameter in the next section, but if you're paranoid, specify both (note added to next section).  My output looked like this :
+
+    user@server:~$ perl -MCPAN -e shell
+    Sorry, we have to rerun the configuration dialog for CPAN.pm due to 
+    some missing parameters...
+
+    Normally CPAN.pm keeps config variables in memory and changes need to
+    be saved in a separate 'o conf commit' command to make them permanent
+    between sessions. If you set the 'auto_commit' option to true, changes
+    to a config variable are always automatically committed to disk.
+
+     <auto_commit>
+    Always commit changes to config variables to disk? [no] 
+
+    A Build.PL is run by perl in a separate process. Likewise we run
+    './Build' and './Build install' in separate processes. If you have any
+    parameters you want to pass to the calls, please specify them here.
+
+    Typical frequently used settings:
+
+        --install_base /home/xxx             # different installation directory
+
+     <mbuildpl_arg>
+    Parameters for the 'perl Build.PL' command? [] --install-base=~/site/perl/
+
+    Parameters for the './Build' command? Setting might be:
+
+        --extra_linker_flags -L/usr/foo/lib  # non-standard library location
+
+     <mbuild_arg>
+    Your choice: [] 
+
+    Do you want to use a different command for './Build install'? Sudo
+    users will probably prefer:
+
+        su root -c ./Build
+     or
+        sudo ./Build
+     or
+        /path1/to/sudo -u admin_account ./Build
+
+     <mbuild_install_build_command>
+    or some such. Your choice: [./Build] 
+
+    Parameters for the './Build install' command? Typical frequently used
+    setting:
+
+        --uninst 1                           # uninstall conflicting files
+
+     <mbuild_install_arg>
+    Your choice: [] 
+
+    Please remember to call 'o conf commit' to make the config permanent!
+
+    cpan shell -- CPAN exploration and modules installation (v1.9205)
+    ReadLine support enabled
+
+Next, run :
+
+    o conf mbuildpl_arg --install-base=~/site/perl (This may be optional, given the prior step to configure this)
+    o conf prefer_installer MB
+    o conf commit
+    install Module::Build
+
+After this step, you should have a working CPAN and Module::Build installed.  This is the starting point for being able to successfully install modules via CPAN.
+
+# Update old modules
+I updated particular modules out of paranoia.  Either installation errors (during previous installs) or notes on the web led me to install these.  If you know what you're doing, you can skip this, but if you're perl-fu is as weak as mine, you're better off installing them.
+
+    install File::BaseDir
+    install Module::Build
+    install File::Temp
+    install Digest::SHA
+    install YAML
+    install Test::Builder
+    install Test::Pod
+    install Test::Pod::Coverage
+
+# Install modules for Ikiwiki
+Install the modules required for Ikiwiki.  I install all of the ones required *and* suggested because most of what I want to do requires most of these modules.
+
+install Text::Markdown URI HTML::Parser HTML::Template
+install CGI CGI::Session CGI::FormBuilder
+install Mail::Sendmail Time::Duration HTML::Scrubber
+install RPC::XML XML::Simple XML::Feed File::MimeInfo Locale::gettext
+
+# Changes to Ikiwiki's build/install process
+An explanation of why each of these changes were made will follow these instructions.
+
+Modify Makefile.PL, find the line that looks like :
+
+    perl -Iblib/lib $(extramodules) $(tflag) ikiwiki.out -setup docwiki.setup -refresh
+
+add : 
+    
+    -I/home/user/site/perl/lib/perl5 
+
+You should be left with something that looks like :
+
+    perl -Iblib/lib -I/home/user/site/perl/lib/perl5 $(extramodules) $(tflag) ikiwiki.out -setup docwiki.setup -refresh
+
+Next, you'll need to pass the directory where you installed your perl modules (*~/site/perl/ in this example*) into the MakeMaker build script (verbose isn't required, but gives you more feedback since you're following along at home):
+
+    user@server:~/ikiwiki$ perl Makefile.PL PREFIX=~/site/perl/ verbose
+      MAN1PODS => {  }
+      NAME => q[IkiWiki]
+      PM_FILTER => q[./pm_filter $(PREFIX) $(VER) $(PROBABLE_INST_LIB)]
+      PREFIX => q[/home/flophouse/perl/]
+      PREREQ_PM => { URI=>q[0], HTML::Scrubber=>q[0], Time::Duration=>q[0], Data::Dumper=>q[2.11], HTML::Template=>q[0], XML::Simple=>q[0], 
+        Date::Parse=>q[0], CGI::FormBuilder=>q[], CGI::Session=>q[0], Mail::Sendmail=>q[0], HTML::Parser=>q[0], Text::Markdown=>q[0] }
+    Using PERL=/usr/bin/perl
+    Writing Makefile for IkiWiki
+
+Next, we'll need to [patch the bug described here](http://ikiwiki.info/bugs/Insecure_dependency_in_eval_while_running_with_-T_switch/index.html) (incidentally, this bug isn't on the bugs/ or bugs/done/ page, for some reason.  It's only findable via search).  Edit the Ikiwiki.pm file to look like below (line numbers prefix each line) :
+
+    1202         #my $ret=eval pagespec_translate($spec);
+    1203         my $ret=eval possibly_foolish_untaint(pagespec_translate($spec));
+
+At this point, you can run *make* and then *make install* (*make test* fails for reasons explained below).
+
+# Ikiwiki setup
+You can follow the normal installation process, excepting a few changes in your ikiwiki.setup documents.
+
+In ikiwiki.setup, you have to make your source and destination folders have your full *unsymlinked* home directory.  The home dir you see (/home/username) is actually a symlink from /home/.yourserver/username.  You need to find what this is and use that directly.  Run *ls -la* on ~ to find it, the output should look like :
+
+    [good]$ ls -la ~
+    lrwxrwxrwx  1 root staff 25 2007-08-03 16:44 /home/user -> /home/.server/user
+
+So far, it looks like only the source and destination parameters require this unsymlinked path, but for paranoia reasons, you may want to put them everywhere.
+
+Next, add your installed Perl module directory to the *libdir* parameter.  It should look something like :
+
+        #libdir => "/home/me/.ikiwiki/",
+        libdir => "/home/.server/user/site/perl/lib/perl5/",
+
+# CGI Wrapper
+The wrapper mode of "06755" doesn't seem to work.  "755" appears to.  However, this may be completely insecure and/or buggy, so if you know better than I, edit this doc and add it here.
+
+# Pre-created SVN repository
+DreamHost has a pretty installation and management GUI for SVN, but it means your SVN rep is pre-created.  As such, you can't use the installation script they mention in the setup document, because it creates the repository for you.  As such, you simply use the relevant portion of the script, but skip the repository creation.  That part (from the version I installed from, *make sure you check your file as well*) is : 
+
+        cd your/ikiwiki/source/dir/here
+        svn mkdir "file:///home/user/svn/yoursvnrepositoryhere/whereyouwanttoinstallto" -m "create trunk directory"
+        svn co "file://$repository/trunk" . # Note the dot, it's important
+        svn propset svn:ignore ".ikiwiki" . # Note the dot, it's important
+        svn add *
+        svn commit -m "initial import"
+
+# Why do I have to do all of this?
+IANA Perl Expert.  This is just what I found.
+
+http://schwern.org/~schwern/talks/PREFIX/slides/slide001.html