aboutsummaryrefslogtreecommitdiff
path: root/doc/tips/distributed_wikis.mdwn
diff options
context:
space:
mode:
authorAntoine Beaupré <anarcat@koumbit.org>2014-04-18 11:28:21 -0400
committerAntoine Beaupré <anarcat@koumbit.org>2014-04-18 11:31:22 -0400
commite75fa67406052712476e3aa4d798cf88ec5893d1 (patch)
treefb78bbd0b5f46d214a91bb47f8f8777d219c7869 /doc/tips/distributed_wikis.mdwn
parent9e1ad9037fe4cb54fb5eeb8b3ad65c6594b1c1d4 (diff)
downloadikiwiki-e75fa67406052712476e3aa4d798cf88ec5893d1.tar
ikiwiki-e75fa67406052712476e3aa4d798cf88ec5893d1.tar.gz
add graphical explanations of various decentralisation schemes for ikiwiki
the wiki_edit_flow.svg file is slightly changed to make the box designate the server boundaries so it can be reused in a coherent manner in the other graphics. the distributed_wikis page still needs an overhaul to clarify it's about the third and fourth setups, but that will be easier to do in separate commits.
Diffstat (limited to 'doc/tips/distributed_wikis.mdwn')
-rw-r--r--doc/tips/distributed_wikis.mdwn47
1 files changed, 47 insertions, 0 deletions
diff --git a/doc/tips/distributed_wikis.mdwn b/doc/tips/distributed_wikis.mdwn
index 29273ada1..4e084b256 100644
--- a/doc/tips/distributed_wikis.mdwn
+++ b/doc/tips/distributed_wikis.mdwn
@@ -5,6 +5,53 @@ git, let's explore some possibilities for distributed wikis.
[[!toc levels=2]]
+## Overview
+
+There are three possible level of decentralisation:
+
+ 0. [[default setup|rcs/git]], no decentralisation
+ 1. [[a simple HTML mirror|tips/Git_repository_and_web_server_on_different_hosts/]]
+ 2. separate `srcdir`, still requires a central bare repo - uses [[plugin/pinger]]
+ 3. completely distinct ikiwiki installs, synchronised with
+ [[plugin/gitpush]]
+
+Here's a graphic overview of those:
+
+### Default setup - one central server
+
+[[!img rcs/git/wiki-edit-flow.svg size=490x align=center]]
+
+In the default setup, all the resources are stored on the central
+servers. Users can still clone and edit the git repo by hand and
+contribute by git, but otherwise all the changes happen on a single
+web interface.
+
+### Separate webserver and git repository
+
+[[!img tips/Git_repository_and_web_server_on_different_hosts/separate-webserver.svg align=center]]
+
+In the configuration described in
+[[tips/Git_repository_and_web_server_on_different_hosts]], the
+webserver is separate from the git repository. The webserver part
+hosts the HTML files, the ikiwiki [[cgi]] but everything else is on
+the git server.
+
+### Decentralised pinger setup
+
+[[!img ping-setup.svg align=center]]
+
+In this configuration, the mirrors all have their own `srcdir`, but
+still need to push and pull from the same central bare git repo. The
+[[plugins/pinger]] plugin is used to ping the mirrors from the central
+server on edits.
+
+### Fully decentralised setup
+
+[[!img .svg align=center]]
+
+In this configuration, each wiki is fully independent and pushes its
+changes to other wikis using the [[plugins/gitpush]] plugin.
+
## a wiki mirror
The simplest possibility is setting up a mirror. If a wiki exposes its git