====== BackupTool for DokuWiki ======

---- plugin ----
description: Backup your site and configuration data to a file
author     : Terence J. Grant
email      : tjgrant@tatewake.com
type       : admin
lastupdate : 2020-10-21 
compatible : Igor, Jack Jackrum, Kaos
depends    : 
conflicts  : 
similar    : zip
tags       : maintenance, backup, archive

downloadurl: https://github.com/tatewake/dokuwiki-plugin-backup/archive/master.zip
sourcerepo : https://github.com/tatewake/dokuwiki-plugin-backup
bugtracker : https://github.com/tatewake/dokuwiki-plugin-backup/issues
donationurl: https://www.paypal.com/xclick/business=tjgrant%40tatewake.com&item_name=BackupTool%20for%20DokuWiki%20Donation&no_shipping=1&no_note=1&tax=0&currency_code=USD&lc=US

securitywarning: Be sure the backup namespace is properly protected by ACLs. The default wiki:backup is often publicly readable!
----

**
:!: The plugin's author has [[https://www.freelists.org/post/dokuwiki/Fwd-Retiring-my-DW-plugins|announced he retired support]] and [[https://github.com/tatewake/dokuwiki-plugin-backup|marked the repository as archived]], so this plugin's future is uncertain.
**

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, media files (your downloads), as well as your plugins and templates.


===== Installation =====

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

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.

==== Changes ====

{{rss>https://github.com/tatewake/dokuwiki-plugin-backup/commits/master.atom date}}

===== Usage =====

To access the plugin, make sure you're on the admin account, and click the admin button on your wiki site.

An entry named "Backup Tool" should be listed in the the available administrative tasks. Click it, and you will see a list of components to backup.

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.

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 your media directory. So you're then able to download it from there, and you may wish to delete it afterwards.

:!: **It is important to secure the backup namespace by [[:ACLs]] otherwise your backup files can be downloaded by anyone** :!:

===== Restoring a Backup =====

The following assumes that your Wiki is completely gone - you have nothing left then one backup-archive and the credentials of the Admin-User. It also assumes that you backed up at least your configuration and pages.

  - Start the installation of the latest version of DokuWiki as if you would start with a new wiki
  - Untar your backup and copy the three directories (''conf'', ''data'' and ''lib'') to your wikis destination-dir, overwriting any possibly existing files
  - You should now be able to log in with your previously used admin account.