updated branch; this is ready for review for inclusion in IkIWiki

[git.ikiwiki.info.git] / doc / tips / distributed_wikis.mdwn

diff --git a/doc/tips/distributed_wikis.mdwn b/doc/tips/distributed_wikis.mdwn
index c471977295c202d9536adad4ca3725be5905fb36..229f27148938dd0d85e37ecbd117e7c43cc7ca96 100644 (file)
--- a/doc/tips/distributed_wikis.mdwn
+++ b/doc/tips/distributed_wikis.mdwn
@@ -1,3 +1,5 @@
+[[!meta date="2008-05-06 19:22:09 -0400"]]
+

 [[rcs/git]] and other distributed version control systems are all about
 making it easy to create and maintain copies and branches of a project. And
 this can be used for all sorts of interesting stuff. Since ikiwiki can use
 [[rcs/git]] and other distributed version control systems are all about
 making it easy to create and maintain copies and branches of a project. And
 this can be used for all sorts of interesting stuff. Since ikiwiki can use


@@ -7,12 +9,13 @@ git, let's explore some possibilities for distributed wikis.
 
 ## Overview
 
 
 ## Overview
 

-There are three possible level of decentralisation:
+There are several 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/]]
 
  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 [[plugins/pinger]]
- 3. completely distinct ikiwiki installs, synchronised with [[plugins/contrib/gitpush]]
+ 2. [[separate ikiwiki and git servers|tips/Hosting_Ikiwiki_and_master_git_repository_on_different_machines]]
+ 3. separate `srcdir`, still requires a central bare repo - uses [[plugins/pinger]]
+ 4. completely distinct ikiwiki installs

 
 Here's a graphic overview of those:
 
 
 Here's a graphic overview of those:
 


@@ -34,6 +37,13 @@ This is the configuration described in
 hosts the HTML files, the ikiwiki [[cgi]] but everything else is on
 the git server.
 
 hosts the HTML files, the ikiwiki [[cgi]] but everything else is on
 the git server.
 

+### Separate webserver and git repository, the git srcdir being hosted on the webserver
+
+[[!img Hosting_Ikiwiki_and_master_git_repository_on_different_machines/separate-web-git-servers.svg size=400x]]
+
+This is the configuration described in
+[[tips/Hosting_Ikiwiki_and_master_git_repository_on_different_machines]]. One server hosts the web server (and the [[Ikiwiki cgi|cgi]]) and the git source dir; a second server hosts the git bare repository. This can be used when you have very limited access to the git server.
+

 ### Decentralised pinger setup
 
 [[!img ping-setup.svg size=400x]]
 ### Decentralised pinger setup
 
 [[!img ping-setup.svg size=400x]]


@@ -50,7 +60,7 @@ Step by step setup instructions for this are detailed below.
 [[!img decentralized_wikis.svg size=400x]]
 
 In this configuration, each wiki is fully independent and pushes its
 [[!img decentralized_wikis.svg size=400x]]
 
 In this configuration, each wiki is fully independent and pushes its

-changes to other wikis using the [[plugins/contrib/gitpush]] plugin.
+changes to other wikis using git.

 
 ## Step by step setup instructions
 
 
 ## Step by step setup instructions
 


@@ -58,6 +68,8 @@ The first two ways of setting up ikiwiki are better described in [[setup]] or [[
 
 Say you have a friend that has already configured a shiny ikiwiki site, and you want to help by creating a mirror. You still need to figure out how to install ikiwiki and everything, hopefully this section will help you with that.
 
 
 Say you have a friend that has already configured a shiny ikiwiki site, and you want to help by creating a mirror. You still need to figure out how to install ikiwiki and everything, hopefully this section will help you with that.
 

+Note that parts of the following documentation duplicate instructions from [[setup]], [[setup/byhand]], [[rcs/git]] and [[tips/laptop_wiki_with_git]].
+

 ### Installing ikiwiki
 
 You need to install the ikiwiki package for the mirror to work. You can use ikiwiki to publish the actual HTML pages elsewhere if you don't plan on letting people edit the wiki, but generally you want the package to be installed on the webserver for editing to work.
 ### Installing ikiwiki
 
 You need to install the ikiwiki package for the mirror to work. You can use ikiwiki to publish the actual HTML pages elsewhere if you don't plan on letting people edit the wiki, but generally you want the package to be installed on the webserver for editing to work.


@@ -195,20 +207,21 @@ The following entries will be different from the above setup file:
     git_wrapper: /home/user/source.git/hooks/post-commit
     git_test_receive_wrapper: /home/user/source.git/hooks/pre-receive
 
     git_wrapper: /home/user/source.git/hooks/post-commit
     git_test_receive_wrapper: /home/user/source.git/hooks/pre-receive
 

-To do this, the mirror needs to push back to the master, using the [[plugins/contrib/gitpush]] plugin:
+To make the mirror push back to the master, use, for example:

 
 

-    git_push_to:
-    - git://wiki.example.com/
+    git_wrapper_background_command: git push git://wiki.example.com/

 
 

-This will ensure that commits done on the mirror will propagate back to the master.
+This will help ensure that commits done on the mirror will propagate back to the master.

 
 

-## Other guides
+## Other ideas

 
 

-Another guide is the [[tips/laptop_wiki_with_git]] guide. To get a
-better understanding of how ikiwiki works, see [[rcs/git]].
+See also:

 
 

-[This](http://piny.be/jrayhawk/notes/ikiwiki_creation/) may also be of
-use if the above doesn't work.
+ * [[setup]]
+ * [[setup/byhand]]
+ * [[rcs/git]]
+ * [[tips/laptop_wiki_with_git]]
+ * [ikiwiki creation notes](http://piny.be/jrayhawk/notes/ikiwiki_creation/)

 
 ### Announcing the mirror
 
 
 ### Announcing the mirror
 


@@ -234,4 +247,3 @@ the wiki, and if you could even resolve the conflict using the web
 interface. Not 100% sure as I've not gotten into this situation yet.
 
 --[[Joey]]
 interface. Not 100% sure as I've not gotten into this situation yet.
 
 --[[Joey]]

-