The “Git” backend¶
The Git backend is a regular plugin but, probably, it is what adds the most interesting features to Waliki.
waliki.git converts your content folder in a git repository, and makes a commit on each edition.
With this simple logic you’ll get:
- History of changes (who, when, what)
- Diff: compare any version and see what was added or removed
- Smart concurrent edition handling: don’t lock editions, merge them!
- View and restore old revisions (without losing the history)
- Simple stats: how many lines were added or removed. (go to the history page to see it in action!)
- Backup (pushing your repo to a remote place)
- Edit your content outside the web using the editor of your preference!
- Webhook/s (pull changes from a remote repository)
To install it, add
'waliki' in your
This plugin is optional, but strongly recommended.
This extension uses the
git command line machinary wrapped via the wonderful sh package. Although it could have a performance impact compared with a python git library, my experience is that pygit2 is a bit complex to use and GitPython doesn’t work with Python 3.
The pull webhook¶
waliki.git has a webhook endpoint that receives an HTTP POST requests (without parameters) to pull and sync content from a remote repository:
POST http://yoursite.com[/<waliki_prefix>]/_hooks/pull/<remote name>
This is useful to sync your wiki whenever a repository is pushed to. For example when you push to github.
POST event arrives to the webhook url, Waliki programatically run the command
sync_waliki that pulls the code from the remote name
and then syncs the database adding or deleting
Page instances as needed.
Of course, the
remote name should be registered in your waliki data repo.
See the man page for
git remote to do this.
To keep your remote synced with the changes done via the web editor, you should push back frequently, setting a cron job or a similar tool.