Table of Contents
Compatible with DokuWiki
- 2022-07-31 "Igor" yes
- 2020-07-29 "Hogfather" yes
- 2018-04-22 "Greebo" unknown
- 2017-02-19 "Frusterick Manners" unknown
Sync/store pages and media in a git repository. So you can show/edit your human-readable wiki dir (e.g. documentation) with DokuWiki and store it together with your source code in the same git repository.
Similar to git
Suggested Directories / Structure
To avoid conflicts with the git repository and the DokuWiki files/directories we suggest to use a different directory structure.
For example, add the following setting values to your
local.php in the global conf directory of your DokuWiki Installation.
$conf['datadir'] = './data/gitrepo/wiki/pages';
$conf['mediadir'] = './data/gitrepo/wiki/media';
Attention: Do not forget to move the original pages and media folders (
./data/media) to the new location (
./data/gitrepo/wiki/), otherwise DokuWiki will not find any pages and media files.
If you use this structure, you have to setup the corresponding paths for this plugin as well (in the Admin-Area of DokuWiki in the section gitbacked). Set
./data/gitrepo/wiki. This means, that all wiki related files are located in the directory
wiki in your git repository.
The plugin creates a new repository in the specified
repoPath, if needed. If you want to use an existing git repository, clone the repository to e.g.
/tmp/yourrepo. Subsequently, copy all data (don't forget the
.git folder) from
Congrats! You are finished and every page edit is committed to the git repository.
If you want to push all changes to the remote origin, enable the
pushAfterCommit setting in the next section.
Configuration and Settings
If activated, every commit (page edit) is pushed to the remote repository. Activate this flag if you already cloned from a remote location and the git environment is configured correctly (attention: it has to be configured for the webserver/php user)
If activated, the system executes a pull request and updates the local git repository. Thus, external commits on page files are merged from the remote.
Defines the period (in minutes) for the periodic pull request executions.
The template strings which are used for the different commit messages (page edits, media edits, page deletion, media deletion). The variables
%user% can be used and are replaced with the corresponding values during the commit process.
The path to your git repository (root) – set to the savedir by default (
./data). Note that this cannot be an absolute path. It must be a relative path from the savedir.
Path of the git working tree, must contain “pages” and “media” directories (e.g. the savedir). Note that this cannot be an absolute path. It must be a relative path from the savedir.
Paths or files (comma separated) that will be ignored and not added by git (currently simple wildcard string matching of paths is performed).
Path to the git binary (if empty, the default “/usr/bin/git” will be used).
Specify additional parameters for the git binary. For example, if you cannot set default git configuration values for the webserver's system user you can add some basic information by specifying additional parameters. e.g.
-c http.sslVerify=false -c user.email="<%mail%>" -c user.name="%user%" deactivates the SSL certificate check and specify the user's email and name which are used for the commits. The value in
addParams is placed directly after the git binary when executing some git command. The variables
%user% can be used and are replaced with the corresponding values before being passed on to git.
Known Bugs and Issues
Please, use Github https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues