Changeset 1163


Ignore:
Timestamp:
12/04/08 11:42:19 (3 years ago)
Author:
CrawfordCurrie
Message:

Item295: more detoxing

Location:
trunk/core
Files:
1 deleted
12 edited
1 moved

Legend:

Unmodified
Added
Removed
  • trunk/core/data/System/AccessControl.txt

    r940 r1163  
    135135 
    136136<verbatim> 
    137     ScriptAlias /twiki/bin/ /filesystem/path/to/twiki/bin/ 
    138     Alias /twiki/pub/       /filesystem/path/to/twiki/pub/ 
     137    ScriptAlias /foswiki/bin/ /filesystem/path/to/bin/ 
     138    Alias /foswiki/pub/       /filesystem/path/to/pub/ 
    139139 
    140140    RewriteEngine on 
    141     RewriteCond %{REQUEST_URI} !^/+twiki/+pub/+Foswiki/+.+ 
    142     RewriteRule ^/+twiki/+pub/+([^/]+)((/+([^/]+))+)/+(.+) /twiki/bin/viewfile/$1/$2?filename=$5 [L,PT] 
     141    RewriteCond %{REQUEST_URI} !^/+foswiki/+pub/+Foswiki/+.+ 
     142    RewriteRule ^/+foswiki/+pub/+([^/]+)((/+([^/]+))+)/+(.+) /foswiki/bin/viewfile/$1/$2?filename=$5 [L,PT] 
    143143</verbatim> 
    144144 
     
    199199---+++ Restrict Access to Whole Foswiki Site 
    200200 
    201 For a firewalled Foswiki, e.g. an intranet wiki or extranet wiki, you want to allow only invited people to access your Foswiki. In this case, enable [[UserAuthentication#ApacheLogin][user authentication with ApacheLogin]] and lock down access to the whole =twiki/bin= and =twiki/pub= directories to all but valid users. In the Apache =.htaccess= file or the appropriate =.conf= file, replace the =&lt;FilesMatch "(attach|edit|...= section with this: 
     201For a firewalled Foswiki, e.g. an intranet wiki or extranet wiki, you want to allow only invited people to access your Foswiki. In this case, enable [[UserAuthentication#ApacheLogin][user authentication with ApacheLogin]] and lock down access to the whole =bin= and =pub= directories to all but valid users. In the Apache =.htaccess= file or the appropriate =.conf= file, replace the =&lt;FilesMatch "(attach|edit|...= section with this: 
    202202 
    203203<verbatim> 
  • trunk/core/data/System/CommandAndCGIScripts.txt

    r1073 r1163  
    55_Programs on the server performing actions such as rendering, saving and renaming topics._ 
    66 
    7 These scripts are located in the =bin= and =tools= directories. This topic describes the interfaces to some of those scripts. All scripts in the =twiki/bin= directory can be called from the CGI ([[http://en.wikipedia.org/wiki/Common_Gateway_Interface][Common Gateway Interface]]) environment or from the command line. The scripts in the =twiki/tools= directory can only be called from the command line. 
     7These scripts are located in the =bin= and =tools= directories. This topic describes the interfaces to some of those scripts. All scripts in the =bin= directory can be called from the CGI ([[http://en.wikipedia.org/wiki/Common_Gateway_Interface][Common Gateway Interface]]) environment or from the command line. The scripts in the =tools= directory can only be called from the command line. 
    88 
    99%TOC% 
    1010 
    1111---++ CGI Scripts 
    12 Details on CGI scripts located in the =twiki/bin= directory. 
     12Details on CGI scripts located in the =bin= directory. 
    1313 
    1414---+++ General Information 
     
    1616In the CGI environment parameters are passed to the scripts via the URL and URL parameters. Environment variables are also used to determine the user performing the action. If the environment is not set up, the default user is used (usually =guest=). 
    1717---++++ Command-line 
    18 You *must* be have the =twiki/bin= directory on the perl path to run the scripts from the command line. To avoid issues with file permissions, run the scripts as the web server user such as =nobody= or =www=. 
     18You *must* be have the =bin= directory on the perl path to run the scripts from the command line. To avoid issues with file permissions, run the scripts as the web server user such as =nobody= or =www=. 
    1919 
    2020Parameters are passed on the command line using '-name' - for example, 
    2121<verbatim> 
    22 $ cd /usr/local/twiki/bin 
     22$ cd /usr/local/foswiki/bin 
    2323$ save -topic MyWeb.MyTopic -user admin -action save -text "New text of the topic" 
    2424</verbatim> 
     
    307307   2 from browser %SCRIPTURL{"statistics"}%?webs=Userweb,Sandbox updates _Userweb,Sandbox_ 
    308308   3 from browser %SCRIPTURL{"statistics"}%/%WEB% updates %WEB% 
    309    4 from command line twiki/bin/statistics updates _all user webs_ 
    310    5 from command line twiki/bin/statistics -webs=Userweb,Sandbox updates _Userweb,Sandbox_ 
    311    6 from command line twiki/bin/statistics %WEB%.<nop>WebHome updates %WEB% 
     309   4 from command line bin/statistics updates _all user webs_ 
     310   5 from command line bin/statistics -webs=Userweb,Sandbox updates _Userweb,Sandbox_ 
     311   6 from command line bin/statistics %WEB%.<nop>WebHome updates %WEB% 
    312312 
    313313see SiteTools#WebStatistics_site_statistics for updating statistics using cron. 
     
    352352 
    353353---++ Command Line Scripts 
    354 Details on command line scripts located in the =twiki/tools= directory. 
     354Details on command line scripts located in the =tools= directory. 
    355355 
    356356---+++ =geturl.pl= 
     
    363363Simple script to rewrite the =#!/usr/bin/perl= shebang lines specific to your local Perl installation. It will rewrite the first line of all your cgi scripts so they use a different shebang line. Use it if your perl is in a non-standard location, or you want to use a different interpreter (such as 'speedy'). 
    364364 
    365 ---+++ =tick_twiki.pl= 
     365---+++ =tick_foswiki.pl= 
    366366This script executes a number of non-essential regular administration tasks that will help keep your site healthy and happy, such as removing expired sessions and lease files. 
    367367 
    368368It is intended to be run as a cron job or a scheduled task once a week. Example crontab entry:%BR% 
    369 =0 0 * * 0 cd /usr/twiki/bin && perl ../tools/tick_twiki.pl= 
     369=0 0 * * 0 cd /usr/local/foswiki/bin && perl ../tools/tick_foswiki.pl= 
    370370 
    371371__Note:__ The script has to be run by a user who can write files created by the webserver user. 
  • trunk/core/data/System/DeleteOrRenameATopic.txt

    r569 r1163  
    1515__NOTE:__ The configuration of your site and your own access permissions determine whether you can access these functions. 
    1616 
    17 Note for site administrators: To remove a topic permanently move it to the Trash web, then with file-level access, delete the =.txt= and =.txt,v= files manually from =/twiki/data/Trash=. 
     17Note for site administrators: To remove a topic permanently move it to the Trash web, then with file-level access, delete the =.txt= and =.txt,v= files manually from =data/Trash=. 
    1818 
    1919__Back to:__ FrequentlyAskedQuestions 
  • trunk/core/data/System/DeleteOrRenameAnAttachment.txt

    r851 r1163  
    1313__NOTE:__ The configuration of your site and your own access permissions determine whether you can access these functions. 
    1414 
    15 Note for system administrators: To remove an attachment permanently move it to the Trash.<nop>TrashAttachment topic, then with file-level access, delete the file attachment and its =,v= repository file manually from =twiki/pub/Trash/TrashAttachment=. 
     15Note for system administrators: To remove an attachment permanently move it to the Trash.<nop>TrashAttachment topic, then with file-level access, delete the file attachment and its =,v= repository file manually from =pub/Trash/TrashAttachment=. 
    1616 
    1717__Back to:__ FrequentlyAskedQuestions 
  • trunk/core/data/System/DocumentGraphics.txt

    r851 r1163  
    240240| <img src="%ATTACHURLPATH%/web-bg-small.gif" alt="Web" title="Web" />  | =web-bg-small.gif= | Web background, 13x13 | =&lt;img src="%<nop>ICONURL{web-bg-small}%" width="13" height="13" alt="Web" border="0" /&gt;= | 
    241241 
    242 ---+++ %ICON{twiki}% Foswiki icons 
     242---+++ Foswiki icons 
    243243 
    244244%TABLE{headeralign="left" databg="#ffffff,#ffffff" databgsorted="#f5f5f5"}% 
     
    603603%META:FILEATTACHMENT{name="trash.gif" attr="" comment="" date="1169565034" path="trash.gif" size="224" user="ProjectContributor" version=""}% 
    604604%META:FILEATTACHMENT{name="ttf.gif" attr="" comment="" date="1169565034" path="ttf.gif" size="378" user="ProjectContributor" version=""}% 
    605 %META:FILEATTACHMENT{name="twiki.gif" attr="" comment="" date="1169565034" path="twiki.gif" size="585" user="ProjectContributor" version=""}% 
    606605%META:FILEATTACHMENT{name="txt.gif" attr="" comment="" date="1169565034" path="txt.gif" size="375" user="ProjectContributor" version=""}% 
    607606%META:FILEATTACHMENT{name="unchecked.gif" attr="" comment="" date="1169565034" path="unchecked.gif" size="96" user="ProjectContributor" version=""}% 
  • trunk/core/data/System/InstallationGuide.txt

    r1090 r1163  
    2121If you are upgrading from an earlier major version of Foswiki or from an old TWiki such as Cairo (TWiki 3) you will need the information found in Foswiki:System.UpgradeGuide.  There is also a static HTML =UpgradeGuide.html= included in the root of your Foswiki distribution. 
    2222 
    23 Upgrading from a recent TWiki4 release is much simpler. Follow the steps described in Foswiki:Support.UpgradingFromOlderTWikiReleases to ensure a safe upgrade without accidently overwriting customizations. 
     23Upgrading from a TWiki 4 release is much simpler. Follow the steps described in Foswiki:Support.UpgradingFromOlderTWikiReleases to ensure a safe upgrade without accidently overwriting customizations. 
    2424 
    2525One of the more difficult tasks is installation of addition !CPAN libraries. See Foswiki:Support.HowToInstallCpanModules for detailed information on how to install !CPAN libraries. 
     
    3131 
    3232   1 *Download* the Foswiki distribution from http://foswiki.org/download.html. 
    33    1 *Make a directory* for the installation and *unpack the distribution* in it. In the rest of this document we assume this directory is called =twiki=. 
     33   1 *Make a directory* for the installation and *unpack the distribution* in it. In the rest of this document we assume this directory is called =foswiki=. 
    3434      * *Note!* that Foswiki does not allow spaces in the directory names. Especially on Windows make sure to use a directory path without spaces. 
    35    1 *Setup access file and directory rights* to enable the webserver user (the user Apache runs the CGI scripts as) to read and write inside the twiki directory. 
    36       * *Warning!* Do not just just run a =chmod -R 770 twiki=. The access rules have different meaning for files and directories. This is the most common mistake installers make. 
     35   1 *Setup access file and directory rights* to enable the webserver user (the user Apache runs the CGI scripts as) to read and write inside the foswiki directory. 
     36      * *Warning!* Do not just just run a =chmod -R 770 foswiki=. The access rules have different meaning for files and directories. This is the most common mistake installers make. 
    3737      * The distribution tgz has the file and directory access rights setup to work with a reasonable security level that will work for all types of installations including shared hosting. 
    38       * The ownership of the twiki directory tree is normally set to the user that unpacked the tgz and will have to be changed to the webserver user using the command =chown -R user:group /path/to/twiki=. The webserver username varies from Distributions. Examples for some major distributions: 
    39          * !RedHat, Fedora, !CentOS, Gentoo, Mandriva : =chown -R apache:apache /path/to/twiki= 
    40          * debian/Ubuntu/Kubunto : =chown -R www-data:www-data /path/to/twiki= 
    41          * Suse : =chown -R wwwrun:www /path/to/twiki= 
     38      * The ownership of the foswiki directory tree is normally set to the user that unpacked the tgz and will have to be changed to the webserver user using the command =chown -R user:group /path/to/foswiki=. The webserver username varies from Distributions. Examples for some major distributions: 
     39         * !RedHat, Fedora, !CentOS, Gentoo, Mandriva : =chown -R apache:apache /path/to/foswiki= 
     40         * debian/Ubuntu/Kubunto : =chown -R www-data:www-data /path/to/foswiki= 
     41         * Suse : =chown -R wwwrun:www /path/to/foswiki= 
    4242      * If you mistakenly change the access rights in a way that makes Foswiki stop working, simply run the script found at Foswiki:Support.SettingFileAccessRightsLinuxUnix to set the access right of the entire Foswiki tree back to the distributed defaults. 
    4343      * It is possible to define tighter access rules than the ones given by default after the installation is complete. But how tight they should be depends on your distribution and local needs. Typically you may want to limit all access from world if the webserver machine has login access for other users than root and the web server administrator. For a dedicated web server made just for running Foswiki with limited login access the default access rights have a good safety level. 
    4444   1 *Check the Perl installation*. Ensure that Perl 5 and the Perl CGI library are installed on your system. 
    45       * The default location of Perl is =/usr/bin/perl=. *If it's somewhere else*, change the path to Perl in the first line of each script in the =twiki/bin= directory. 
    46       * 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). 
    47    1 *Create the file !LocalLib.cfg* located as =twiki/bin/LocalLib.cfg= 
    48       * 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 
    49       * 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=.<br /> 
     45      * The default location of Perl is =/usr/bin/perl=. *If it's somewhere else*, change the path to Perl in the first line of each script in the =bin= directory. 
     46      * 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 =bin=  (i.e. rename =view= to =view.pl= etc). If you do this, make sure you set the =ScriptSuffix= option in =configure= (Step 6). 
     47   1 *Create the file !LocalLib.cfg* located as =bin/LocalLib.cfg= 
     48      * There is a template for this file in =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 
     49      * The file =bin/LocalLib.cfg= must contain a setting for =$foswikiLibPath=, which must point to the absolute file path of your =lib= e.g. =/var/www/foswiki/lib=.<br /> 
    5050      * If you need to install additional [[http://cpan.perl.org/][CPAN]] modules, but can't update the main Perl installation files on the server, you can set =$CPANBASE= to point to your personal [[http://cpan.perl.org/][CPAN]] install. Don't forget that the webserver user has to be able to read those files as well. 
    5151   1 *Choose best configuration method* for your webserver. There are two ways to configure Apache: config file included from httpd.conf or .htaccess files 
    52       * Apache config file: The recommended method is using a config file. With a config file you can put the entire Foswiki 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 Foswiki 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. 
     52      * Apache config file: The recommended method is using a config file. With a config file you can put the entire Foswiki configuration in ONE file (typically named =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 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 Foswiki 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 foswiki.conf file from inside the desired virtual host config in your Apache configuration. 
    5353      * .htaccess file: This should only be used when you cannot use a config file. Performance is slowed down because Apache has to look through _all_ directories in search for possible .htaccess files each time someone views a page in Foswiki. Normally this is the only way to control Apache in a shared host environment where you have no root or sudo priviledges. 
    5454   1 *Configure the webserver* 
    5555      * Unless you are an Apache expert setting up the webserver can be quite difficult. But Foswiki has three resources that make setting up Apache easier. 
    5656         * The best and easiest way is to use webpage Foswiki:Support.ApacheConfigGenerator which contains a tool that can generate a safe and working config file for Foswiki on Apache. 
    57          * In the root of the twiki installation you find an example config file =twiki_httpd_conf.txt= 
    58          * In the root of the twiki installation and in the =twiki/bin= directory you find example =.htaccess= files you can copy and modify. The files contains help text explaining how to set them up. In =twiki/bin= you find =.htaccess.txt= which can be copied to =.htaccess= and defined access to the CGI scripts. In the root of Foswiki you find =pub-htaccess.txt= which you can copy to =pub/.htaccess=, =subdir-htaccess.txt= which you can copy to all directories as =.htaccess= except bin and pub, and you find =root-htaccess.txt= which you can copy to =.htaccess= in the twiki root directory. But again only use .htaccess files if you do not have root priviledges. 
     57         * In the root of the foswiki installation you find an example config file =foswiki_httpd_conf.txt= 
     58         * In the root of the foswiki installation and in the =bin= directory you find example =.htaccess= files you can copy and modify. The files contains help text explaining how to set them up. In =foswiki/bin= you find =.htaccess.txt= which can be copied to =.htaccess= and defined access to the CGI scripts. In the root of Foswiki you find =pub-htaccess.txt= which you can copy to =pub/.htaccess=, =subdir-htaccess.txt= which you can copy to all directories as =.htaccess= except bin and pub, and you find =root-htaccess.txt= which you can copy to =.htaccess= in the foswiki root directory. But again only use .htaccess files if you do not have root priviledges. 
    5959      * If you are unsure about how to do this on your system, see Foswiki:Support.SupplementalDucuments for links to information about various server setups. 
    6060      * *Note!* When you use config files you need to restart Apache each time you change a setting to make the new setting active. 
    6161   1 *Protect the configure script* 
    62       * You should never leave the =configure= script open to the public. Limit access to the =twiki/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 the example twiki-httpd-conf.txt and bin/.htaccess.txt files includes the needed setting to protect the configure script. 
    63       * If you limit the access to a particular user then you need to setup a .htpasswd file that contains the user name and password that Apache will authenticate against. Per default both Foswiki:Support.ApacheConfigGenerator and the example config files and .htaccess files uses =twiki/data/.htpasswd= but this file does not exist until you have Foswiki running and have registered the first user. You therefore have two options. Either limit the access to localhost or an IP address, or make a .htpasswd file. To make a .htpasswd file change directory to =twiki/data= and issue the command =htpasswd -c .htpasswd username= and enter your password when asked. The username must match the =Require user username= directive in the Apache config file or .htaccess file. Do not use a username you will later use to register in Foswiki because Foswiki will then claim that you are already registered. 
    64    1 *Run the =configure= script* from your browser (enter =http://yourdomain/twiki/bin/configure= into your browser address bar) 
     62      * You should never leave the =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 the example foswiki-httpd-conf.txt and bin/.htaccess.txt files includes the needed setting to protect the configure script. 
     63      * If you limit the access to a particular user then you need to setup a .htpasswd file that contains the user name and password that Apache will authenticate against. Per default both Foswiki:Support.ApacheConfigGenerator and the example config files and .htaccess files uses =data/.htpasswd= but this file does not exist until you have Foswiki running and have registered the first user. You therefore have two options. Either limit the access to localhost or an IP address, or make a .htpasswd file. To make a .htpasswd file change directory to =foswiki/data= and issue the command =htpasswd -c .htpasswd username= and enter your password when asked. The username must match the =Require user username= directive in the Apache config file or .htaccess file. Do not use a username you will later use to register in Foswiki because Foswiki will then claim that you are already registered. 
     64   1 *Run the =configure= script* from your browser (enter =http://yourdomain/foswiki/bin/configure= into your browser address bar) 
    6565      * Resolve any errors or warnings it tells you about. 
    6666      * *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. 
     
    6868      * When you return to configure you now need to setup _Mail and Proxies_. Especially the ={WebMasterEmail}=, and ={SMTP}{MAILHOST}= must be defined to enable Foswiki 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}=. 
    6969 
    70 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 Foswiki-ing away! 
     70You now have a basic, unauthenticated installation running. At this point you can just point your Web browser at =http://yourdomain.com/foswiki/bin/view= and start Foswiki-ing away! 
    7171 
    7272---++ Important Server Security Settings 
     
    7575   * As already described above you should protect the configure script from general access. The configure script is designed for use by administrators only and should be restricted to invocation by them only, by using the basic Apache authentication. Because of this there has not been put much effort into hardening the script. The configure script cannot save any settings once the password has been saved the first time, but the script could still be vulnerable to specially crafted field values and the script reveals many details about the webserver that you should not display in public. 
    7676   * You absolutely must turn off any kind of PHP, Perl, Python, Server Side Includes etc in the =pub= directory. Foswiki has some built-in protection which renames files with dangerous filenames by appending .txt to the filename. But this is a secondary security measure. The essential action that you must take is to turn off any possible execution of any of the attached files.<br /> Most Linux distributions have a default Apache installation which has PHP and server side include (SSI) enabled. 
    77    * Make sure that you deny access to all other twiki directories than the =bin= and =pub= directories. When you have access to the Apache config files the =twiki_httpd_conf.txt= file mentioned above also contains protection of these directories.<br /> 
     77   * Make sure that you deny access to all other foswiki directories than the =bin= and =pub= directories. When you have access to the Apache config files the =foswiki_httpd_conf.txt= file mentioned above also contains protection of these directories.<br /> 
    7878     For those that do not have access to the Apache config files a sample =subdir-htaccess.txt= file can be copied as =.htaccess= to the data, lib, locale, templates, tools and working directories. 
    7979 
    80 The Foswiki:Support.ApacheConfigGenerator as well as the example =twiki_httpd_conf.txt= and example =htaccess.txt= files include the needed settings that protect against all 3 security elements. 
     80The Foswiki:Support.ApacheConfigGenerator as well as the example =foswiki_httpd_conf.txt= and example =htaccess.txt= files include the needed settings that protect against all 3 security elements. 
    8181 
    8282---++ Next Steps 
     
    110110</verbatim> 
    111111 
    112 The Foswiki:Support.ApacheConfigGenerator includes this section when you choose _ApacheLogin_. In the example =twiki_httpd_conf.txt= and =bin/.htaccess.txt= files this section is commented out with #. Uncomment the section when you use _ApacheLogin_. It is important that this section is commented out or removed when you use _TemplateLogin_. 
     112The Foswiki:Support.ApacheConfigGenerator includes this section when you choose _ApacheLogin_. In the example =foswiki_httpd_conf.txt= and =bin/.htaccess.txt= files this section is commented out with #. Uncomment the section when you use _ApacheLogin_. It is important that this section is commented out or removed when you use _TemplateLogin_. 
    113113 
    114114#DefineAdminUser    
     
    140140---++ Automate removal of expired sessions and lease files 
    141141 
    142 Per default Foswiki cleans out expired session and lease files each time any topic is viewed. This however cost performance. It is an advantage to define a negative value in =configure= for {Sessions}{ExpireAfter} and install let cron run the =tools/tick_twiki.pl= script. Read The topic =CommandAndCGIScripts#tick_twiki_pl= for details how to do this. 
     142Per default Foswiki cleans out expired session and lease files each time any topic is viewed. This however cost performance. It is an advantage to define a negative value in =configure= for {Sessions}{ExpireAfter} and install let cron run the =tools/tick_foswiki.pl= script. Read The topic =CommandAndCGIScripts#tick_foswiki_pl= for details how to do this. 
    143143 
    144144---++ Enable Localisation 
     
    307307      * Using the table below, create a directory structure on your host server 
    308308      * Upload the Foswiki files by FTP (transfer as text except for the image files in =pub= directory.) 
    309       * __Note:__ Don't worry if you are not able to put the twiki/lib directory at the same level as the =twiki/bin= directory (e.g. because CGI bin directories can't be under your home directory and you don't have root access). You can create this directory elsewhere and configure the =twiki/bin/setlib.cfg= file (done in Step 2). 
     309      * __Note:__ Don't worry if you are not able to put the =lib= directory at the same level as the =bin= directory (e.g. because CGI bin directories can't be under your home directory and you don't have root access). You can create this directory elsewhere and configure the =bin/setlib.cfg= file (done in Step 2). 
    310310 
    311311<blockquote> 
     
    313313| *Foswiki dir:* | *What it is:* | *Where to copy:* | *Example:* | 
    314314| =foswiki= | start-up pages | root Foswiki dir | =/home/smith/foswiki/= | 
    315 | =foswiki/bin= | CGI bin | CGI-enabled dir | =/home/smith/twiki/bin= | 
    316 | =foswiki/lib= | library files | same level as =twiki/bin= | =/home/smith/foswiki/lib= | 
     315| =foswiki/bin= | CGI bin | CGI-enabled dir | =/home/smith/foswiki/bin= | 
     316| =foswiki/lib= | library files | same level as =bin= | =/home/smith/foswiki/lib= | 
    317317| =foswiki/locale= | language files | dir secure from public access | =/home/smith/foswiki/locale= | 
    318318| =foswiki/pub= | public files | htdoc enabled dir | =/home/smith/foswiki/pub= | 
  • trunk/core/data/System/ReleaseNotes01x00.txt

    r851 r1163  
    3636      * New "Restore topic" feature has been added to the _More Topic Actions_ menu. You can now much more easily restore an older version of a topic including the values a topic form. 
    3737      * Attachment comments no longer has a limit to the length of the text. 
    38       * The viewfile script now accepts similar simple URL path as used to access a topic. E.g. =http:<nop>//example.com/twiki/bin/viewfile/TWiki/DocumentGraphics/addon.gif= means the same as =http<nop>://example.com/twiki/bin/viewfile/TWiki/DocumentGraphics?filename=addon.gif=. This make it simpler to use command line tools like =wget= in Linux to download attachments. 
     38      * The viewfile script now accepts similar simple URL path as used to access a topic. E.g. =http:<nop>//example.com/twiki/bin/viewfile/System/DocumentGraphics/addon.gif= means the same as =http<nop>://example.com/foswiki/bin/viewfile/System/DocumentGraphics?filename=addon.gif=. This make it simpler to use command line tools like =wget= in Linux to download attachments. 
    3939 
    4040   * *Application Platform Enhancements* 
  • trunk/core/data/System/SkinTemplates.txt

    r906 r1163  
    5757---+++ Finding Skin Templates 
    5858 
    59 The skin templates shipped with a release are stored in the twiki/templates directory. 
    60 As an example, ==twiki/templates/view.tmpl== is the default skin template file for the ==twiki/bin/view== script.  
     59The skin templates shipped with a release are stored in the =templates= directory. 
     60As an example, ==templates/view.tmpl== is the default skin template file for the ==bin/view== script.  
    6161 
    6262You can save templates in other directories as long as they are listed in the ={TemplatePath}= configuration setting. 
  • trunk/core/data/System/Skins.txt

    r1022 r1163  
    2929You may want to define your own skin, for example to comply with corporate web guidelines, or because you have a aesthetic vision that you want to share. There are a couple of places you an start doing this. 
    3030 
    31 The [[skin templates]] used for skins are located in the =twiki/templates= directory and are named according to the skin: ==&lt;scriptname&gt;.&lt;skin&gt;.tmpl==. Skin files may also be defined in Foswiki topics - see SkinTemplates for details. 
     31The [[skin templates]] used for skins are located in the =templates= directory and are named according to the skin: ==&lt;scriptname&gt;.&lt;skin&gt;.tmpl==. Skin files may also be defined in Foswiki topics - see SkinTemplates for details. 
    3232 
    3333To start creating a new skin, copy the default skin templates (like =view.tmpl=), or copy an existing skin to use as a base for your own skin. You should only need to copy the files you intend to customise, as Foswiki can be configured to fall back to another skin if a template is not defined in your skin. Name the files as described above (for example =view.myskin.tmpl=. 
  • trunk/core/data/System/UserAuthentication.txt

    r877 r1163  
    106106   1 Use [[%SCRIPTURLPATH{"configure"}%#LoginManager][configure]] to select the =Foswiki::LoginManager::ApacheLogin= login manager. 
    107107   1 Use [[%SCRIPTURLPATH{"configure"}%#PasswordManager][configure]] to set up %WIKITOOLNAME% to create the right kind of =.htpasswd= entries. 
    108    1 Create a =.htaccess= file in the =twiki/bin= directory.<br />%H% There is an template for this file in =twiki/bin/.htaccess.txt= that you can copy and change. The comments in the file explain what need to be done.<br />%H% If you got it right, the browser should now ask for login name and password when you click on the <u>Edit</u>. If =.htaccess= does not have the desired effect, you may need to "AllowOverride All" for the directory in =httpd.conf= (if you have root access; otherwise, e-mail web server support) 
     108   1 Create a =.htaccess= file in the =bin= directory.<br />%H% There is an template for this file in =bin/.htaccess.txt= that you can copy and change. The comments in the file explain what need to be done.<br />%H% If you got it right, the browser should now ask for login name and password when you click on the <u>Edit</u>. If =.htaccess= does not have the desired effect, you may need to "AllowOverride All" for the directory in =httpd.conf= (if you have root access; otherwise, e-mail web server support) 
    109109    <br /> %X% At this time AccessControls do not control access to files in the =pub= area, unless they are only accessed through the =viewfile= script. If your =pub= directory is set up to allow open access you may want to add =.htaccess= files in there as well to restrict access  
    110110   1 You can create a custom version of the UserRegistration form by copying the default topic, and then deleting or adding input tags in your copy. The =name=""= parameter of the input tags must start with: ="Twk0..."= (if this is an optional entry), or ="Twk1..."= (if this is a required entry). This ensures that the fields are carried over into the user home page correctly. Do *not* modify the version of UserRegistration shipped with %WIKITOOLNAME%, as your changes will be overwritten next time you upgrade. 
  • trunk/core/lib/Foswiki/Contrib/core/MANIFEST

    r1110 r1163  
    876876pub/System/DocumentGraphics/trash.gif 0644 
    877877pub/System/DocumentGraphics/ttf.gif 0644 
    878 pub/System/DocumentGraphics/twiki.gif 0644 
    879878pub/System/DocumentGraphics/txt.gif 0644 
    880879pub/System/DocumentGraphics/unchecked.gif 0644 
     
    10211020tools/geturl.pl 0555 
    10221021tools/rewriteshbang.pl 0555 
    1023 tools/tick_twiki.pl 0555 
     1022tools/tick_foswiki.pl 0555 
    10241023foswiki_httpd_conf.txt 0444 
    10251024working/tmp/README 0444 
  • trunk/core/tools/pkg/readme.txt

    r877 r1163  
    55 
    66debian/ 
    7    * contains the source for the debain twiki package. this is made using a release tarball, and these files. 
     7   * contains the source for the debian foswiki package. this is made using a release tarball, and these files. 
    88   * as of 2003 it is maintained by SvenDowideit (sponsered by Ardo van Rangelrooij <ardo@debian.org>)  
  • trunk/core/tools/tick_foswiki.pl

    r1050 r1163  
    2424# from setlib.cfg. 
    2525# You can add a directory to your include path using the -I option 
    26 # to the perl command e.g. perl -I /usr/local/twiki/bin tick_twiki.pl 
     26# to the perl command e.g. perl -I /usr/local/foswiki/bin tick_foswiki.pl 
    2727# 
    2828# It executes a number of non-essential regular administration 
     
    3333# For example, 
    3434# 
    35 # 0 0 * * 0 cd /usr/twiki/bin && perl ../tools/tick_twiki.pl 
     35# 0 0 * * 0 cd /usr/foswiki/bin && perl ../tools/tick_foswiki.pl 
    3636# 
    3737BEGIN { 
     
    5353 
    5454use Foswiki; 
    55 my $twiki = new Foswiki(); 
    56 my $store = $twiki->{store}; 
     55my $foswiki = new Foswiki(); 
     56my $store = $foswiki->{store}; 
    5757my $now = time(); 
    5858foreach my $web ( $store->getListOfWebs()) { 
Note: See TracChangeset for help on using the changeset viewer.