create new tag
view all tags


Make a copy of a whole TWiki web for backup or for offline reading


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.


Web Format Versions URI
Webname tar all %SCRIPTURL{get-a-web}%/Webname/Webname.tar


  • 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 <Location> 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.



  • 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: © 2004-2005 TWiki:Main.WillNorris, © 2004-2011 TWiki:TWiki.TWikiContributor
License: GPL (GNU General Public License)
Add-on Version: 2011-02-23
Change History:  
2011-02-23: TWikibug:Item6638: Fix for TWiki-5.0; doc improvements; changing TWIKIWEB to SYSTEMWEB -- 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/GetAWebAddOn
Feedback: http://TWiki.org/cgi-bin/view/Plugins/GetAWebAddOnDev

Related Topic: TWikiAddOns

Edit | Attach | Watch | Print version | History: r2 < r1 | Backlinks | Raw View | More topic actions
Topic revision: r2 - 2015-06-17 - TWikiAdminUser
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2020 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.GetAWebAddOn.