Low client and server base requirements are core features that keep Foswiki widely deployable, particularly across a range of browser platforms and versions. Many extensions exist which enhance and expand Foswiki's capabilities; they may have additional requirements.
Foswiki is written in Perl 5, which is supported on Microsoft Windows as well as Unix and Unix-like systems (including Linux and OSX). On Unix-like systems, it uses a number of shell commands. It should be able to run out-of-the-box on any server platform that meets the following requirements.
Resource
Required Server Environment
Perl
5.8.8 or higher. A minimum of perl 5.12 is recommended.
External programs
GNU diff 2.7 or higher, fgrep, and egrep (not required on Windows)
Foswiki is designed to automatically detect the platform and generate a basic configuration the first time the configure script is run, but start from your expected default "view" URL, so that Foswiki can figure out your URL scheme.
Prior versions of Foswiki shipped with the important CPAN modules. Foswiki 2.0 does not, and you must ensure that the perl dependencies listed below are installed before attempting to use Foswiki. For a detailed report, PerlDependencyReport (admin access only!) or the shell script tools/dependencies.
If you are unable to install CPAN modules, see Foswiki:Extensions.CpanContrib. Install this extension into your Foswiki installation directory if you cannot install Perl modules otherwise.
You can check the dependencies before Foswiki is fully operational with the following command. It will list all potentially missing dependencies. Not all listed dependences are required on all installations, Refer to the usage message that accompanies each missing dependency in the report.
cd /path/to/foswiki
perl tools/dependencies
Specific distribution details
Find the closest match to your installed system. and click on the "Show ..." link to reveal the details.
Must be version 0.77 or newer, included with perl 5.10.1 and newer.
To install the above packages on CentOS
Note, Locale::Maketext::Lexicon and Locale::Msgfmt are not available on
Centos. Install using CPAN if Internationalization is required.
First add the appropriate perl module repository, and then install the packages.
First add the appropriate SuSE perl-modules repository, and then install the packages. Note: Not all listed packages will install on SuSE, but all dependences are resolved.
zypper ar -f -n perl-modules http://download.opensuse.org/repositories/devel:/languages:/perl/openSUSE_13.1 perl-modules zypper installperl-Algorithm-Diffperl-Archive-Tarperl-Authen-SASLperl-CGIperl-CGI-Sessionperl-Crypt-PasswdMD5perl-Digest-SHAperl-Email-Address-XSperl-Email-MIMEperl-Encodeperl-Errorperl-File-Copy-Recursiveperl-HTML-Parserperl-HTML-Treeperl-IO-Socket-IPperl-IO-Socket-SSLperl-JSONperl-Locale-Codesperl-Locale-Maketextperl-Locale-Maketext-Lexiconperl-Locale-Msgfmtperl-libwww-perlperl-LWP-Protocol-httpsperl-URIperl-version
Optional dependencies
Install as needed.
Perl Module
Package to install
Notes
mod_perl2
mod_perl
Required if using Apache2 and mod_perl
Apache2::Request
perl-libapreq2
Required if using Apache 2 and mod_perl
DBI
perl-DBI
Used for the Foswiki Page cache
DBD::mysql
perl-DBD-mysql
Used for MySQL based Page Cache
DBD::Pg
perl-DBD-Pg
Used for PostgreSQL based Page Cache
DBD::SQLite
perl-DBD-SQLite
Used for SQLite based Page Cache
FCGI
perl-FCGI
Optional, needed for fastcgi / fcgi apache modules
FCGI::ProcManager
perl-FCGI-ProcManager
Optional, needed for fastcgi / fcgi process management on nginx
Crypt::SMIME
perl-Crypt-SMIME
Optional, used for S/MIME email signing (Not available in default repositories)
Crypt::X509
perl-Crypt-X509
Optional, used for S/MIME email signing
Convert::PEM
perl-Convert-PEM
Optional, used for S/MIME email signing
After expanding the Foswiki archive, change the ownership of the files:
Perl dependencies can also be installed on most systems using cpanm, aka App::cpanminus. On most unix* systems, cpanminus can bootstrap itself using curl or wget.
If run as root, the modules will be installed in the System perl. Otherwise they are installed into the users local environment.
Perl Module
Notes
Algorithm::Diff
Archive::Tar
*First shipped in perl 5.9.3
Authen::SASL
Optional, needed for authenticated SMTP
CGI
CGI::Session
Crypt::PasswdMD5
Digest::SHA
Included with perl
Error
Email::Address::XS
Email::MIME
Encode
File::Copy::Recursive
HTML::Parser
HTML::Tree
IO::Socket::IP
IO::Socket::SSL
Optional, support encrypted email connection: STARTTLS or SSL
JSON
Locale::Maketext
Locale::Maketext::Lexicon
Optional, needed for internationalization
Locale::Msgfmt
Optional, needed for internationalization
LWP
LWP::Protocol::https
URI
version
Must be version 0.77 or newer, included with perl 5.10.1 and newer.
To install the above packages with cpanm
Note: We do not recommend installing CPAN modules with cpanminus as root.
See below for information on using a private module library with cpanminus.
curl -L http://cpanmin.us | perl - App::cpanminus (optional - install cpanminus if not available )
cpanm Algorithm::Diff Archive::Tar Authen::SASL CGI CGI::Session Crypt::PasswdMD5 Digest::SHA Error Email::Address::XS Email::MIME Encode File::Copy::Recursive HTML::Parser HTML::Tree IO::Socket::IP IO::Socket::SSL JSON Locale::Maketext Locale::Maketext::Lexicon Locale::Msgfmt LWP LWP::Protocol::https URI version
Optional dependencies
Install as needed.
Perl Module
Package to install
Notes
Apache2::Request
Required if using Apache 2 and mod_perl
DBI
Optional - Used for the Foswiki Page cache
DBD::mysql
Optional - Used for MySQL based Page Cache
DBD::Pg
Optional - Used for PostgreSQL based Page Cache
DBD::SQLite
Optional - Used for SQLite based Page Cache
FCGI
Optional, needed for fastcgi / fcgi apache modules
FCGI::ProcManager
Optional, needed for fastcgi / fcgi process management on nginx
Crypt::SMIME
Optional, used for S/MIME email signing
Crypt::X509
Optional, used for S/MIME email signing
Convert::PEM
Optional, used for S/MIME email signing
Locale::Language
Optional, Locale::Language will be removed from the Perl core distribution in 5.28.
Installation using cpanminus
See Foswiki:Support.HowToInstallCpanModules for more information.
If you want to install the dependendencies into a specified location, add the "-l" option to cpanm, and add the lib path to bin/LocalLib.cfg. The dependencies will be installed under the specified location, in the lib/perl5 subdirectory.
Example: User "foswiki" logs in and installs the libraries locally under the foswikideps directory:
cpanm -l foswikideps Algorithm::Diff Archive::Tar ... (install libraries into =/home/foswiki/foswikideps=)
/path/to/foswiki/bin/LocalLib.txt is then edited, and the commented line is modified:
Javascript, is required for configure, edit save and upload functionality. Foswiki is viewable without javascript.
CSS and Javascript are used in most skins. Some skins will require more recent releases of browsers. The default (Pattern) skin is tested on IE 6+, Safari, Chrome and Firefox.
You can easily select a balance of browser capability versus look and feel. Try the installed skins at SkinBrowser and more at Foswiki:Extensions.SkinPackage.
Related Topics:AdminDocumentationCategory
Copyright © by the contributing authors. All material on this site is the property of the contributing authors.