move the comments in the right place, add my comments

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

diff --git a/doc/tips/distributed_wikis.mdwn b/doc/tips/distributed_wikis.mdwn
index 2fd82700ccc093afca3d9c45bdd139ee946fe37e..2547a2e9fe510bdbb8ab22a06f847d1a47aaac47 100644 (file)
--- a/doc/tips/distributed_wikis.mdwn
+++ b/doc/tips/distributed_wikis.mdwn
@@ -7,12 +7,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, synchronised with [[plugins/contrib/gitpush]]

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


@@ -34,6 +35,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]]


@@ -52,28 +60,14 @@ Step by step setup instructions for this are detailed below.
 In this configuration, each wiki is fully independent and pushes its
 changes to other wikis using the [[plugins/contrib/gitpush]] plugin.
 
 In this configuration, each wiki is fully independent and pushes its
 changes to other wikis using the [[plugins/contrib/gitpush]] plugin.
 

-### branching a wiki
-
-It follows that setting up a branch of a wiki is just like the fully decentralised mirror above, except
-we don't want it to push changes back to the origin. The easy way to
-accomplish this is to clone the origin git repository using a readonly
-protocol (ie, "git://"). Then you can't push to it.
-
-If a page on your branch is modified and other modifications are made to
-the same page in the origin, a conflict might occur when that change is
-pulled in. How well will this be dealt with and how to resolve it? I think
-that the conflict markers will just appear on the page as it's rendered in
-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]]
-

 ## Step by step setup instructions
 
 The first two ways of setting up ikiwiki are better described in [[setup]] or [[tips/Git_repository_and_web_server_on_different_hosts]]. The remainder of this page describes the latter two more complex distributed setups. 
 
 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.
 
 ## Step by step setup instructions
 
 The first two ways of setting up ikiwiki are better described in [[setup]] or [[tips/Git_repository_and_web_server_on_different_hosts]]. The remainder of this page describes the latter two more complex distributed setups. 
 
 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.


@@ -190,15 +184,6 @@ and you want a mirror, and not a branch, you should disable web edits on
 your mirror. (You could also point the cgiurl for your mirror at the origin
 wiki if you do not want to incur that overhead or do not want to, or can't, run a CGI.)
 
 your mirror. (You could also point the cgiurl for your mirror at the origin
 wiki if you do not want to incur that overhead or do not want to, or can't, run a CGI.)
 

-### Announcing the mirror
-
-Once your mirror works, you can also add it to the list of mirrors. You can ask the mirror where you take it from (and why not, all mirrors) to add it to their setup file. As an example, here's the configuration for the first mirror:
-
-    mirrorlist:
-      example: https://wiki.example.com/
-
-The [[plugins/mirrorlist]] plugin of course needs to be enabled for this to work.
-

 ### Fully decentralized configuration
 
 In the above configuration, the master git repository is still on the main site. If that site goes down, there will be delays when editing the wiki mirror. It could also simply fail because it will not be able to push the changes to the master git repo. An alternative is to setup a local bare repository that is synced with the master.
 ### Fully decentralized configuration
 
 In the above configuration, the master git repository is still on the main site. If that site goes down, there will be delays when editing the wiki mirror. It could also simply fail because it will not be able to push the changes to the master git repo. An alternative is to setup a local bare repository that is synced with the master.


@@ -227,10 +212,37 @@ To do this, the mirror needs to push back to the master, using the [[plugins/con
 
 This will ensure that commits done on the mirror will propagate back to the master.
 
 
 This will ensure that commits done on the mirror will propagate back to the master.
 

-### Other guides
+## Other ideas
+
+See also:
+
+ * [[setup]]
+ * [[setup/byhand]]
+ * [[rcs/git]]
+ * [[tips/laptop_wiki_with_git]]
+ * [ikiwiki creation notes](http://piny.be/jrayhawk/notes/ikiwiki_creation/)
+
+### Announcing the mirror
+
+Once your mirror works, you can also add it to the list of mirrors. You can ask the mirror where you take it from (and why not, all mirrors) to add it to their setup file. As an example, here's the configuration for the first mirror:
+
+    mirrorlist:
+      example: https://wiki.example.com/

 
 

-Another guide is the [[tips/laptop_wiki_with_git]] guide. To get a
-better understanding of how ikiwiki works, see [[rcs/git]].
+The [[plugins/mirrorlist]] plugin of course needs to be enabled for this to work.
+
+### branching a wiki

 
 

-[This](http://piny.be/jrayhawk/notes/ikiwiki_creation/) may also be of
-use if the above doesn't work.
+It follows that setting up a branch of a wiki is just like the fully decentralised mirror above, except
+we don't want it to push changes back to the origin. The easy way to
+accomplish this is to clone the origin git repository using a readonly
+protocol (ie, "git://"). Then you can't push to it.
+
+If a page on your branch is modified and other modifications are made to
+the same page in the origin, a conflict might occur when that change is
+pulled in. How well will this be dealt with and how to resolve it? I think
+that the conflict markers will just appear on the page as it's rendered in
+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]]