web commit by http://id.loopysoft.com/matt/
[ikiwiki.git] / doc / SharedHosting.mdwn
1 # Introduction
2 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.
3
4 **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.
5
6 # Fixing CPAN
7 [These instructions are paraphrased from Catalyst's documentation](http://dev.catalystframework.org/wiki/Dreamhost) :
8
9 We're going to assume that you're installing CPAN and other Perl modules into ~/site/perl.
10
11 In your .bashrc/.bash_profile/.profile, add:
12
13     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
14
15 You probably want to add *~/site/perl/bin/* to your path, as well, since Ikiwiki's scripts are put in there.
16
17 Make sure to source your modified file (or logout/login).  Next, run :
18
19     perl -MCPAN -e shell 
20
21 and say no to manual configuration.  (Ed : I assume this sets up a basic CPAN with the existing site config.)
22
23 Exit CPAN shell and restart, then run :
24
25     o conf makepl_arg PREFIX=~/site/perl
26     o conf commit
27     install CPAN
28
29 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 :
30
31     user@server:~$ perl -MCPAN -e shell
32     Sorry, we have to rerun the configuration dialog for CPAN.pm due to 
33     some missing parameters...
34
35     Normally CPAN.pm keeps config variables in memory and changes need to
36     be saved in a separate 'o conf commit' command to make them permanent
37     between sessions. If you set the 'auto_commit' option to true, changes
38     to a config variable are always automatically committed to disk.
39
40      <auto_commit>
41     Always commit changes to config variables to disk? [no] 
42
43     A Build.PL is run by perl in a separate process. Likewise we run
44     './Build' and './Build install' in separate processes. If you have any
45     parameters you want to pass to the calls, please specify them here.
46
47     Typical frequently used settings:
48
49         --install_base /home/xxx             # different installation directory
50
51      <mbuildpl_arg>
52     Parameters for the 'perl Build.PL' command? [] --install-base=~/site/perl/
53
54     Parameters for the './Build' command? Setting might be:
55
56         --extra_linker_flags -L/usr/foo/lib  # non-standard library location
57
58      <mbuild_arg>
59     Your choice: [] 
60
61     Do you want to use a different command for './Build install'? Sudo
62     users will probably prefer:
63
64         su root -c ./Build
65      or
66         sudo ./Build
67      or
68         /path1/to/sudo -u admin_account ./Build
69
70      <mbuild_install_build_command>
71     or some such. Your choice: [./Build] 
72
73     Parameters for the './Build install' command? Typical frequently used
74     setting:
75
76         --uninst 1                           # uninstall conflicting files
77
78      <mbuild_install_arg>
79     Your choice: [] 
80
81     Please remember to call 'o conf commit' to make the config permanent!
82
83     cpan shell -- CPAN exploration and modules installation (v1.9205)
84     ReadLine support enabled
85
86 Next, run :
87
88     o conf mbuildpl_arg --install-base=~/site/perl (This may be optional, given the prior step to configure this)
89     o conf prefer_installer MB
90     o conf commit
91     install Module::Build
92
93 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.
94
95 # Update old modules
96 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.
97
98     install File::BaseDir
99     install Module::Build
100     install File::Temp
101     install Digest::SHA
102     install YAML
103     install Test::Builder
104     install Test::Pod
105     install Test::Pod::Coverage
106
107 # Install modules for Ikiwiki
108 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.
109
110 install Text::Markdown URI HTML::Parser HTML::Template
111 install CGI CGI::Session CGI::FormBuilder
112 install Mail::Sendmail Time::Duration HTML::Scrubber
113 install RPC::XML XML::Simple XML::Feed File::MimeInfo Locale::gettext
114
115 # Changes to Ikiwiki's build/install process
116 An explanation of why each of these changes were made will follow these instructions.
117
118 Modify Makefile.PL, find the line that looks like :
119
120     perl -Iblib/lib $(extramodules) $(tflag) ikiwiki.out -setup docwiki.setup -refresh
121
122 add : 
123     
124     -I/home/user/site/perl/lib/perl5 
125
126 You should be left with something that looks like :
127
128     perl -Iblib/lib -I/home/user/site/perl/lib/perl5 $(extramodules) $(tflag) ikiwiki.out -setup docwiki.setup -refresh
129
130 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):
131
132     user@server:~/ikiwiki$ perl Makefile.PL PREFIX=~/site/perl/ verbose
133       MAN1PODS => {  }
134       NAME => q[IkiWiki]
135       PM_FILTER => q[./pm_filter $(PREFIX) $(VER) $(PROBABLE_INST_LIB)]
136       PREFIX => q[/home/flophouse/perl/]
137       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], 
138         Date::Parse=>q[0], CGI::FormBuilder=>q[], CGI::Session=>q[0], Mail::Sendmail=>q[0], HTML::Parser=>q[0], Text::Markdown=>q[0] }
139     Using PERL=/usr/bin/perl
140     Writing Makefile for IkiWiki
141
142 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) :
143
144     1202         #my $ret=eval pagespec_translate($spec);
145     1203         my $ret=eval possibly_foolish_untaint(pagespec_translate($spec));
146
147 At this point, you can run *make* and then *make install* (*make test* fails for reasons explained below).
148
149 # Ikiwiki setup
150 You can follow the normal installation process, excepting a few changes in your ikiwiki.setup documents.
151
152 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 :
153
154     [good]$ ls -la ~
155     lrwxrwxrwx  1 root staff 25 2007-08-03 16:44 /home/user -> /home/.server/user
156
157 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.
158
159 Next, add your installed Perl module directory to the *libdir* parameter.  It should look something like :
160
161         #libdir => "/home/me/.ikiwiki/",
162         libdir => "/home/.server/user/site/perl/lib/perl5/",
163
164 # CGI Wrapper
165 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.
166
167 # Pre-created SVN repository
168 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 : 
169
170         cd your/ikiwiki/source/dir/here
171         svn mkdir "file:///home/user/svn/yoursvnrepositoryhere/whereyouwanttoinstallto" -m "create trunk directory"
172         svn co "file://$repository/trunk" . # Note the dot, it's important
173         svn propset svn:ignore ".ikiwiki" . # Note the dot, it's important
174         svn add *
175         svn commit -m "initial import"
176
177 # Why do I have to do all of this?
178 IANA Perl Expert.  This is just what I found.
179
180 [This appears to be a presentation outlining the problem](http://schwern.org/~schwern/talks/PREFIX/slides/slide001.html) -- Note, this site was up a few days ago, but appears to be down now.  YMMV.
181
182 Part of the problem appears to be where modules decide to install themselves.  Markdown, for example, installs itself to .../lib/perl5, which somehow never makes it's way into any of the INC paths used in the Perl.  Not sure why, really.  The rest of the modules seem to work well with the PREFIX option, but Markdown doesn't install to the path used from the PREFIX (hence the manual modification of Makefile.PL).
183
184 Basically, some stuff obeys the (apparently defunct and never really functional) PREFIX option, while the newer modules that use Module::Build, use the *install-base* option.  It would be nice if Ikiwiki could handle being installed in a non-root situation, but I have no real suggestions on how to make that happen.