INSTALL.html Installation Guide Part 2 continues with steps for tailoring and enhancing your site.
These installation instructions are also available online at Foswiki:System.InstallationGuide, and are available within your Foswiki installation at System.InstallationGuide (the InstallationGuide topic in the System web).
For information on upgrades, please also refer to Foswiki:System.UpgradeGuide. A static HTML version of this document, UpgradeGuide.html, is included in the root of your Foswiki distribution.
UpgradeGuide.html, is included in the root of your Foswiki distribution.
Verify that your server meets the Foswiki system requirements, including having the minimum required Perl version and all required Perl modules installed. If you need to install any Perl libraries from CPAN for use by Foswiki, see Foswiki:Support.HowToInstallCpanModules for more information.
If you need help, feel free to ask a question in the Foswiki:Support web or on Foswiki:Community.InternetRelayChat (irc.freenode.net, channel #foswiki).
/path/to/foswiki. foswiki directory tree.
Note: for more information on the appropriate permissions to ensure security for your Foswiki data, see Foswiki:Support.SecuringYourSite.
The default file and directory access permissions as set by the distribution define a reasonable security level that will work for many types of installations, including shared hosting. Nonetheless, you should verify that the web server user has read access to all files and directories beneath the foswiki directory, and execute access for all directories. Also verify that the data and pub directories and all the subdirectories and files beneath them allow write access for the web server user. chmod -R 770 foswiki. Providing execute access to all files is potentially dangerous. This is a common mistake made by Foswiki installers. See Foswiki:Support.SettingFileAccessRightsLinuxUnix for a sample set of Unix commands to set the file and directory permissions.
foswiki directory tree to the web server user, using the command chown -R user:group /path/to/foswiki. The web server username varies in different installations; here are some sample commands for various Linux distributions: chown -R apache:apache /path/to/foswiki
chown -R www-data:www-data /path/to/foswiki
chown -R wwwrun:www /path/to/foswiki
/usr/bin/perl then this step is not required. This step is required on Windows installations.
The easiest way to fix up the bin scripts is to run the tools/rewriteshebang.pl script. If the Perl interpreter is in the default execution path, follow these steps:
cd /path/to/foswiki/tools perl -I ../lib rewriteshebang.plor for Windows users:
cd C:\path\to\foswiki\tools perl -I ..\lib rewriteshebang.plThe script will determine the location of the Perl interpreter and will prompt to update both the bin and tools scripts in a single step. The changed files will be reported, and it is safe to rerun the script. If the
perl command does not work from the command line, then you need to find the location of your system's Perl interpreter. Insert the path to Perl in the first line of the rewriteshebang script. For example:
cd C:\path\to\foswiki\tools C:\path\to\perl -I ..\lib rewriteshebang.pl
.cgi or .pl). This is not normally required with the Apache web server, though some hosted web servers are configured to require it. If the documentation for your web server indicates that a special extension is necessary, rename all the executable scripts in bin; that is, rename bin/view to bin/view.pl, and so on. When configuring Foswiki (see the section "Configure Foswiki"), set the ScriptSuffix option to the special extension.
bin/ and lib/ located under the Foswiki installation directory. If you have moved these directories, or if your system requires changes to the default Perl libraries, then this step is required.
Create the file LocalLib.cfg located at bin/LocalLib.cfg bin directory, copy the template file LocalLib.cfg.txt to LocalLib.cfg. Make sure the ownership and access rights of the copy are the same as LocalLib.cfg.txt.
bin/LocalLib.cfg so that $foswikiLibPath is set to the absolute file path of your lib directory. For example: /path/to/foswiki/lib.
$CPANBASE to point to your personal CPAN install. Don't forget that the web server user has to be able to read those files as well.
foswiki.conf). Performance is much better with a config file, and one file gives the best overview and ensures that you get a safe installation . However to use a config file you need root or sudo access to stop and start Apache. The Foswiki apache config file can be included from the main Apache config file. (Typically httpd.conf or apache.conf depending on your distribution). However most distributions have a directory from which any file that ends with .conf gets included when you restart Apache (Example RedHat/Fedora/Centos: /etc/httpd/conf.d, Gentoo: /etc/apache2/vhost.d ). If you use a virtual host setup in Apache you should include the foswiki.conf file from inside the desired virtual host config in your Apache configuration.
.htaccess files on each page access. Normally this is the only way to control Apache in a shared host environment where you have no root or sudo privileges.
foswiki_httpd_conf.txt can be found in the root of the foswiki installation.
bin and pub. foswiki_httpd_conf.txt file also has examples of configuring Apache appropriately.
ScriptAlias directive for the bin subdirectory, or an Alias directive with SetHandler cgi-script and Options ExecCGI directives for the bin subdirectory, so that the bin scripts will be executed by Apache.
.htaccess files for various subdirectories in your installation. Each file has help text explaining how to modify it for your configuration. For more information, see Foswiki:Support.SupplementalDocuments. | location and name of sample .htaccess file | copy sample file to the following location |
|---|---|
foswiki/root-htaccess.txt | foswiki/.htaccess |
foswiki/bin-htaccess.txt | foswiki/bin/.htaccess |
foswiki/pub-htaccess.txt | foswiki/pub/.htaccess |
foswiki/subdir-htaccess.txt | foswiki/<subdir>/.htaccess Copy to all other subdirectories below foswiki, including data, lib, locale, templates, tools, working. Copy to any other directories except for bin and pub addressed above. |
bin and pub. The sample .htaccess files show how to configure Apache appropriately. It is important to verify that none of these directories can be directly accessed.
foswiki/bin/.htaccess files contains the line SetHandler cgi-script so that all scripts in the bin directory will be executed by Apache.
.htaccess are hidden files and will not be listed unless using the -a option, ex. ls -la
pub directory. For example, most Linux distributions have a default Apache installation with PHP and server side include (SSI) enabled. This would allow PHP scripts uploaded as attachments to be executed, which is a security risk, so it should be disabled in the Apache configuration with php_admin_flag engine off.
Different script execution mechanisms are disabled in different ways; see your web server configuration and documentation for more details.
configure script open to the public. Limit access to the bin/configure script to either localhost, an IP address or a specific user using basic Apache authentication. The Foswiki:Support.ApacheConfigGenerator lets you setup who has access to the configure script. Also see the foswiki-httpd-conf.txt or bin/.htaccess.txt file for an example of the setting required to protect the configure script.
To limit access to a particular user, set up a .htpasswd file that contains the user name and password that Apache will use to authenticate the user: .htpasswd file. It will destroy the email addresses stored in that file! If the file already exists, you can choose an existing user for access to configure.
foswiki/data directory.
htpasswd -c .htpasswd <username>, where <username> is the name of the user you will use to access the configure script. Choose the username with care: the username cannot be an existing login name for your Foswiki installation, nor can it be used later on to register in Foswiki. Enter a password when prompted.
.htaccess files, all include example settings to protect the configure script with a password. The critical section looks something like:
<FilesMatch "configure.*">
SetHandler cgi-script
Order Deny,Allow
Deny from all
# List of IP addresses allowed to access configure
Allow from 127.0.0.1 192.168.1.10
# specify username used on the "htpasswd" command above
Require user someuserid
# Set to "Any" to allow IP -or- userid, set to "All" to require both match
Satisfy Any
ErrorDocument 401 default
</FilesMatch>
Note: In addition to any web server security protection that you have set up, when saving any configuration settings for the first time on the configure web page, you will be prompted to set a configuration password. This password must be entered on all subsequent configuration changes, and is also used to log in via the internal admin link (see the section "Define the administrator user(s)"). Even after a configure password has been set, access to the configure page should still be restricted by the web server, in order to avoid revealing internal information to potential attackers.
Tip: You do not have to use the same password file for both Configure and for Foswiki user registration. If you use a separate file, you can create it using theFor more information, refer to Foswiki:Support.ProtectingYourConfiguration.htpasswdcommmand and complete segregate configure access from Foswiki access. This is probably safer, but does not allow users to change their configure password using Foswiki services. The password file has to be manually maintained..
- Generate an alternate password file to protect configure.
htpasswd -c -s /path/to/data/.htpasswd-admin configuserid- Add / modify and delete this alternate file using the
htpasswdcommand. Don't mix them up and usehtpasswdon the Foswiki .htpasswd file!- Edit the foswiki apache configuration and modify the block (shown above) that protects the configuration command. Add or modify the following statements in the block. Don't remove the other statements!
<FilesMatch "configure.*"> AuthType Basic AuthName "admins only" AuthUserFile /path/to/data/.htpasswd-admin # Changing the Require user to Require valid-user allows any ID in the # file access to configure! Require valid-user </FilesMatch>
http://yourdomain/url/to/foswiki/bin/configure into your browser address bar. configure web page for the first time, you can only edit the section General Path Settings. Make any required changes, and save the settings, whether or not you needed to make any changes. You will be prompted to set a password for the configure page: this password must be entered for all subsequent configuration changes, and is also used to log in via the internal admin link (see the section "Define the administrator user(s)"). Note: The
configurepassword is remembered byconfigure, separate to web server access controls mentioned in "Protect the configure script".
General Path Settings, continue configuring Foswiki. Configuration items which may require further attention will be highlighted.
{PermittedRedirectHostUrls}. Example: if
{DefaultUrlHost}is set tohttps://wiki.company.com, an example{PermittedRedirectHostUrls}might contain:https://company.com, http://111.222.123.234
Mail and Proxies section. Email must be available so Foswiki can send registration emails. {EnableEmail}. Otherwise the {WebMasterEmail} parameter must be configured.
MailProgram is typically suitable on most Linux systems, and no further configuration is required.
Net::SMPT methods, you must also configure {SMTP}{MAILHOST}. Many ISPs have introduced authentication when sending emails to fight spam so you may also have to set {SMTP}{Username} and {SMTP}{Password}.
Net::SMTP::SSL will encrypt the connection to the e-mail server and is required for some email services like Google's GMail.
configure, you may have to set {PROXY}{HOST} and {PROXY}{PORT}. SMTP authentication requires additional perl modules includingNote: A standard Foswiki installation will not allow any new registrations unless there is a working SMTP configuration
Authen::SASL and MIMI::Base64,
configure page, you can configure Foswiki manually.
mod_auth_ldap or mod_auth_mysql. However, as your browser is caching your login, you must restart the browser to log out.
System.InstallationGuide into the "Jump" text box. By doing this instead of using the INSTALL.html file from the distribution, you will be able to use the embedded hyperlinks to jump directly to the referenced pages.
By default, your Foswiki installation is probably already using TemplateLogin, HtPasswdUser and Topic User Mapping Contrib as the default
Login,Passwordanduser mappingoptions.
Login tab on the Security and Authentication panel. Select the Foswiki::LoginManager::TemplateLogin login manager.
Passwords tab. Select the appropriate PasswordManager for your system - the default is Foswiki::Users::HtPasswdUser. There is also an EXPERT configure setting
{TemplateLogin}{PreventBrowserRememberingPassword}that you can set to prevent Browsers from remembering username and passwords if you are concerned about public terminal usage.
HtPasswdUser (the default), check the .htpasswd file is being updated correctly with a new entry. If not, check {Htpasswd}{FileName} is correct (under Security and Authentication on the Password tab in configure), and that the webserver user has write permission.
This is a very important step, as users in this group can access all topics, independent of Foswiki access controls.
Foswiki AccessControls do not protect topic attachments unless the web server has been configured to do so using the
viewfilescript. Visit Foswiki:Support.ApacheConfigGenerator for examples using Apache.As Template Login uses a wiki page for its login prompt, there is a great deal of flexibility in customizing the login page for your purposes.
The default new user template page is in System.NewUserTemplate. The same macros get expanded as in the template topics. You can create a custom new user topic by creating the NewUserTemplate topic in Main web, which will then override the default in System web. See System.UserForm for copy instructions.
EXCLUDED_ from the INCLUDE tags) or add new ones.
New fields may also be added. The name="" parameter of the <input> tags must start with: "Fwk0..." (if this is an optional entry), or "Fwk1..." (if this is a required entry). This ensures that the fields are carried over into the user home page correctly.
Self-registration by Guest users Registration by logged-in users mod_auth_ldap or mod_auth_mysql you can just plug in to them directly.
The disadvantage is that because the user identity is cached in the browser, you can log in, but you can't log out again unless you restart the browser.
Foswiki maps the REMOTE_USER that was used to log in to the webserver to a WikiName using the table in Main.WikiUsers. This table is updated whenever a user registers, so users can choose not to register (in which case their webserver login name is used for their signature) or register (in which case that login name is mapped to their WikiName).
The same private .htpasswd file used in Foswiki Template Login can be used to authenticate Apache users, using the Apache Basic Authentication support.
To setup Apache Login, perform the following steps:Do not use the Apache
htpasswdprogram with.htpasswdfiles generated by Foswiki!htpasswdwipes out email addresses that Foswiki plants in the info fields of this file.Apache Login is required for Apache-based login methods such as mod_ldap
You can use any Apache authentication module that sets the
REMOTE_USERenvironment variable.
Security and Authentication pane on the Login tab in configure: Foswiki::LoginManager::ApacheLogin for {LoginManager}.
Foswiki::Users::HtPasswdUser for {PasswordManager}.
Foswiki::Users::TopicUserMapping for {UserMappingManager}.
foswiki/bin-htaccess.txt file to set the following Apache directives on the bin scripts: <FilesMatch "(attach|edit|manage|rename|save|upload|mail|logon|rest|.*auth).*"> require valid-user </FilesMatch>You can also refer to the sample
foswiki_httpd_conf.txt and bin-htaccess.txt files to see how the appropriate Apache directives are specified.
HtPasswdUser (the default), check the .htpasswd file is being updated correctly with a new entry. If not, check {Htpasswd}{FileName} is correct (under Security and Authentication on the Password tab in configure), and that the webserver user has write permission.
This is a very important step, as users in this group can access all topics, independent of Foswiki access controls.
Store pane in configure you will find the setting {RCS}{SearchAlgorithm}.
By default it is set to Foswiki::Store::SearchAlgorithms::Forking which is what you should keep if you install Foswiki in Linux or any other Unix type operating system.
If you install Foswiki on a Windows server, using an external grep program can create problems because of limitations in the length of command lines. You may be able to run with Forking in Windows if your directory path to Foswiki is kept short (short directory names and few levels), however the recommended (safe) setting for Windows is Foswiki::Store::SearchAlgorithms::PurePerl.
admin and the password established when initially saving the configuration. Don't log in with the wikiname AdminUser.
After installing Foswiki, you can also register other users that you will use to administer Foswiki. To make a user an administrator, add the WikiName for the user to the AdminGroup, defined in the Main.Admin Group topic in your Foswiki installation.
Note that with the sudo or internal admin login, it is not necessary to add other users to the AdminGroup. However if you have more than one administrator, you may still want to do this to ensure that topic changes are attributed to a specific user instead of the default Main.AdminUser.
By adding users to Main.AdminGroup: bin/configure password is not required
bin/configure will need to be shared among administrators
System.InstallationGuide into the "Jump" text box. By doing this instead of using the INSTALL.html file from the distribution, you will be able to use the embedded hyperlinks to jump directly to the referenced pages.
To add an initial administrator to the AdminGroup, perform the following steps:
Main.Admin Group topic and select the "internal admin login" link. Login using the password you set on the configure page.
Main.AdminGroup topic. Follow the instructions on the page to add users to the AdminGroup. You do not need to edit the topic.
AdminGroup that you use only for administering your Foswiki site. See System.Access Controls for more information on access controls and user groups.
http://yourdomain.com/url/to/foswiki/bin/view/System/InstallationGuidePart2 to proceed with further tailoring your site..
In order to keep your user, group, and site configuration information separate from the actual content of your site, it is recommended that you create a new web in which your site's pages will reside. See System.Managing Webs for more information on Wiki webs and how to create one.
configure script and make sure you have resolved all errors and are satisfied that you understand any warnings.
| Resource | Required Server Environment |
|---|---|
| Perl | 5.8.8 or higher is recommended and it will run with Perl >=5.8.4 and <5.8.8 but this is untested. It also runs in Perl 5.6.1 but only with Wysiwyg editor disabled. Wysiwyg requires Unicode support which is provided by perl 5.8.1 onwards. |
| RCS | 5.7 or higher (including GNU diff) Optional. Foswiki includes a pure Perl implementation of RCS (RcsLite) that can be used instead, at the cost of performance |
| GNU diff | GNU diff 2.7 or higher is required when not using the all-Perl RcsLite. Install within the PATH if not included with RCS (check version with diff -v) Must be the version used by RCS, to avoid problems with binary attachments - RCS may have hard-coded path to diff |
| Other external programs | fgrep, egrep |
| Cron/scheduler | • Unix: cron • Windows: cron equivalents |
| Web server | Apache is well supported; for information on other servers, see Foswiki:Support.InstallingOnSpecificPlatforms. |
dependencies_installer.pl located in the tools directory, which makes perl module installation easier. Run it with option -h to understand basics. This script requires confirmation before it actually does something.
| Module | Preferred version | Required/Optional |
Description |
|---|---|---|---|
| Algorithm::Diff | Required | Included with Foswiki | |
| CGI | Versions 2.89, 3.37, 3.43, and 3.47 must be avoided. Most versions from 3.15 and onwards should work. | Required | Included with Perl core since Perl 5.4 |
| Error | Required | Included with Foswiki | |
| Apache::Htpasswd | Optional | May be required for ApacheHtpasswd password manager | |
| Archive::Tar | Optional | May be required by the Extensions Installer in configure if command line tar or unzip is not available, since Perl 5.9.3 part of core. | |
| Archive::Zip | Optional | Alternative to Archive::Tar, used by the Extensions Installer if Archive::Tar also unavailable | |
| CGI::Session | Optional | Required for Sessions support, available from the CPAN archive | |
| Digest::SHA | Optional | May be required for password encryption, since Perl 5.9.3 part of core | |
| Digest::SHA1 | Optional | ||
| Encode::compat | Optional | May be required for international characters | |
| HTML::Entities | Optional | Required for Foswiki:Extensions.WysiwygPlugin | |
| HTML::Parser | Optional | Required for Foswiki:Extensions.WysiwygPlugin | |
| Lingua::EN::Sentence | Optional | May be required for generating new language files | |
| Locale::Maketext::Lexicon | >=0 | Optional | Used for I18N support |
| LWP | Optional | Required for the Configure Extensions Installer, and for external URL based INCLUDEs | |
| URI | Optional | Required by the configure script | |
| Win32::Console | Optional | May be required for Windows |
perl -le 'use ModuleName; print "ModuleName"->VERSION'
pub directory.)
lib directory at the same level as the bin directory. You can create this directory elsewhere and configure the bin/setlib.cfg file. | Foswiki dir: | What it is: | Where to copy: | Example: |
|---|---|---|---|
foswiki | start-up pages | root Foswiki dir | /home/smith/public_html/foswiki/ |
foswiki/bin | CGI bin | CGI-enabled dir | /home/smith/public_html/foswiki/bin |
foswiki/lib | library files | same level as bin | /home/smith/public_html/foswiki/lib |
foswiki/locale | language files | dir secure from public access | /home/smith/public_html/foswiki/locale |
foswiki/pub | public files | htdoc enabled dir | /home/smith/public_html/foswiki/pub |
foswiki/data | topic data | dir secure from public access | /home/smith/public_html/foswiki/data |
foswiki/templates | web templates | dir secure from public access | /home/smith/public_html/foswiki/templates |
foswiki/tools | Foswiki utlilities | dir secure from public access | /home/smith/public_html/foswiki/tools |
foswiki/working | Temporary and internal files | dir secure from public access | /home/smith/public_html/foswiki/working |
configure page) configure page. However, if you are unable to get the configure page to display (for example, if a dependency is missing), or for some reason you do not wish to use the configure page, then you can configure Foswiki manually
Perform the following steps to manually configure Foswiki: lib/Foswiki.spec to lib/LocalSite.cfg
$Foswiki::cfg{DefaultUrlHost}
$Foswiki::cfg{ScriptUrlPath}
$Foswiki::cfg{ScriptDir}
$Foswiki::cfg{PubUrlPath}
$Foswiki::cfg{PubDir}
$Foswiki::cfg{DataDir}
$Foswiki::cfg{ToolsDir}
$Foswiki::cfg{TemplateDir}
$Foswiki::cfg{LocalesDir}
$Foswiki::cfg{WorkingDir}
$Foswiki::cfg{OS}
$Foswiki::cfg{LoginManager}
$Foswiki::cfg{WebMasterEmail}
$Foswiki::cfg{SMTP}{MAILHOST}
$Foswiki::cfg{SMTP}{SENDERHOST}
__END__ and everything following it.
System.Skins refers to the Skins topic in your System web. To go directly to a topic, enter the full topic name, such as System.Skins, into the "Jump" text box at the top right of any Foswiki page.
To make it easier to follow the instructions in this section, you can view this installation guide using your Foswiki site by entering System.InstallationGuide into the "Jump" text box. By doing this instead of using the INSTALL.html file from the distribution, you will be able to use the embedded hyperlinks to jump directly to the referenced pages.
All of the Foswiki documentation can also be found online in the Foswiki documentation section (the "System" web) of the Foswiki web site.
Note the configure page mentioned in this section is accessed by visiting http://www.redbourn.org.uk/bin/configure your web browser.
Main.SitePreferences. If a given preference is not set in Main.SitePreferences, then a default value is picked up from System.Default Preferences, if present, or, for extensions, from the extension topics.
To simplify your upgrades, do not modify System.DefaultPreferences. Instead, copy any settings you want to change from System.DefaultPreferences to Main.SitePreferences.
To see the available preferences that can be set, look through System.Default Preferences.
If, for some reason, you wish to pick up default preferences from a different topic, you can set the location in the Miscellaneous settings pane of the configure page, in the {SitePrefsTopicName} setting (visible when Expert mode is enabled). It is recommended that you leave this setting to its default value, DefaultPreferences.
configure page.
tools/mailnotify script, as described in the System.Mailer Contrib topic.
{WebMasterEmail} email account. Obtain these as you would for any other S/MIME e-mail user.
To enable Foswiki to sign administrative e-mails: Crypt::SMIME installed.
/etc/pki/tls/certs
configure script, change the following settings under Mail and Proxies: {MailMethod} and {MailProgram} to enable an external mail program such as sendmail. Net::SMTP is not supported. {SMTP}{MAILHOST}, {SMTP}{SENDERHOST}, {SMTP}{Username} and {SMTP}{Password} are not used an may be deleted.
SMTPMAILHOST is defined in Main.Site Preferences it should be removed.
{SmimeCertificateFile} configuration variable
{SmimeKeyFile} configuration variable
configure script an resolve any errors that it identifies
tools/tick_foswiki.pl script, and set a negative value on the configure page for {Sessions}{ExpireAfter}. For more details, read System.Command And CGIScripts#tick foswiki pl.
Localisation section of the configure page. For more information, see Foswiki:Support.InternationalizationSupplement.
ALLOWTOPICCHANGE preference setting to Main.New User Template? so only the user can edit their own user topic. In particular, on a public Foswiki site, restricting edit access will avoid vandalism and spam.
WEBCOPYRIGHT preference. Its default is the following: Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
If your Foswiki site is used in an environment without public access you should replace this with your normal copyright notice. You should also consider adding a security classification (e.g., For Internal Use Only) so people do not have to add this manually to every new topic.
If your Foswiki site is publicly accessible, you need to decide which copyright and license you wish to apply to all contributions. For open source applications, licenses such as the GNU Free Documentation License, FreeBSD Documentation License, and one of the various Creative Commons licenses are possible licenses to consider. Remember that once people have started contributing, you cannot retroactively change the license (unless it has a provision for this).
To change the copyright statement, perform the following steps:
WEBCOPYRIGHT preference setting from System.Default Preferences to Main.SitePreferences. Change the value to your desired text. This value will be your new default across all webs.
WEBCOPYRIGHT preference in the WebPreferences topic for the given web. For example, you could add a confidential classification to a web that has restricted access.
WEBCOPYRIGHT preference setting in System.Web Preferences covers the documentation that comes with Foswiki, and should not be changed.
tools/extension_installer
.deb packages should only use the debian tools when installing extensions.
The simplest way is to visit configure:Extensions. Use the Find More Extensions button to download and install additional extensions from the foswiki.org website. If you are behind a firewall or your server has no access to the Internet, you can also install plugins manually. Installation instructions for each plugin are located in its corresponding topic on http://foswiki.org/. Additional documentation on Foswiki plugins can be found at Foswiki:Support.PluginsSupplement.
When installing an extension from the configure interface: working/configure/backup directory
!noci, disabling checkin, they will still be checked in if existing revision control files are found, suggesting that local modifications have occurred.
_installer package must be run from the root directory of the Foswiki installation.
_installer module must be downloaded from the Extension repository. The extension archive will be downloaded if required.
_installer is run, it will install the Extension and dependencies similar to the configure interface except: _installer module is saved in working/configure/pkgdata
working/logs/configure/[NameOfExtension]-yyyymmdd-hhmmss-[Action].log
configure page. In addition, some extensions also require configuration in this section.
The instructions for using the extensions installer from the shell are
retrieved by using the "usage" command: tools/extension_installer usage or
./SomePlugin_installer usage
perl working/configure/pkgdata/X509UserPlugin_installer usage
Usage as a custom installer:
X509UserPlugin_installer -a -n -d -r -u -c install
X509UserPlugin_installer -a -n uninstall
X509UserPlugin_installer manifest
X509UserPlugin_installer dependencies
Usage as a generic installer:
tools/extension_installer X509UserPlugin -a -n -d -r -u -c install
tools/extension_installer X509UserPlugin -a -n uninstall
tools/extension_installer X509UserPlugin manifest
tools/extension_installer X509UserPlugin dependencies
If command (install, uninstall ..) is not provided, default is to
install the extension.
Operates on the directory tree below where it is run from,
so should be run from the top level of your Foswiki installation.
Depending upon your installation, you may need to execute perl directly
perl tools/extension_installer ... or
perl X509UserPlugin_installer ...
"install" will check dependencies and perform any required
post-install steps.
"uninstall" will remove all files that were installed for
X509UserPlugin even if they have been locally modified.
-a means don't prompt for confirmation before resolving
dependencies
-d means auto-download if -a (no effect if not -a)
-r means reuse packages on disc if -a (no effect if not -a)
-u means the archive has already been downloaded and unpacked
-n means don't write any files into my current install, just
tell me what you would have done
-c means don't try to use CPAN to install missing libraries
"manifest" will generate a list of the files in the package on
standard output. The list is generated in the same format as
the MANIFEST files used by BuildContrib.
"dependencies" will generate a list of dependencies on standard
output.
The web and command line interfaces can be used to uninstall extensions. When an extension is remove, the following occurs:Caution: When removing an extension, no dependency checking is performed.
- Dependencies are not removed
- Other Extensions dependent on the removed extension may become non-operational.
_installer package is used to recover the manifest. If it cannot be found locally, it will be downloaded from the configured extension repository
configure/working/backup directory _uninstaller was required, the backup will be made per the current installer's manifest. It is preferable to always save the _installer modules.
,v revision control files will be removed, including the _installer. working/logs/configure/[NameOfExtension]-yyyymmdd-hhmmss-[Action].log
working/configure/pkgdata/SomeExtension_installer uninstall
unzip or tar -xzf of the backup file should be all that is required:
cd /root/of/foswiki tar -zxvf * working/configure/backup/[Extension}-backup-[yyyymmdd]-[hhmmss].tgz # or unzip working/configure/backup/[Extension}-backup-[yyyymmdd]-[hhmmss].zip
TWikiCompatibilityPlugin. This plugin enables most TWiki extensions to work with Foswiki, without modifications. It also maps requests for legacy TWiki web topics to their Foswiki equivalents, as defined in Foswiki:Development.TopicNameMappingTable. The TWIKIWEB and MAINWEB TWiki variables are also mapped to the new Foswiki macros SYSTEMWEB and USERSWEB.
If you are not upgrading an existing TWiki installation and do not plan to install plugins from the TWiki web site, it is recommended that you disable the TWikiCompatibilityPlugin in the Plugins Section on the configure page.
If a plugin exists both in a TWiki version and a Foswiki version, it is strongly recommended that you use the Foswiki version, as this is coded to work optimally with Foswiki. As part of the Foswiki project, the Foswiki community is evaluating all of the extensions that are available for TWiki, and porting them over to the Foswiki name space. Many of them are being enhanced through the removal of bugs and security vulnerabilities, resulting in better, more functional extensions for Foswiki.
| Fast CGI | FastCGIEngineContrib | Supports the mod_fastcgi and mod_fcgid extensions |
| mod_perl | ModPerlEngineContrib | supports the apache mod_perl extension |
Copyright © by the contributing authors. All material on this site is the property of the contributing authors.