aboutsummaryrefslogtreecommitdiff
path: root/pages/ikiwiki
diff options
context:
space:
mode:
Diffstat (limited to 'pages/ikiwiki')
-rw-r--r--pages/ikiwiki/NearlyFreeSpeech.md98
-rw-r--r--pages/ikiwiki/comments.md15
-rw-r--r--pages/ikiwiki/git.md6
-rw-r--r--pages/ikiwiki/search.md21
4 files changed, 140 insertions, 0 deletions
diff --git a/pages/ikiwiki/NearlyFreeSpeech.md b/pages/ikiwiki/NearlyFreeSpeech.md
new file mode 100644
index 0000000..6583da9
--- /dev/null
+++ b/pages/ikiwiki/NearlyFreeSpeech.md
@@ -0,0 +1,98 @@
+# Setting Up ikiwiki on NearlyFreeSpeech
+
+This page documents step-by-step how to properly setup and customize *ikiwiki* on [NearlyFreeSpeech](https://nearlyfreespeech.net). A good deal of the documentation here has been lifted from [ikiwiki.info/tips/nearlyfreespeech/](https://ikiwiki.info/tips/nearlyfreespeech/) but altered and updated.
+
+[[!toc ]]
+
+## Register for an account and set up a site
+
+After you get an account, 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/. (Not being kept up anymore.)
+
+They gave me 2 cents free funding for signing up, which is enough to pay for 10 megabytes of bandwidth, or about a thousand typical page views, at their current rates. Plenty to decide if this is right for you. If it is, $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. Example:
+
+ ssh username_ikiwiki-test@ssh.phx.nearlyfreespeech.net
+
+Now set up `.profile` to run programs from `~/bin`.
+
+ cd $HOME
+ echo "PATH=$PATH:$HOME/bin" > .profile
+ . .profile
+
+## Download an unpack ikiwiki
+
+First, be sure to be under the proper `private` directory:
+
+ cd /home/private
+
+Use `wget` to download the ikiwiki tarball. You can find the `tar` file at the bottom of this page: [packages.debian.org/unstable/source/ikiwiki](https://packages.debian.org/unstable/source/ikiwiki)
+
+Then unpack it:
+
+ tar zxvf ikiwiki*.tar.gz
+
+## Build and install ikiwiki
+
+ cd ikiwiki
+ export MAKE=gmake
+ perl Makefile.PL INSTALL_BASE=$HOME PREFIX=
+ $MAKE
+ $MAKE install
+
+## Create your wiki
+
+All it takes to create a fully functional wiki using ikiwiki is running one command.
+
+ ikiwiki --setup /etc/ikiwiki/auto.setup
+
+Or, set up a blog with ikiwiki, run this command instead.
+
+ ikiwiki --setup /etc/ikiwiki/auto-blog.setup
+
+Either way, it will ask you a couple of questions.
+
+ What will the wiki be named? foo
+ What revision control system to use? git
+ What wiki user (or openid) will be admin? username
+ Choose a password:
+
+Then, wait for it to tell you an url for your new site..
+
+ Successfully set up foo:
+ url: http://example.com/~username/foo
+ srcdir: ~/foo
+ destdir: ~/public_html/foo
+ repository: ~/foo.git
+ To modify settings, edit ~/foo.setup and then run:
+ ikiwiki --setup ~/foo.setup
+
+We are almost done, but some parameters will most likely be incorrect. Edit your `foo.setup` file and change:
+
+- `url` to `yoursitename.nfshost.com`
+- `srcdir` to `/home/private/foo`
+- `destdir` to `/home/public`
+- `cgiurl` to `http://yoursitename.nfshost.com/ikiwiki.cgi`
+- `cgi_wrapper` to `/home/public/ikiwiki.cgi`
+
+Now rebuild again using:
+
+
+ ikiwiki --setup foo.setup
+
+
+All done with building ikiwiki!
+
+## Setting up SSL
+
+Navigate to your main `public` directory and run the following:
+
+
+ tls-setup.sh
+
+
+Follow the easy instructions and you'll have proper SSL setup in seconds!
diff --git a/pages/ikiwiki/comments.md b/pages/ikiwiki/comments.md
new file mode 100644
index 0000000..5e787eb
--- /dev/null
+++ b/pages/ikiwiki/comments.md
@@ -0,0 +1,15 @@
+# Comments in ikiwiki
+
+Content on this page is based off the discussions found here: [ikiwiki.info/tips/comments_feed/](http://ikiwiki.info/tips/comments_feed/)
+
+You've enabled the comments plugin, so a set of pages on your blog can have comments added to them. Pages with comments even have special feeds that can be used to subscribe to those comments. But you'd like to add a feed that contains all the comments posted to any page. Here's how:
+
+ \[[!inline pages="comment(*)" template=comment]]
+
+The special PageSpec matches all comments. The template causes the comments to be displayed formatted nicely.
+
+---
+
+It's also possible to make a feed of comments that are held pending moderation.
+
+ \[[!inline pages="comment_pending(*)" template=comment]]
diff --git a/pages/ikiwiki/git.md b/pages/ikiwiki/git.md
new file mode 100644
index 0000000..3658a3a
--- /dev/null
+++ b/pages/ikiwiki/git.md
@@ -0,0 +1,6 @@
+# Using git with ikiwiki
+
+This page documents how to setup `git` for both the base `ikiwiki` install, along with your own custom wiki-generated site.
+
+**Note:** These instructions are catered to users running ikiwiki via [[ikiwiki/NearlyFreeSpeech]]
+
diff --git a/pages/ikiwiki/search.md b/pages/ikiwiki/search.md
new file mode 100644
index 0000000..0694516
--- /dev/null
+++ b/pages/ikiwiki/search.md
@@ -0,0 +1,21 @@
+# Setting Up ikiwiki Search on NearlyFreeSpeech
+
+This page focuses on properly setting up ikiwiki search on [[ikiwiki/NearlyFreeSpeech]].
+
+## Proper Packages
+
+You will need to install/enable `xapian-omega` in order to use the default ikiwiki search plugin. Switching your NFS realm to "white" should fix this problem but if not, you will need to reach out to support and request they add it for you.
+
+Once that is complete, edit your `foo.setup` file and update the `omega` path to:
+
+
+ /usr/local/www/xapian-omega/cgi-bin/omega
+
+
+Then rebuild your ikiwiki:
+
+
+ ikiwiki --setup foo.setup
+
+
+Now your web search should be working!