be more explicit about which options to configure on your laptop
[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, set up a [[web_server|dot_cgi]] on your laptop, if it doesn't
23 already have one.
24
25 Now you need to write a setup file for ikiwiki on the laptop. Mostly this
26 is standard, but a few special settings are needed:
27
28 * Configure a cgi wrapper as usual, but configure the git wrapper to
29   be written to the `post-commit` hook of the git clone, rather than the
30   usual `post-update` hook.
31   
32     git_wrapper: /home/user/foo-wiki/.git/post-commit
33
34 * By default, ikiwiki pulls and pushes from `origin`. This shouldn't be 
35   done on the laptop, because the origin may not be accessible (when the
36   laptop is offline). Also, commits made on the laptop should stay there,
37   until manually pushed, so that the laptop can serve as a staging area.
38
39   Make sure you have ikiwiki 2.11 or better installed, and set:
40   
41         gitorigin_branch: 
42
43 * You can optionally enable to the [[plugins/mirrorlist]] plugin,
44   and configure it so that each page links to the corresponding page on the
45   server.
46
47 Now just run `ikiwiki -setup wiki.setup -getctime` and you should be
48 good to go. (You only need the slow `-getctime` option the first time you
49 run setup.) If you have taken your `wiki.setup` file from an existing
50 wiki, you may need to change certain parameters to adapt to the paths
51 on your laptop, a few examples:
52
53     srcdir: /home/user/foo-wiki
54     destdir: /home/user/public_html
55     # optional
56     url: http://foo-wiki.localhost
57     # disable CGI, unless you want to get really funky
58     cgiurl: 
59     cgi_wrapper: 
60     libdir: /home/user/foo-wiki/.ikiwiki
61     ENV:
62         TMPDIR: /home/user/tmp
63     cookiejar:
64         file:
65
66 Use standard git commands to handle pulling from and pushing to the server.
67
68 Note that if changes are pulled from the server, you will need to manually
69 update the wiki, with a command such as `ikiwiki -setup wiki.setup -refresh`.
70 If you'd like it to automatically update when changes are merged in, you
71 can simply make a symlink `post-merge` hook pointing at the `post-update`
72 hook ikiwiki created.
73
74 ## bare mirror approach
75
76 As above, set up a normal ikiwiki on the server, with the usual bare repository.
77
78 Next, `git clone --mirror server:/path/to/bare/repository`
79
80 This will be used as the $REPOSITORY on the laptop.  Then you can follow
81 the instructions in [[setup by hand|/setup/byhand]] as per a normal ikiwiki
82 installation. This means that you can clone from the local bare repository
83 as many times as you want (thus being able to have a repository which is
84 used by the ikiwiki CGI, and another which you can use for updating via
85 git).
86
87 Use standard git commands, run in the laptop's bare git repository
88 to handle pulling from and pushing to the server.