%META:TOPICINFO{author="TWikiContributor" date="1298523429" format="1.1" version="1"}%
---+!! <nop>GetAWebAddOn
<!--
   Contributions to this add-on are appreciated. Please update the add-on page at
   http://twiki.org/cgi-bin/view/Plugins/GetAWebAddOn or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/GetAWebAddOnDev.
   If you are a TWiki contributor please update the add-on in the SVN repository.
-->
<sticky><div style="float:right; background-color:#EBEEF0; margin:0 0 20px 20px; padding: 0 10px 0 10px;">
%TOC{title="Page contents"}%
</div></sticky>
%SHORTDESCRIPTION%

---++ Introduction

Sometime it is useful to make a copy of a TWiki web from remote for backup or for offline reading. This add-on archives a whole TWiki web.

---++ Supported File Formats

The script produces files in the =.tar= format.

---++ Usage

| Web | Format | Versions | URI |
| Webname | tar | all | =%<nop>SCRIPTURL{get-a-web}%/Webname/Webname.tar= |

---++ Security

   * All the twiki/data, twiki/pub and twiki/template files of the chosen web are archived, except for the .htaccess and .htpasswd and the *.lock files.
   * User authentication can be handled with apache =&lt;Location&gt;= directive.
   * Any user that can access this script is able to get a full copy of the entire web - TWiki security is __NOT__ respected. Use with caution.

---++ Demo

%WEBLIST{ format="   * %SCRIPTURL{get-a-web}%/$name/TWiki-$name.tar" }%

---++ Installation

   * Unzip in twiki root directory

---++ Add-On Info

   * Set SHORTDESCRIPTION = Make a copy of a whole TWiki web for backup or for offline reading

|  Add-on Author: | TWiki:Main.AndreaSterbini, TWiki:Main.WillNorris, TWiki:Main.SvenDowideit |
|  Copyright: | &copy; 2004-2005 TWiki:Main.WillNorris, &copy; 2004-2011 TWiki:TWiki.TWikiContributor |
|  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
|  Add-on Version: | 2011-02-23 |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  2011-02-23: | TWikibug:Item6638: Fix for TWiki-5.0; doc improvements; changing TWIKIWEB to SYSTEMWEB -- Main.PeterThoeny |
|   25 June 2008: | 0.98 fixed problem running on TWiki 4.2 - TWiki:Main.SvenDowideit |
|   7 Feb 2005: | 0.97 made compatable with Cairo _or_ DEVELOP |
|   8 Dec 2004: | 0.96 added more error checking, redirects errors to browser for easier debugging |
|   2 Dec 2004: | 0.95 updated to use Archive::Tar instead of system calls (only tar is available atm); also now works correctly and automatically regardless of whether your pub, templates, and data directories all share the same parent directory, or are spread out |
|  12 Oct 2004: | 0.9 for TWiki:Codev/TWikiRelease01Sep2004 |
|  17 Sep 2000: | Initial version |
|  CPAN Dependencies: | CPAN:Archive::Tar |
|  Other Dependencies: | none |
|  Perl Version: | 5.005 |
|  Add-on Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
|  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |

__Related Topic:__ %SYSTEMWEB%.TWikiAddOns
