%META:TOPICINFO{author="TWikiContributor" date="1354425909" format="1.1" version="$Rev$"}%
---+!! !HostnamePlugin
<!--
   Contributions to this plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/HostnamePlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/HostnamePluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.

   One line description, required for extensions repository catalog:
   * Set SHORTDESCRIPTION = Displays the hostname of the server serving TWiki.
-->
<sticky><div style="float:right; background-color:#eeeeee; margin:0 0 20px 20px; padding: 0 10px 0 10px;">
%TOC{title="Page contents"}%
</div></sticky>
%SHORTDESCRIPTION%

---++ Usage

%INCLUDE{ "VarHOSTNAME" section="syntax" }%

---++ Installation Instructions

__Note:__ You do not need to install anything on the browser to use this extension. The following instructions are for the administrator who installs the extension on the TWiki server.

   * For an __automated installation__, run the [[%SCRIPTURL{configure}%][configure]] script and follow "Find More Extensions" in the in the __Extensions__ section.
      * See the [[http://twiki.org/cgi-bin/view/Plugins/BuildContribInstallationSupplement][installation supplement]] on TWiki.org for more information.

   * Or, follow these __manual installation__ steps:
      * Download the ZIP file from the extension home on twiki.org (see below).
      * Unzip ==%TOPIC%.zip== in your twiki installation directory.
      * Set the ownership of the extracted directories and files to the webserver user.
      * Install the dependencies (if any).

   * Plugin __configuration and testing__: 
      * Run the [[%SCRIPTURL{configure}%][configure]] script and enable the plugin in the __Plugins__ section.
      * Configure additional plugin settings in the __Extensions__ section if needed.
      * Test if the installation was successful using the examples provided.


---++ Plugin Files

   | *File:* | *Description:* |
   | ==data/TWiki/HostnamePlugin.txt== | Documentation |
   | ==data/TWiki/VarHOSTNAME.txt== | Variable documentation |
   | ==lib/TWiki/Plugins/HostnamePlugin.pm== | Perl module |


---++ Plugin Info

|  Plugin Author(s): | TWiki:Main.AndrewRJones |
|  Copyright: | &copy; 2007 TWiki:Main.AndrewRJones, %BR% &copy; 2007-2012 TWiki:TWiki.TWikiContributor |
|  License: | [[http://www.gnu.org/licenses/gpl.html][GPL (Gnu General Public License)]] |
|  Plugin Version: | 2012-12-01 |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  2012-12-01: | TWikibug:Item7020: Categorize TWiki Variable HOSTNAME -- TWiki:Main.PeterThoeny|
|  2010-07-25 | TWikibug:Item6530 - doc fixes |
|  14486 | Bugs:Item4420 - Initial version |
|  Dependencies: | <table border="1"><tr><th>Name</th><th>Version</th><th>Description</th></tr><tr><td align="left">Sys::Hostname</td><td align="left">&gt;=1.11</td><td align="left">Required</td></tr></table> |
|  Plugin Home: | http://twiki.org/cgi-bin/view/Plugins/HostnamePlugin |
|  Feedback: | http://twiki.org/cgi-bin/view/Plugins/HostnamePluginDev |
|  Appraisal: | http://twiki.org/cgi-bin/view/Plugins/HostnamePluginAppraisal |

__Related Topics:__ VarHOSTNAME, %SYSTEMWEB%.TWikiPlugins, %SYSTEMWEB%.DeveloperDocumentationCategory, %SYSTEMWEB%.AdminDocumentationCategory, %SYSTEMWEB%.TWikiVariables
