doc/tips/nearlyfreespeech.mdwn

   1 [[!meta date="2008-05-05 14:51:26 -0400"]]
   2
   3 [NearlyFreeSpeech.net](http://NearlyFreeSpeech.net) is a shared hosting
   4 provider with very cheap pay as you go pricing. Here's how to install ikiwiki
   5 there if you don't have a dedicated server.
   6
   7 Note that you can also follow these instructions, get your wiki set up on
   8 NearlyFreeSpeech, and then use the [[plugins/Amazon_S3]] plugin to inject
   9 the static web pages into Amazon S3. Then NearlyFreeSpeech will handle the
  10 CGI, and S3 will handle the web serving. This might be a more cost effective,
  11 scalable, or robust solution than using NearlyFreeSpeech alone.
  12
  13 ## Register for an account and set up a site
  14
  15 After you [get an account](https://www.nearlyfreespeech.net/about/start.php),
  16 create a site using their web interface.
  17
  18 Mine is named `ikiwiki-test` and I used their DNS instead of getting my
  19 own, resulting in <http://ikiwiki-test.nfshost.com/>. (Not being kept up
  20 anymore.)
  21
  22 They gave me 2 cents free funding for signing up, which is enough to pay
  23 for 10 megabytes of bandwidth, or about a thousand typical page views, at
  24 their current rates. Plenty to decide if this is right for you. If it is,
  25 $5 might be a good starting amount of money to put in your account.
  26
  27 ## ssh in and configure the environment
  28
  29 ssh into their server using the ssh hostname and username displayed on
  30 the site's information page. For me this was:
  31
  32         ssh joeyh_ikiwiki-test@ssh.phx.nearlyfreespeech.net
  33
  34 Now set up .profile to run programs from ~/bin.
  35
  36         cd $HOME
  37         echo "PATH=$PATH:$HOME/bin" > .profile
  38         . .profile
  39
  40 ## Download an unpack ikiwiki
  41
  42 Use `wget` to [[download]] the ikiwiki tarball. Then unpack it:
  43
  44         tar zxvf ikiwiki*.tar.gz
  45
  46 ## Install perl modules
  47
  48 As an optional step, you can use CPAN to install the perl modules ikiwiki
  49 uses into your home directory. This should not be necessary, mostly,
  50 because the system has most modules installed already.
  51
  52 So, you might want to skip this step and come back to it later if ikiwiki
  53 doesn't work.
  54
  55         PERL5LIB=$HOME/ikiwiki:$HOME/ikiwiki/cpan:$HOME/lib/perl5 PERL_MM_USE_DEFAULT=1 perl -MCPAN -e 'CPAN::Shell->install("Bundle::IkiWiki")'
  56
  57         PERL5LIB=$HOME/ikiwiki:$HOME/ikiwiki/cpan:$HOME/lib/perl5 PERL_MM_USE_DEFAULT=1 perl -MCPAN -e 'CPAN::Shell->force(install => "Bundle::IkiWiki::Extras")'
  58
  59 This will take a while. As long as the first command succeeds, ikiwiki will be
  60 usable. The second command adds extra modules that some plugins use, so it's
  61 ok if installation of some of them fail.
  62
  63 ## Build and install ikiwiki
  64
  65         cd ikiwiki
  66         export MAKE=gmake
  67         perl Makefile.PL INSTALL_BASE=$HOME PREFIX=
  68         $MAKE
  69         $MAKE install
  70
  71 ## Set up a wiki in the usual way
  72
  73 With ikiwiki installed, you can follow the regular [[setup]] tutorial for
  74 settng up your wiki. Make sure to set `destdir` to `/home/htdocs/` so that
  75 the wiki is published on the web site. I recommend using git for revision
  76 control; you can then clone your wiki's git repository as an offsite backup.
  77
  78 Here is an example of how I set up a wiki:
  79
  80         mkdir ~/wiki
  81         cd ~/wiki
  82         cp -r ~/ikiwiki/doc/examples/blog/* .
  83         ikiwiki --dumpsetup ikiwiki.setup
  84         nano ikiwiki.setup
  85         # Set destdir to /home/htdocs
  86         # Set srcdir to /home/private/wiki
  87         # Set url to http://yoursite.nfshost.com/
  88         # Set cgiurl to http://yoursite.nfshost.com/ikiwiki.cgi
  89         # Uncomment the `rcs => "git"` line.
  90         # Set the cgi_wrapper path to /home/htdocs/ikiwiki.cgi
  91         # Set the git_wrapper path to /home/private/wiki.git/hooks/post-update
  92         # Configure the rest to your liking and save the file.
  93         ikiwiki-makerepo git . ../wiki.git
  94         ikiwiki --setup ikiwiki.setup
  95
  96 ## Clean up
  97
  98 Finally, you can save a _lot_ of disk space by cleaning up the ikiwiki
  99 tarball and .cpan directory and a few other peices of cruft. Since you'll be
 100 charged one cent per month per megabyte, this is a quick way to save several
 101 dollars.
 102
 103 rm -rf ~/ikiwiki*.tar.gz ~/.cpan ~/ikiwiki ~/man ~/lib/perl5/5.8.8
 104
 105 That should cut things down to less than 2 megabytes. If you want to save
 106 even more space, delete unused perl modules from ~/lib/perl5
 107
 108 ## Enjoy!
 109
 110 Have fun and do good things. --[[Joey]]