plugin:gitbacked
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
plugin:gitbacked [2013-11-20 17:20] – [Configuration and Settings] 60.71.112.89 | plugin:gitbacked [2023-12-14 13:47] (current) – adds markus as author 213.47.191.196 | ||
---|---|---|---|
Line 2: | Line 2: | ||
---- plugin ---- | ---- plugin ---- | ||
- | description: | + | description: |
- | author | + | author |
- | email : wolfgang@gassler.org | + | |
type : action | type : action | ||
- | lastupdate : 2013-10-20 | + | lastupdate : 2023-05-07 |
- | compatible : Release 2012-10-13 "Adora Belle",Release 2013-05-10 "Weatherwax" | + | compatible : Adora Belle, Weatherwax, Binky, Ponder Stibbons, Hrun, Detritus, Elenor Of Tsort, Frusterick Manners, Greebo, Hogfather, Igor, Jack Jackrum |
depends | depends | ||
- | conflicts | + | conflicts |
- | similar | + | similar |
tags : git, storage, collaboration | tags : git, storage, collaboration | ||
- | downloadurl: | + | downloadurl: |
- | bugtracker : http:// | + | bugtracker : https:// |
- | sourcerepo : http:// | + | sourcerepo : https:// |
donationurl: | donationurl: | ||
---- | ---- | ||
Line 21: | Line 20: | ||
===== Installation ===== | ===== Installation ===== | ||
- | Install | + | Search and install |
- | + | ||
- | :!: Note that this plugin only works if you have a git executable available | + | |
===== Suggested Directories / Structure ===== | ===== Suggested Directories / Structure ===== | ||
- | To avoid conflicts with the git repo and the DokuWiki files/ | + | To avoid conflicts with the git repository |
- | For example, add the follwing | + | For example, add the following |
* '' | * '' | ||
* '' | * '' | ||
- | Attention: | + | **Attention:** Do not forget to move the original pages and media folders ('' |
- | If you use this structure, you have to set the repoPath | + | 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: |
+ | * '' | ||
+ | This means, that all wiki related files are located in the directory '' | ||
+ | {{: | ||
- | The plugin creates a new repo if no git repo can be found in the specified repoPath. If you want to use an existing git repository, clone the repository to e.g. ''/ | + | The plugin creates a new repository |
- | **Congrats!** You are finished and every page edit is committed to the git repo. | + | **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, see the pushAfterCommit setting in the next section. | + | |
+ | If you want to push all changes to the remote origin, enable the '' | ||
===== Configuration and Settings ===== | ===== Configuration and Settings ===== | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
- | * pushAfterCommit | + | ===== Known Bugs and Issues ===== |
- | + | ||
- | If activated, every commit (page edit) is pushed to the remote repo. Activate this flag iff you already cloned from a remote location | + | |
- | + | ||
- | * periodicPull | + | |
- | + | ||
- | If activated, after a defined period (defined in ) the system executes a pull request and updates the local git repository. Thus, external commits on page files are merged from remote to the local repo. | + | |
- | + | ||
- | * periodicMinutes | + | |
- | + | ||
- | Defines the period (in minutes) for the periodic pull request executions. | + | |
- | + | ||
- | * commitMsg, commitMsgDel, | + | |
- | + | ||
- | The String which is used for the different commit messages (page edits, media edits, page deletion, media deletion). The variables '' | + | |
- | + | ||
- | * repoPath | + | |
- | + | ||
- | The path to your git repository (root) - set to the savedir by default ('' | + | |
- | + | ||
- | * repoWorkDir | + | |
- | + | ||
- | Path of the git working tree, must contain " | + | |
- | + | ||
- | * addParams | + | |
- | Specify additional parameters for the git binary. For example, if you can't set default git config values for the webserver' | + | Please, use Github [[https:// |
- | === Known Bugs and Issues | + | ===== Release Notes and Changelog ===== |
- | Please, use Github | + | [[https:// |
plugin/gitbacked.txt · Last modified: 2023-12-14 13:47 by 213.47.191.196