Main.SitePreferences
. On that page you'll find some of the most common local site preferences such as the name for your site, the header logo image and, site tag line. However, there are many more site preference settings which you'll find in System.DefaultPreferences
. If a given preference is not set in Main.SitePreferences
, then it defaults to the value is defined in System.DefaultPreferences
(or in the case of extensions, in the respective extension topics).
Because DefaultPreferences
is included in Foswiki upgrade packages, you will simplify upgrades by not changing these DefaultPreferences
. Instead, copy any settings you want to change and add them to Main.SitePreferences
.
0 0 * * * cd /usr/local/foswiki && perl -I bin tools/mailnotify -q 0 0 * * * cd /usr/local/foswiki/bin; ./statistics -subwebs 1 >/dev/null 2>&1 0 0 * * 0 cd /usr/local/foswiki/bin && perl ../tools/tick_foswiki.plRead further below about how to customize these schedules and script options to your particular needs. You can find some general information about cron jobs at MailerContrib - Setting up a cron job.
configure
page.
tools/mailnotify
script, as described in the System.MailerContrib topic.
tools/tick_foswiki.pl
script, and set a negative value on the configure
page for {Sessions}{ExpireAfter}
. For more details, read CommandAndCGIScripts#A_61tick_foswiki.pl_61.
{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.SitePreferences
it should be removed.
{SmimeCertificateFile}
configuration variable
{SmimeKeyFile}
configuration variable
configure
script an resolve any errors that it identifies
Localisation
section of the configure
page. For more information, see Store
pane in configure
you will find the setting {Store}{SearchAlgorithm}
.
By default bootstrap attempts to pick the best implementation for your system. You can optimize search by choosing algorithms as follows: Foswiki::Store::SearchAlgorithms::PurePerl
mod_perl
, can set this to Foswiki::Store::SearchAlgorithms::Forking
.
grep
and egrep
in the configuration.
Foswiki::Store::SearchAlgorithms::PurePerl
.
There are several other options available for search tools via the Extensions web, including: Fast CGI | FastCGIEngineContrib | Supports the mod_fastcgi and mod_fcgid extensions |
mod_perl | ModPerlEngineContrib | supports the apache mod_perl extension |
ALLOWTOPICCHANGE
preference setting to Main.NewUserTemplate 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.DefaultPreferences 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.WebPreferences covers the documentation that comes with Foswiki, and should not be changed.
natedit
from the default setting natedit, pattern
in their user topic: * Set SKIN = pattern
tools/extension_installer
Plugins
wizard to import and save the new configuration settings. Import extension settings
button.
tools/configure -wizard Plugins -save
-args ENABLE=1
on the command.
.deb
or .rpm
packages should only use the system package tools when installing extensions.
The simplest way is to visit configure -> Extensions -> Extensions operations and maintenance tab, and use the [ search for 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 https://foswiki.org/. Additional documentation on Foswiki plugins can be found at 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.
extension_installer
package must be run from the root directory of the Foswiki installation. perl tools/extension_installer [SomeExtension] install
_installer
is run, it will install the Extension and dependencies similar to the configure
interface except: -noenable
option to save the configuration with the plugin(s) disabled.
[SomeExtension]_installer
, and [SomeExtension].tgz
files into the Foswiki root. working/configure/download
directory.
[SomeExtension]_installer
package must be run from the root directory of the Foswiki installation. perl [SomeExtension]_installer install -o
-o
option to prevent the installer from downloading any dependencies.
[SomeExtension]_installer
is run, it will install the Extension similar to the configure
interface except that you will be given the option to use local archives.
-noenable
option to save the configuration with the plugin(s) disabled.
"*.spec"
file.:tools/configure -wizard Plugins -save
-args ENABLE=1
to the command.
[SomeExtension]_installer
module is saved in working/configure/pkgdata
.
working/configure/download
.
working/logs/configure/[NameOfExtension]-yyyymmdd-hhmmss-[Action].log
.
working/configure/backup/[NameOfExtension]-backup-yyyymmdd-hhmmss.tgz
.
tools/extension_installer usage
or
./SomePlugin_installer usage
_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
{Module}
and {Enable}
settings will be removed from the configuration, and the configuration will be saved. perl 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].zipAlways run the
tools/configure -wizard Plugins -save
utility after manually changing any extension. This ensures that Foswiki is running with the
latest Config.spec
/ Foswiki.spec
configuration information.