make dot_cgi clearly optional
[ikiwiki.git] / doc / tips / laptop_wiki_with_git.mdwn
1 [[!toc]]
2
3 Using ikiwiki with the [[rcs/git]] backend, some interesting things can be done
4 with creating mirrors (or, really, branches) of a wiki. In this tip, I'll
5 assume your wiki is located on a server, and you want to take a copy with
6 you on your laptop.
7
8 With the configuration described here, you can commit local changes to the
9 version on the laptop, perhaps while offline. You can browse and edit the
10 wiki using a local web server. When you're ready, you can manually push the
11 changes to the main wiki on the server.
12
13 ## simple clone approach
14
15 First, set up the wiki on the server, if it isn't already. Nothing special
16 needs to be done here, just follow the regular instructions in [[setup]]
17 for setting up ikiwiki with git.
18
19 Next, `git clone` the source (`$REPOSITORY`, not `$SRCDIR`)
20 from the server to the laptop.
21
22 Now you need to write a setup file for ikiwiki on the laptop. Mostly this
23 is standard, but a few special settings are needed:
24
25 * Configure a cgi wrapper as usual, but configure the git wrapper to
26   be written to the `post-commit` hook of the git clone, rather than the
27   usual `post-update` hook.
28   
29     git_wrapper: /home/user/foo-wiki/.git/hooks/post-commit
30
31 * By default, ikiwiki pulls and pushes from `origin`. This shouldn't be 
32   done on the laptop, because the origin may not be accessible (when the
33   laptop is offline). Also, commits made on the laptop should stay there,
34   until manually pushed, so that the laptop can serve as a staging area.
35
36   Make sure you have ikiwiki 2.11 or better installed, and set:
37   
38         gitorigin_branch: 
39
40 * You can optionally enable to the [[plugins/mirrorlist]] plugin,
41   and configure it so that each page links to the corresponding page on the
42   server.
43
44 Now just run `ikiwiki -setup wiki.setup -getctime` and you should be
45 good to go. (You only need the slow `-getctime` option the first time you
46 run setup.) If you have taken your `wiki.setup` file from an existing
47 wiki, you may need to change certain parameters to adapt to the paths
48 on your laptop, a few examples:
49
50     srcdir: /home/user/foo-wiki
51     destdir: /home/user/public_html
52     # optional
53     url: http://foo-wiki.localhost
54     libdir: /home/user/foo-wiki/.ikiwiki
55     ENV:
56         TMPDIR: /home/user/tmp
57     cookiejar:
58         file:
59
60 Now, set up a [[web_server|dot_cgi]] on your laptop, if it doesn't
61 already have one. You can also skip that step if you want only to
62 render the wiki and not allow edition, in which case you'll want the
63 following:
64
65     # disable CGI, unless you want to get really funky
66     cgiurl: 
67     cgi_wrapper: 
68
69 You can also direct people to the main server for web edition there.
70
71 Use standard git commands to handle pulling from and pushing to the server.
72
73 Note that if changes are pulled from the server, you will need to manually
74 update the wiki, with a command such as `ikiwiki -setup wiki.setup -refresh`.
75 If you'd like it to automatically update when changes are merged in, you
76 can simply make a symlink `post-merge` hook pointing at the `post-update`
77 hook ikiwiki created.
78
79 ## bare mirror approach
80
81 As above, set up a normal ikiwiki on the server, with the usual bare repository.
82
83 Next, `git clone --mirror server:/path/to/bare/repository`
84
85 This will be used as the $REPOSITORY on the laptop.  Then you can follow
86 the instructions in [[setup by hand|/setup/byhand]] as per a normal ikiwiki
87 installation. This means that you can clone from the local bare repository
88 as many times as you want (thus being able to have a repository which is
89 used by the ikiwiki CGI, and another which you can use for updating via
90 git).
91
92 Use standard git commands, run in the laptop's bare git repository
93 to handle pulling from and pushing to the server.