git.oblomov.eu Git - ikiwiki/blob - doc/tips/nearlyfreespeech.mdwn

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