summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGustav Eek <gustav.eek@fripost.org>2019-09-30 20:01:29 +0200
committerGustav Eek <gustav.eek@fripost.org>2019-09-30 20:01:29 +0200
commit2dea03a6c31f0c69924be0b0629554d6d967da75 (patch)
tree3d2a929ec9c04cb1eabc54874a57325b4b5f6fc2
parent69dcba3dd8751624e792dc63d4ffa9cb3e7f93e9 (diff)
Initial on merging and updating wiki preview documentation
-rw-r--r--create-a-wiki-preview.mdwn101
1 files changed, 101 insertions, 0 deletions
diff --git a/create-a-wiki-preview.mdwn b/create-a-wiki-preview.mdwn
new file mode 100644
index 0000000..61d42b4
--- /dev/null
+++ b/create-a-wiki-preview.mdwn
@@ -0,0 +1,101 @@
+---
+title: Create a wiki preview
+...
+
+This article describes how to set up preview of Friposts wiki.
+
+**Table of contents**
+
+[[!toc]]
+
+The basic idea is something like the following:
+
+ Bare Git Repository
+ git.fripost.org:fripost-wiki.git
+ |
+ |
+ Repository for Local Edits
+ ~/git/fripost/wiki
+ |
+ |
+ The Preview Ikiwiki Web Part
+ ~/public_html/fripost-wiki
+
+Where *~/git/fripost/wiki* is a local git repository with remote
+tracking of the main bare wiki repository
+*git.fripost.org:fripost-wiki.git*. I define an alias command for
+recompilation of the local version of the. The local preview version
+will reside in *~/public_html/fripost-wiki*. Eventually it
+will be accessed by pointing the browser to
+*http\://fripost.localhost* and *http://wiki.fripost.localhost*
+respectively.
+
+Process overview:
+
+* Install and configure Git
+* Install and configure Apache 2
+* Install Ikiwiki
+
+Install and configure Git
+=========================
+
+Refer to [Git och Fripost](git_och_fripost) for installation
+instructions.
+
+You will need the following repositories:
+
+ * https://git.fripost.org/fripost-ansible
+ * https://git.fripost.org/fripost-wiki
+
+Clone with ssh if you want to edit, which will require you to provide
+a public key to Fripost administrators. Below snippets assume:
+
+ $ git clone https://git.fripost.org/fripost-ansible ~/git/fripost/ansible
+ $ git clone https://git.fripost.org/fripost-wiki ~/git/fripost/wiki
+
+Install and configure Ikiwiki and Pandoc
+========================================
+
+Refer to [ikiwiki setup](https://ikiwiki.info/setup/) at
+[ikiwiki's official website](https://ikiwiki.info) for initial
+install and configuration and
+[an article on Git](https://ikiwiki.info/rcs/git/) for more details on
+setting up Ikiwiki together with Git.
+
+Install packages referred to in the ansible configuration:
+
+ sudo aptitude install \
+ ikiwiki \
+ libauthen-passphrase-perl \
+ highlight-common libhighlight-perl libimage-magick-perl \
+ libmail-sendmail-perl libnet-dns-sec-perl \
+ fcgiwrap spawn-fcgi \
+ pandoc
+
+Copy Ikiwiki configuration from Fripost ansible repository:
+
+ mkdir -p ~/public_html/fripost-wiki ~/.ikiwiki
+ cp -r ~/git/fripost/ansible/roles/wiki/files/var/lib/ikiwiki/* ~/.ikiwiki
+
+Modify the configuration *~/.ikiwkik/fripost-wiki.setup* according to:
+
+```
+adminemail: <your mail>
+adminuser:
+ - <your user>
+srcdir: <your home>/git/fripost/wiki/
+destdir: <your home>/public_html/fripost-wiki
+url: http://fripost.localhost/ # http://wiki.fripost.localhost/
+cgiurl: http://fripost.localhost/ikiwiki.cgi
+cgi_wrapper: <your home>/public_html/fripost-wiki/ikiwiki.cgi
+sslcookie: 0
+libdir: <your home>/.ikiwiki
+# git_wrapper: /home/gustav/fripost/wiki/.git/hooks/post-update
+#historyurl:
+#diffurl:
+gitorigin_branch: ''
+```
+
+*TODO investegate what to do with post update thing.*
+
+ $ ikiwiki --setup ~/.ikiwkik/fripost-wiki.setup