plugin:backup
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
plugin:backup [2018-02-06 21:40] – [Thanks] Aaron Smith | plugin:backup [2024-04-16 16:31] (current) – andi | ||
---|---|---|---|
Line 2: | Line 2: | ||
---- plugin ---- | ---- plugin ---- | ||
- | description: | + | description: |
author | author | ||
email : tjgrant@tatewake.com | email : tjgrant@tatewake.com | ||
type : admin | type : admin | ||
- | lastupdate : 2016-06-29 | + | lastupdate : 2020-10-21 |
- | compatible : 2013-12-08, 2014-05-05, 2014-09-29, 2015-08-10a, | + | compatible : Igor, Jack Jackrum, Kaos |
depends | depends | ||
conflicts | conflicts | ||
Line 17: | Line 17: | ||
bugtracker : https:// | bugtracker : https:// | ||
donationurl: | donationurl: | ||
+ | |||
+ | securitywarning: | ||
---- | ---- | ||
- | ===== License ===== | + | ** |
+ | :!: The plugin' | ||
+ | ** | ||
- | * **Author:** [[tjgrant@tatewake.com|Terence J. Grant]] | + | This is a plugin for DokuWiki which enables you to backup the most important parts of your site; this includes all of your pages, all old revisions, meta data, subscriptions, |
- | * **License: | + | |
- | * **Last Update:** 2016-06-29 | + | |
- | * **Donate:** [[https:// | + | |
- | It's not required, but please consider linking to [[backup|this page]] or the main page from your site if you like this product. | ||
- | |||
- | ===== Disclaimer ===== | ||
- | |||
- | **As with any data backup tool, there is always a possibility for unintentional data loss.** | ||
- | |||
- | **Neither I nor this site will be held responsible for any data loss caused by this product.** | ||
- | |||
- | **So download and use at your own risk!** | ||
- | ===== Download ===== | ||
- | Before downloading or using this product, make sure you __**understand and accept**__ the terms of the [[# | ||
- | |||
- | After downloading, | ||
- | |||
- | * This is the **latest version**, compatible with **The Latest DokuWiki**: | ||
- | * Latest Version: [[https:// | ||
- | * Github URL: [[https:// | ||
- | |||
- | * Older downloads are available on request only. | ||
- | |||
- | **Note: https:// | ||
===== Installation ===== | ===== Installation ===== | ||
- | Use the plugin | + | Search and install |
- | - [[# | + | As with any data backup tool, there is always a possibility for unintentional data loss. As per the plugin's license, no warranties are given. Use and download at you own risk. |
- | - unpack it into ''< | + | |
- | - login as admin and change the plugin in the configuration manager | + | |
- | **using git:**\\ | + | ==== Changes ==== |
- | < | + | |
- | % cd < | + | |
- | % git clone git:// | + | |
- | </ | + | |
- | **Debian install (or probably any other distribution): | + | {{rss> |
- | <code> | + | |
- | # cd / | + | |
- | # wget https:// | + | |
- | # unzip master.zip | + | |
- | # chown -Rv 33 backup/ | + | |
- | </ | + | |
- | **Note: https:// | + | ===== Usage ===== |
- | + | ||
- | ===== About ===== | + | |
- | + | ||
- | This is a plugin for DokuWiki which enables you to backup the most important parts of your site; this includes all of your pages, all old revisions, meta data, subscriptions, | + | |
- | + | ||
- | This is in case, for some odd reason, your host accidentally loses all your files; it's happened to me personally twice, on two different hosts since I began using DokuWiki-- and backing up manually can be quite a nightmare. | + | |
- | + | ||
- | ==== Standard Features | + | |
To access the plugin, make sure you're on the admin account, and click the admin button on your wiki site. | To access the plugin, make sure you're on the admin account, and click the admin button on your wiki site. | ||
- | An entry named " | + | An entry named " |
- | + | ||
- | {{ http://i.imgur.com/ | + | |
Simply check the items you wish to backup, and uncheck the ones you don't. For instance, you may not care about old revisions of documents, so you don't have to include them if you don't want to. | Simply check the items you wish to backup, and uncheck the ones you don't. For instance, you may not care about old revisions of documents, so you don't have to include them if you don't want to. | ||
Line 90: | Line 48: | ||
Click the **Create Backup** button, and the process of backing up starts. For large sites, it may take some time; it may even time out-- in which case you may wish to backup each section individually-- though this is unlikely. It will usually take at least a little time for the page to respond, so please be patient. | Click the **Create Backup** button, and the process of backing up starts. For large sites, it may take some time; it may even time out-- in which case you may wish to backup each section individually-- though this is unlikely. It will usually take at least a little time for the page to respond, so please be patient. | ||
- | The backup file is generated and put in the root of your media directory. So you're then able to download it from there, and you may wish to delete it afterwards. | + | The backup file is generated and put in your media directory. So you're then able to download it from there, and you may wish to delete it afterwards. |
- | ===== Install ===== | + | |
- | + | ||
- | As a plugin all you need to do is unpack the file into the lib/ | + | |
- | + | ||
- | ===== Upgrading ===== | + | |
- | + | ||
- | To upgrade, remove the original lib/ | + | |
- | + | ||
- | ===== What's New ===== | + | |
- | + | ||
- | ==== June 28, 2016 ==== | + | |
- | + | ||
- | * Apparently a new release of DokuWiki, their version 2016-06-26, broke the existing plugin. Luckily a user on github, **dsp777**, was able to come up with a fix for it; so the issue should be resolved, and thanks, **dsp777**. | + | |
- | + | ||
- | ==== August 28, 2014 ==== | + | |
- | + | ||
- | * Added Japanese language support. | + | |
- | + | ||
- | ==== May 19, 2014 ==== | + | |
- | + | ||
- | * Updated plugin.info.txt. | + | |
- | + | ||
- | ==== October 09, 2013 ==== | + | |
- | + | ||
- | * Fixed broken function usage after they were removed with the Wheaterwax update | + | |
- | * Added German language support, though, still needs some clean up. | + | |
- | + | ||
- | ==== April 27, 2011 ==== | + | |
- | + | ||
- | * Fixed mkpath and made it respect conf[dmode]. | + | |
- | + | ||
- | ==== March 16, 2009 ==== | + | |
- | + | ||
- | * Added fr language support, thanks to [[guillaume.turri@gmail.com|Guillaume Turri]]. | + | |
- | + | ||
- | ==== August 24, 2008 ==== | + | |
- | + | ||
- | * New backup method: "Lazy and Quick" method. This method runs in O(1) constant time rather than the other two methods that run in O(n) linear time. This method should be used for folks with big sites to back up, but is only available if the GNU Tar method is supported. | + | |
- | * For folks with installs on Macintosh based servers, files named " | + | |
- | * Some minor tweaks to the language files. | + | |
- | + | ||
- | ==== August 2, 2008 ==== | + | |
- | + | ||
- | Major update! | + | |
- | + | ||
- | Here's what's new: | + | |
- | + | ||
- | * I've made an effort for all run-time errors to be handled. | + | |
- | * I've replaced [[http:// | + | |
- | * [[http:// | + | |
- | * The list of files to backup is much improved, again thanks to Andreas Wagner. | + | |
- | * Backups will not archive existing backups, again thanks to Andreas Wagner. | + | |
- | * I've added auto-detection of PEAR and/or exec availability, | + | |
- | * You can choose between PEAR and exec if you have the option of both. | + | |
- | * All files entries for the exec version are **relative** instead of **absolute** now for exec, thanks to [[dokuwiki@koloro.de|Uwe Koloska]] for this. | + | |
- | * Both backup methods generate the same file structure now as well. | + | |
- | * Backup file names have changed slightly, files now start with " | + | |
- | * Backup options selected are now saved as defaults for future sessions. | + | |
- | * Compression options are chosen based on what's available, in the order of bzip2, gzip, and no compression for both PEAR and exec. | + | |
- | * Backup files are created directly into the media directory, so no moving is necessary. | + | |
- | + | ||
- | ==== July 10, 2008 ==== | + | |
- | + | ||
- | I've finally gotten time to check the new ACL compatibility. | + | |
- | + | ||
- | As it turns out, I was mistaken-- ACL file names and structure have not changed, simply the interface to modify ACL has, and this does not affect [[: | + | |
- | + | ||
- | Therefore [[: | + | |
- | + | ||
- | So in other words, the April 7, 2007 version will work, and is safe to use. | + | |
- | + | ||
- | ==== April 5, 2007 ==== | + | |
- | + | ||
- | * Backup files are now timestamped with date and time, thanks to [[syv@sqlhacks.com|Syv Ritch]] for the push. | + | |
- | + | ||
- | ==== March 11, 2007 ==== | + | |
- | + | ||
- | * Added conf/ | + | |
- | + | ||
- | ==== October 12, 2006 ==== | + | |
- | + | ||
- | * New BackupTool release, fixes compatibility with new DokuWiki versions. | + | |
- | + | ||
- | ==== August 3, 2006 ==== | + | |
- | * Internationalization support complete | + | |
- | + | ||
- | ==== July 29, 2006 ==== | + | |
- | * Initial release | + | |
- | + | ||
- | ===== Discussion ===== | + | |
- | + | ||
- | ===== Note to users: Tarlib doesn' | + | |
- | + | ||
- | Hi everyone, let me state for the record that " | + | |
- | + | ||
- | I've discussed this on the DokuWiki mailing list several times, and have filed (if I recall) at least two bug reports about it. | + | |
- | * The latest bug report I've filed is < | + | |
- | * The latest mailing list discussion for this is [[http:// | + | |
- | + | ||
- | ==== Tarlib version (non-working) ==== | + | |
- | + | ||
- | Here is a version that attempts to use tarlib (part of DW) to write the archive directly into the media folder. The tar file it creates for some reason seems to be corrupt (or at least it won't verify in my local archive manager, 7-zip.) I suspect it's either: | + | |
- | + | ||
- | * Checksum generated is incorrect | + | |
- | * Format is otherwise incorrect | + | |
- | * Possibly DokuWiki' | + | |
- | + | ||
- | I'm not horribly sure but I can't guarantee I'll be able to fix it in a timely manner, so if someone would like to investigate, | + | |
- | + | ||
- | {{: | + | |
- | + | ||
- | --- // | + | |
- | + | ||
- | ==== More problems with tarlib ==== | + | |
- | + | ||
- | I've done some testing since last night... | + | |
- | + | ||
- | * tar files appear to be okay as long as you don't add directories | + | |
- | * gnu tar doesn' | + | |
- | * files with more than 100 characters in their path don't get added (uh-oh) | + | |
- | --- // | + | |
- | + | ||
- | ==== Andreas Wagner' | + | |
- | + | ||
- | A little better, but still has the same problems: | + | |
- | + | ||
- | {{wiki: | + | |
- | + | ||
- | You'll need to make a " | + | |
- | + | ||
- | --- // | + | |
- | + | ||
- | ===== Initial release jitters ===== | + | |
- | + | ||
- | Hi all, I've gone ahead and put a list of all the known issues below; each of which is solvable, but currently still outstanding. Feel free to help me complete these early-- it'll result in a faster release and more time spent on other projects. | + | |
- | + | ||
- | ===== More files to backup? ===== | + | |
- | + | ||
- | If you're aware of any important files I'm missing in the backup process, please list it below as file paths, thanks. | + | |
- | + | ||
- | * conf/ | + | |
- | + | ||
- | Hello, I would appreciate if your tool could also backup // | + | |
- | + | ||
- | Thank you. | + | |
- | + | ||
- | deKesi | + | |
- | + | ||
- | ===== Displaying page as multi-part ===== | + | |
- | + | ||
- | Anyone have an idea on how to display the page as each individual section completes? I believe I'm doing everything right in this regard, but obviously the sever still wishes to wait until the page is completely loaded. So any help on this would be appreciated. | + | |
- | + | ||
- | === Tar and GZip/BZip commands === | + | |
- | + | ||
- | >For the archiving commands (' | + | |
- | + | ||
- | Ok, I'll look into this as well. --- // | + | |
- | + | ||
- | ==== The harder stuff ==== | + | |
- | + | ||
- | >My other ideas are: | + | |
- | > * option to send the backup as part of its creation, i.e., the web browser will pop up its download window there and then and the admin can save the backup immediately. | + | |
- | >> | + | |
- | >>> | + | |
- | + | ||
- | + | ||
- | ==== Security issues ==== | + | |
- | + | ||
- | >if a current backup exists, add option to only download that backup. | + | |
- | >> | + | |
- | >>> | + | |
- | >>> | + | |
- | >>>> | + | |
- | >>>>>: | + | |
- | + | ||
- | >In reply to some of your other points above: | + | |
- | > * %%`date " | + | |
- | >>I was thinking of using the PHP date function originally, since myself I do backups fairly irregularly. (Sometimes I'll do twice in a day if i've had some significant changes.) The only concern I had was regarding replacing slashes in the date with dashes or something --- // | + | |
- | >> | + | |
- | >> | + | |
- | >>> | + | |
- | + | ||
- | >The plugin manager stores information about any plugin it installs, including the source URL. Update, simply attempts to retrieve and reinstall the plugin again from the same URL. At this time there is no intelligence behind it, i.e., it doesn' | + | |
- | >Cheers --- // | + | |
- | ==== Thanks ==== | + | |
- | > Thank you for your backup tool! Any plans to make automatically make daily/ | + | |
- | > | + | |
- | >> I personally don't have any plans myself for this-- feel free to add options and send them to me (see [[:svn]] for some tips.) Automated backups could be done with what's called a [[wp> | + | |
- | >> | + | |
- | >>As for mailing; I wouldn' | + | |
- | >> | + | |
- | >> --- // | + | |
- | >>> | + | |
- | >>> | + | |
- | >>> | + | |
- | ==== No such file ==== | + | |
- | + | ||
- | >I have downloaded this plugin and all went okay, but when I process the backup I should find a back-up file in the root ("The backup file is generated and put in the root of your media directory" | + | |
- | >But there is no such file. What can be wrong? ---//FJH Langendam 08/ | + | |
- | >>The file should be created in the "root of your media directory," | + | |
- | >> | + | |
- | >>In other words, it should be creating a file in your " | + | |
- | + | ||
- | ==== Another Question ==== | + | |
- | + | ||
- | >Dear Terence, | + | |
- | > | + | |
- | >>Hi FJH, | + | |
- | >> | + | |
- | >> | + | |
- | >> | + | |
- | >> | + | |
- | >> | + | |
- | >> | + | |
- | >> | + | |
- | >> --- // | + | |
- | + | ||
- | ===== compression type configurable ===== | + | |
- | + | ||
- | >Hi Terence and thanks for your updates of this plugin. | + | |
- | > | + | |
- | > | + | |
- | + | ||
- | Hi Andreas, yes, I'll add the option as time permits. --- // | + | |
- | + | ||
- | ==== Backup in recursion ==== | + | |
- | >I suspect that when the option 'media files' is selected, backup-tool tries to backup the previous backups. Here is my quick solution. | + | |
- | > | + | |
- | >< | + | |
- | ==== Question about Tool ==== | + | |
- | + | ||
- | > - Can this tool be used to migrate data from one instance of DokuWiki to another instance running on some other host? \\ | + | |
- | > - Does this tool work for Windows? | + | |
- | > - (also side note: anyone know why my H2 is not being properly rendered by DokuWiki? | + | |
- | > | + | |
- | > --- //Peter Thung 12/ | + | |
- | >>Hi Peter, | + | |
- | >> | + | |
- | >> | + | |
- | >> | + | |
- | >> | + | |
- | >> | + | |
- | >> | + | |
- | >> | + | |
- | >> | + | |
- | >> --- // | + | |
- | >> | + | |
- | >>> | + | |
- | >>> | + | |
- | >>> | + | |
- | >>> | + | |
- | >>> | + | |
- | + | ||
- | + | ||
- | ==== What is the procedure to restore from the backup archive? ==== | + | |
- | + | ||
- | The following assumes that your Wiki is completely gone - you have nothing left then one backup-archive and the credentials of the Admin-User. | + | |
- | + | ||
- | - Start the installation of the latest version of doku-wiki as if you would start with a new wiki | + | |
- | - Run install.php as described in the installation-procedure of doku-wiki - you have to set the Admin-user (I used the same name and password as the one I used in the backed wiki; I do not know yet, if this is a requirement) | + | |
- | - The directories of '' | + | |
- | - Untar your backup and copy the three directories ('' | + | |
- | + | ||
- | That's all. | + | |
- | ==== Respect datadir for saving ==== | + | |
- | + | ||
- | Hi, in admin.php line 225, where the file gets saved, the plugin does not respect the setting of savedir to find the media directory. I changed the path to: " | + | |
- | + | ||
- | thanks for this plugin... | + | |
- | greets, | + | |
- | naja | + | |
- | + | ||
- | ==== Download is broken? ==== | + | |
- | + | ||
- | I get an " | + | |
- | --- //Marcus Gnaß 10/ | + | |
- | + | ||
- | + | ||
- | ==== Download still broken ==== | + | |
- | + | ||
- | Same here, the link is not working. All the best, heinz | + | |
- | + | ||
- | + | ||
- | ==== Download filename changed? ==== | + | |
- | + | ||
- | I also had problems finding it. | + | |
- | Note name difference above good link: from backup **→** backuptool | + | |
- | + | ||
- | _xxxx___cloud.github.com/ | + | |
- | http:// | + | |
- | + | ||
- | Thanks for the plug-in, 8-) =) | + | |
- | + | ||
- | Dave B | + | |
- | + | ||
- | + | ||
- | ==== Still problems finding backup file... ==== | + | |
- | + | ||
- | I get no errors or warnings until I try to click on the link where it says file not found. | + | |
- | I also do not find it using FTP...(hosted on byethost.com) | + | |
- | + | ||
- | --- //Mikael 11/ | + | |
- | ==== Also problems finding backup file ==== | + | |
- | I have earlier asked for the solution of not finding the backup file. | + | |
- | When I use the generated link, the anser is a HTTP 404-page as the link is: | + | |
- | http:// | + | |
- | + | ||
- | Offcourse the data/ | + | |
- | + | ||
- | I hope to hear from you.\\ | + | |
- | FJH, 08-05-2010 | + | |
- | + | ||
- | === Backup False failure === | + | |
- | Hmmm...newest backup stable version (really should display the actual version number on some page). | + | |
- | on VMWare -> Linux 2.6.9-42.ELsmp | + | |
- | + | ||
- | Says that it is failing, but is actually creating the TAR...just seems to not zip it? Is there some "use zip here" parameter? | + | |
- | --- // | + | |
- | + | ||
- | ==== Files from Mac OX included in the plugin==== | + | |
- | I install the plugin from the Plugin Manager and I found estrange files inside the plugin directory. I think it may be from some Mac OS system because I see that before when someone use my pendrive in that OS. | + | |
- | + | ||
- | The list of files is: | + | |
- | ._admin.php | + | |
- | ._.DS_Store | + | |
- | .DS_Store | + | |
- | ._lang | + | |
- | ._pref_code.php | + | |
- | + | ||
- | ===== A new version ===== | + | |
- | <del>It seems this plugin hasn't been maintained for a while, and some issues have built up. In particular I the old version didn't respect $conf[' | + | :!: **It is important to secure |
- | </ | + | |
- | While it's true I'm not keeping this project up-to-date, I'd suggest pushing changes to the original repo rather than forking it. I'm getting emails from users about multiple repos containing the same code. Push changes to me and I'll approve them. Thanks in advance. --- [[user> | + | ===== Restoring a Backup ===== |
- | === newest version does not work === | + | The following assumes that your Wiki is completely gone - you have nothing left then one backup-archive |
- | First: props to you for picking up this plugin and even expanding it! | + | |
- | Unfortunately, | + | |
- | | + | |
+ | | ||
+ | | ||
plugin/backup.1517949606.txt.gz · Last modified: 2018-02-06 21:40 by Aaron Smith