|
TWiki Installation Guide |
|
-
- Some systems require a special extension on perl scripts (e.g.
.cgi or .pl ). This is normally only needed under Windows and only where perl scripts are only recognized by file extension. Linux and Unix users should normally never need to do this. If necessary, rename all files in twiki/bin (i.e. rename view to view.pl etc). If you do this, make sure you set the ScriptSuffix option in configure (Step 6).
- Create the file LocalLib.cfg located as
twiki/bin/LocalLib.cfg
- There is a template for this file in
twiki/bin/LocalLib.cfg.txt . Simply copy LocalLib .cfg.txt to LocalLib .cfg. Make sure the ownership and access rights of the copy are the same as LocalLib .cfg.txt
|
|
< < |
-
- The file
twiki/bin/LocalLib.cfg must contain a setting for $twikiLibPath , which must point to the absolute file path of your twiki/lib e.g. /var/www/twiki/lib .
|
> > |
-
- The file
twiki/bin/LocalLib.cfg must contain a setting for $twikiLibPath , which must point to the absolute file path of your twiki/lib e.g. /var/www/twiki/lib .
|
|
-
- If you need to install additional CPAN modules, but can't update the main Perl installation files on the server, you can set
$CPANBASE to point to your personal CPAN install. Don't forget that the webserver user has to be able to read those files as well.
- Choose best configuration method for your webserver. There are two ways to configure Apache: config file included from httpd.conf or .htaccess files
- Apache config file: The recommended method is using a config file. With a config file you can put the entire TWiki configuration in ONE file (typically named
twiki.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 using a config file requires that you can restart Apache which again means that you need root or sudo access to stop and start Apache. The TWiki apache config file is included from the main Apache config file http.conf. 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). If you use a virtual host setup in Apache you should include the twiki.conf file from inside the desired virtual host config in your Apache configuration.
|
|
-
- Resolve any errors or warnings it tells you about.
- Note! When you run
configure for the first time, you can only edit the section General Path Settings . Save these settings, and then return to configure to continue configuration.
- If your webserver can be accessed by more than one domain name make sure to add the additional alternative URLs to
{PermittedRedirectHostUrls}
|
|
< < |
-
- When you return to configure you now need to setup Mail and Proxies. Especially the
{WebMasterEmail} , and {SMTP}{MAILHOST} must be defined to enable TWiki to send registration emails. Many ISPs have introduced authentication when sending emails to fight spam so you may also have to set {SMTP}{Username} and {SMTP}{Password} . If you do not want to enable mailing or want to enable it later you can uncheck {EnableEmail} .
|
> > |
-
- When you return to configure you now need to setup Mail and Proxies. Especially the
{WebMasterEmail} , and {SMTP}{MAILHOST} must be defined to enable TWiki to send administrative emails, such as for registration and notification of topic changes. Many ISPs have introduced authentication when sending emails to fight spam so you may also have to set {SMTP}{Username} and {SMTP}{Password} . If you do not want to enable mailing or want to enable it later you can uncheck {EnableEmail} .
- If you want administrative e-mails to be signed, see S/MIME setup instructions below.
|
|
You now have a basic, unauthenticated installation running. At this point you can just point your Web browser at http://yourdomain.com/twiki/bin/view and start TWiki-ing away! |
|
- Confirm the Mail and Proxies settings in the Configure interface.
- Setup a cron job (or equivalent) to call the
tools/mailnotify script as described in the TWiki.MailerContrib topic.
|
|
> > |
Enable Signed Email Notification
TWiki administrative e-mails are an attractive target for SPAM generators and phishing attacks. One good way to protect against this possibility to enable S/MIME signatures on all administrative e-mails. To do this, you need an an X.509 certificate and private key for the the {WebMasterEmail} email account. Obtain these as you would for any other S/MIME e-mail user.
To enable TWiki to sign administrative e-mails:
- Enable e-mail as described above
- If necessary, convert your certificate and key files to PEM format ( openssl has all the necessary utilities)
- Place the certificate anyplace convenient that the webserver can read. It should be protected against write. The conventional place under linux is
/etc/pki/tls/certs
- Place the key file in a secure location that only the webserver can read. It must not be readable by anyone else, and must not be served by the webserver.
- Using the
configure script, change the following settings under Mail and Proxies:
- Follow the directions under
{MailProgram} to enable an external mail program such as sendmail. Net::SMTP is not supported.
- Enter the full path to the certificate file in the
{SmimeCertificateFile} configuration variable
- Enter the full path to the private key file in the
{SmimeKeyFile} configuration variable
- Save the configuration
- Re-run the
configure script an resolve any errors that it identifies
All out-going administrative e-mails will now be signed. |
| Enable WebStatistics
You can generate a listing manually, or on an automated schedule, of visits to individual pages, on a per web basis. For information on setting up this feature, see the TWiki.TWikiSiteTools topic. |
|
Copyright, License and Classification Statements |
|
< < | In the bottom of each topic you will find a default copyright messages saying "Copyright &© by the contributing authors. All material on this collaboration platform is the property of the contributing authors." It is a setting WEBCOPYRIGHT that defines this. This is often not adequate. |
> > | In the bottom of each topic you will find a default copyright messages saying "Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors." It is a setting WEBCOPYRIGHT that defines this. This is often not adequate. |
|
- If your TWiki is used in a commercial application without public access you should replace this by your normal copyright notice. You should also consider adding classifications (e.g. For Internal Use Only) so people do not have to add this manually to every new topic.
- If your TWiki is public with public access you need to decide which copyright and license the contributions should be covered by. For open source type applications licenses such as the GNU Free Documentation License, FreeBSD Documentation License, and Creative Commons license are possible licenses to consider. Remember that once people have started contributing it is difficult and not correct to change or impose licenses on existing contributions.
|
|
Archive::Tar |
|
May be required by the Extensions Installer in configure if command line tar or unzip is not available |
CGI::Cookie |
>=1.24 |
Used for session support |
CGI::Session |
>=3.95 |
Highly recommended! Used for session support |
|
|
> > |
Crypt::SMIME |
>=0.09 |
Required if S/MIME-signed administrative e-mail is enabled. |
|
|
Digest::base |
|
|
Digest::SHA1 |
|
|
Jcode |
|
Used for I18N support with perl 5.6 |
|