GetAWebPlugin

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.

Demo

• http://www.twiki.org/cgi-bin/rest/GetAWebPlugin/getaweb/Blog.tar
• http://www.twiki.org/cgi-bin/rest/GetAWebPlugin/getaweb/Codev.tar
• http://www.twiki.org/cgi-bin/rest/GetAWebPlugin/getaweb/Main.tar
• http://www.twiki.org/cgi-bin/rest/GetAWebPlugin/getaweb/Plugins.tar
• http://www.twiki.org/cgi-bin/rest/GetAWebPlugin/getaweb/Sandbox.tar
• http://www.twiki.org/cgi-bin/rest/GetAWebPlugin/getaweb/Support.tar
• http://www.twiki.org/cgi-bin/rest/GetAWebPlugin/getaweb/TWiki.tar
• http://www.twiki.org/cgi-bin/rest/GetAWebPlugin/getaweb/TWiki01.tar
• http://www.twiki.org/cgi-bin/rest/GetAWebPlugin/getaweb/TWiki02.tar
• http://www.twiki.org/cgi-bin/rest/GetAWebPlugin/getaweb/TWiki03.tar
• http://www.twiki.org/cgi-bin/rest/GetAWebPlugin/getaweb/TWiki04.tar
• http://www.twiki.org/cgi-bin/rest/GetAWebPlugin/getaweb/TWiki04x01.tar
• http://www.twiki.org/cgi-bin/rest/GetAWebPlugin/getaweb/TWiki04x02.tar
• http://www.twiki.org/cgi-bin/rest/GetAWebPlugin/getaweb/TWiki04x03.tar
• http://www.twiki.org/cgi-bin/rest/GetAWebPlugin/getaweb/TWiki05x00.tar
• http://www.twiki.org/cgi-bin/rest/GetAWebPlugin/getaweb/TWiki05x01.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 BuildContrib.

• If you have TWiki 4.2 or later, you can install from the configure interface (Go to Plugins->Find More Extensions)
  • See the 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
  2. Unpack the archive in the root directory of your TWiki installation.
  3. Run the installer script ( perl <module>_installer )
  4. Run configure and enable the module, if it is a plugin.
  5. 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.
  2. 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)
  3. Manually edit LocalSite.cfg to set any configuration variables.

Plugin Info

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

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences