summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/tips/nearlyfreespeech.mdwn76
1 files changed, 47 insertions, 29 deletions
diff --git a/doc/tips/nearlyfreespeech.mdwn b/doc/tips/nearlyfreespeech.mdwn
index 4d1177179..61762d6aa 100644
--- a/doc/tips/nearlyfreespeech.mdwn
+++ b/doc/tips/nearlyfreespeech.mdwn
@@ -2,39 +2,50 @@
provider with very cheap pay as you go pricing. Here's how to install ikiwiki
there if you don't have a dedicated server.
-* [Get an account](https://www.nearlyfreespeech.net/about/start.php).
-* Create a site using their web interface. Mine is named `ikiwiki-test` and I
- used their DNS instead of getting my own, resulting in
- <http://ikiwiki-test.nfshost.com/>
-* Fund it. (Or don't. They gave me 2 cents free funding for signing up, which
- is enough to pay for 10 megabytes of hosting, or about a thousand typical
- page views at their current rates.)
-* `ssh` into their server using the ssh hostname and username displayed on
- the site's information page. For me this was
+## Register for an account and set up a site.
+
+After you [get an account](https://www.nearlyfreespeech.net/about/start.php),
+create a site using their web interface.
+
+Mine is named `ikiwiki-test` and I used their DNS instead of getting my
+own, resulting in <http://ikiwiki-test.nfshost.com/>
+
+They gave me 2 cents free funding for signing up, which is enough to pay
+for 10 megabytes of hosting, or about a thousand typical page views at
+their current rates. $5 might be a good starting amount of money to put in
+your account.
+
+## ssh in and configure the environment
+
+ssh into their server using the ssh hostname and username displayed on
+the site's information page. For me this was
ssh joeyh_ikiwiki-test@ssh.phx.nearlyfreespeech.net
+ cd $HOME
+
+Now set up .profile to run programs from ~/bin.
-* Set up .profile to use your home directory.
+ echo "PATH=$PATH:$HOME/bin" > .profile
+ . .profile
- echo "PATH=$PATH:$HOME/bin" > $HOME/.profile
- . $HOME/.profile
+## Download an unpack ikiwiki
-* You'll be in the htdocs directory by default, where public web pages are
- put, so before installing ikiwiki, `cd $HOME`
-* Use `wget` to [[download]] the ikiwiki tarball.
-* Unpack ikiwiki.
+Use `wget` to [[download]] the ikiwiki tarball. Then unpack it:
tar zxvf ikiwiki*.tar.gz
-* Use CPAN to install the perl modules it uses into your home directory:
- (This will take a while. As long as the first command succeeds, ikiwiki will be
- usable. The second command adds extra modules that some plugins use, and
- installation of some of them might fail.)
+## Install perl modules
+
+Use CPAN to install the perl modules it uses into your home directory:
PERL5LIB=ikiwiki:ikiwiki/cpan:. PERL_MM_USE_DEFAULT=1 perl -MCPAN -e 'CPAN::Shell->install("Bundle::IkiWiki")'
PERL5LIB=ikiwiki:ikiwiki/cpan:. PERL_MM_USE_DEFAULT=1 perl -MCPAN -e 'CPAN::Shell->force(install => "Bundle::IkiWiki::Extras")'
-* Now build and install ikiwiki into your home directory.
+(This will take a while. As long as the first command succeeds, ikiwiki will be
+usable. The second command adds extra modules that some plugins use, and
+installation of some of them might fail.)
+
+## Build and install ikiwiki
cd ikiwiki
export MAKE=gmake
@@ -42,11 +53,14 @@ there if you don't have a dedicated server.
$MAKE
$MAKE install
-* With ikiwiki installed, you can follow the regular [[setup]] tutorial for
- settng up your wiki. Make sure to set `destdir` to `/home/htdocs/` so that
- the wiki is published on the web site. I recommend using git for revision
- control; you can then clone your wiki's git repository as an offsite backup.
- Here is an example of how I set up a wiki:
+## Set up a wiki in the usual way.
+
+With ikiwiki installed, you can follow the regular [[setup]] tutorial for
+settng up your wiki. Make sure to set `destdir` to `/home/htdocs/` so that
+the wiki is published on the web site. I recommend using git for revision
+control; you can then clone your wiki's git repository as an offsite backup.
+
+Here is an example of how I set up a wiki:
mkdir ~/wiki
cd ~/wiki
@@ -64,9 +78,13 @@ there if you don't have a dedicated server.
ikiwiki-makerepo git . ../wiki.git
ikiwiki -setup ikiwiki.setup
-* Finally, you can save a _lot_ of disk space by cleaning up the ikiwiki
- tarball and .cpan directory.
+## Clean up
+
+Finally, you can save a _lot_ of disk space by cleaning up the ikiwiki
+tarball and .cpan directory.
+
+rm -rf ~/ikiwiki*.tar.gz ~/.cpan
- rm -rf ~/ikiwiki*.tar.gz ~/.cpan
+## Enjoy!
Have fun and do good things. --[[Joey]]