urosm
/
ikiwiki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

web commit by ManojSrivastava

master
Joey Hess 2008-03-05 18:35:20 -05:00
parent 0702e3aabe
commit 5df638c445
1 changed files with 37 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

94
doc/rcs/git.mdwn
View File

@ -47,29 +47,26 @@ repositories:
repositories will push to/pull from. It is a bare repository, since
there are problems pushing to a repository that has a working
directory. This is called _repository_ in [[ikiwiki-makerepo]]'s
manual page.
manual page. Nominally, this bare repository has a `post-commit` hook
that either is or calls ikiwiki's git wrapper, which changes to the
working directory for ikiwiki, does a _git pull_, and refreshes ikiwiki
to regenerate the wiki with any new content. The [[setup]] page describes
how to do this.
Nominally, this bare repository has a `post-commit` hook that either
is or calls ikiwiki's git wrapper, which changes to the working
directory for ikiwiki, does a _git pull_, and refreshes ikiwiki to
regenerate the wiki with any new content.
The configuration sections below show how to let the post-commit
hook be replaced by the ikiwiki git wrapper.
* The second repository is a clone of the bare root repository, and
has a working tree which is used as ikiwiki's srcdir for compiling
the wiki. **Never** push to this repository. When running as a
[[cgi]], the changes are committed to this repository, and pushed to
the master repository above. This is called _srcdir_ in
[[ikiwiki-makerepo]]'s manual page.
* The other (third, fourth, fifth, sixth -- however many pleases you)
repositories are also clones of the bare root repository above --
and these have a working directory for you to work on. Use either
the `git` transport (if available), or `ssh`. These repositories may
be on remote machines, your laptop, whereever you find convenient to
hack on your wiki. you can commit local changes to the version on
the laptop, perhaps while offline. You can browse and edit the wiki
using a local web server. Any new content should be pushed to the
the laptop, perhaps while offline. Any new content should be pushed to the
bare master repository when you are ready to publish it, and then
the post-commit hook of the bare repository will ensure that the
ikiwiki's source directory is updated, and the ikiwiki refreshed
@ -107,54 +104,37 @@ repository, should only be writable by the wiki's admin, and *not* by the
group. Take care that ikiwiki uses a umask that does not cause files in
the srcdir to become group writable. (umask 022 will work.)
## Configuration of working clone repositories
## Optionally using a local wiki to preview changes
These are repositories (Clone 1 .. N in the image) usually setup to
avoid permission problems with the working directory used by ikiwiki
itself. They also represent the most convenient way to add content to
the wiki on a different machine (that is, not the machine the wiki is
published on) which is more convenient.
When working on the "working clones" to add content to your wiki,
it is common (but optional) practice to preview your changes using a
private wiki on the local host before publishing the updates by
sending it to the root repository. If you do want to setup a private
wiki, you will have to have another setup file and and an ikiwiki
installation on your local machine. You will need all the packages
this implies -- a web server, git, ikiwiki, etc. However, there is a
_caveat_: by default, ikiwiki pulls and pushes from `origin`. This is
not ideal for the working clones on the local machine, since you might
go through several iterations of a page before pushing to the bare
root of the repository tree (and thus publishing it on your public wiki).
You do not want the action of refreshing the local wiki in order to
review your work to accidentally publish the
contents before you are ready. In order to prevent the git push that
is the normal behaviour of ikiwiki, set the configuration of the local wiki:
The use case for these clones is this: If you want to edit your wiki
on your development box, or on your laptop, you usually set up a clone
as above. But very often, you also want to test what the changes look
like, locally, before pushing it to the root repository and publishing
the wiki for the world to see.
gitorigin_branch => "",
## git post-commit wrapper
wrapper => "/working/dir/.git/hooks/post-commit",
In order to do this, you should another setup file and setup a private
ikiwiki on the local machine (your laptop, for instance) where you do
most of your editing. You will also need to set up a webserver, and
install ikiwiki on this machine. Only when you are happy with any
changes do you push them to the root repository.
Then just committing should refresh the private ikiwiki on the local
host. Now just run `ikiwiki -setup localwiki.setup -getctime` and
you should be good to go. (You only need the slow `-getctime` option
the first time you run setup.) Use standard git commands to handle
pulling from and pushing to the server. **Note**: Currently, after
pulling changes from the bare root repository, you will need to
manually update the local wiki, with a command such as `ikiwiki
-setup localwiki.setup -refresh`. This is because git 1.5.4 doesn't
have a hook that is run locally after pulling changes. Newer
versions of git will have a `post-merge` hook that should work for
this purpose.
Here are some things to be aware of when configuring ikiwiki on the
local machine:
* By default, ikiwiki pulls and pushes from `origin`. This is not
ideal for the working clones on the local machine, since you might
go through several iterations of a page before pushing to the bare
root of the repository tree and publishing it on your public
wiki. In the configuration, set:
gitorigin_branch => "",
## git post-commit wrapper
wrapper => "/working/dir/.git/hooks/post-commit",
Then just committing should refresh the private ikiwiki on the local
host.
* You can optionally enable to the [[plugins/mirrorlist]] plugin,
and configure it so that each page links to the corresponding page on the
server.
Now just run `ikiwiki -setup wiki.setup -getctime` and you should be
good to go. (You only need the slow `-getctime` option the first time you
run setup.)
Use standard git commands to handle pulling from and pushing to the server.
Note: Currently, after pulling changes, you will need to manually update
the wiki, with a command such as `ikiwiki -setup wiki.setup -refresh`. This
is because git 1.5.4 doesn't have a hook that is run locally after pulling
changes. Newer versions of git will have a `post-merge` hook that should
work for this purpose.