%META:TOPICINFO{author="TWikiContributor" date="1295588582" format="1.1" version="$Rev$"}%
---+!! !GetAWebPlugin
<!--
   Contributions to this TWiki plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/GetAWebPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/GetAWebPluginDev.
   If you are a TWiki contributor please update the plugin 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%

---++ Usage

This Plugin can be used in a secure way to backup the contents of a web. It uses the TWiki rest api, so requires authorisation, and checks the =VIEW= permissions on the latest revision of the topic before adding the topic, its =,v= file and the attachments listed in each topic.

| Web | Format | URI |
| Webname | tar |  =%<nop>SCRIPTURL{rest}%/GetAWebPlugin/getaweb/Webname.tar= |


---++ Demo

%WEBLIST{ format="	* %SCRIPTURL{rest}%/GetAWebPlugin/getaweb/$name.tar" }%

---++ Installation Instructions

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server where TWiki is running.

Like many other TWiki extensions, this module is shipped with a fully
automatic installer script written using the Build<nop>Contrib.
   * If you have TWiki 4.2 or later, you can install from the =configure= interface (Go to Plugins->Find More Extensions)
      * See the [[http://twiki.org/cgi-bin/view/Plugins/BuildContribInstallationSupplement][installation supplement]] on TWiki.org for more information.
   * If you have any problems, then you can still install manually from the command-line:
      1 Download one of the =.zip= or =.tgz= archives
      1 Unpack the archive in the root directory of your TWiki installation.
      1 Run the installer script ( =perl &lt;module&gt;_installer= )
      1 Run =configure= and enable the module, if it is a plugin.
      1 Repeat for any missing dependencies.
   * If you are *still* having problems, then instead of running the installer script:
      1 Make sure that the file permissions allow the webserver user to access all files.
      1 Check in any installed files that have existing =,v= files in your existing install (take care *not* to lock the files when you check in)
      1 Manually edit !LocalSite.cfg to set any configuration variables.

%IF{"defined 'SYSTEMWEB'" else="<div class='twikiAlert'>%X% WARNING: SYSTEMWEB is not defined in this TWiki. Please add these definitions to your %MAINWEB%.TWikiPreferences, if they are not already there:<br><pre>   * <nop>Set SYSTEMWEB = %<nop>TWIKIWEB%<br>   * <nop>Set USERSWEB = %<nop>MAINWEB%</pre></div>"}%


---++ Plugin Info

   * Set SHORTDESCRIPTION = Create a tar-ed copy of a whole Web for backup or offline reading

|  Plugin Author: | TWiki:Main.SvenDowideit |
|  Copyright: | &copy; 2008 SvenDowideit@fosiki.com <br /> &copy; 2008-2011 TWiki:TWiki.TWikiContributor |
|  License: | [[http://www.gnu.org/licenses/gpl.html][GPL (Gnu General Public License)]] |
|  Plugin Version: | 20278 (2011-01-20) |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  2011-01-20: | TWikibug:Item6638: Fixing bug in path to attachment (topic name was missing); doc improvements; changing TWIKIWEB to SYSTEMWEB -- TWiki:Main.PeterThoeny |
|  2008-06-25: | Initial version |
|  Dependencies: | <table border="1"><tr><th>Name</th><th>Version</th><th>Description</th></tr><tr><td align="left">Archive::Tar</td><td align="left">&gt;=1</td><td align="left">Required</td></tr></table> |
|  Plugin Home: | http://twiki.org/cgi-bin/view/Plugins/GetAWebPlugin |
|  Feedback: | http://twiki.org/cgi-bin/view/Plugins/GetAWebPluginDev |
|  Appraisal: | http://twiki.org/cgi-bin/view/Plugins/GetAWebPluginAppraisal |

__Related Topics:__ %SYSTEMWEB%.TWikiPlugins, %SYSTEMWEB%.DeveloperDocumentationCategory, %SYSTEMWEB%.AdminDocumentationCategory, %SYSTEMWEB%.TWikiPreferences
