DEPRECATION WARNING
This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.
Extension Manager¶
All configuration is made in the Extension Manager.
Properties¶
| Property | Prefix/Tab | Type |
|---|---|---|
| cachetimeadd | basic | integer |
| linkFormat | basic | string |
| enableGroupCheck | basic | boolean |
| groupCheckDirs | basic | string |
| excludeGroups | basic | string |
| securedDirs | basic | string |
| securedFiletypes | basic | string |
| domain | basic | string |
| apacheDelivery | filedelivery | boolean |
| forcedownload | filedelivery | boolean |
| forcedownloadtype | filedelivery | string |
| additionalMimeTypes | filedelivery | string |
| outputFunction | filedelivery | string |
| outputChunkSize | filedelivery | integer |
| log | module | boolean |
| debug | debug | integer |
Property details¶
cachetimeadd¶
Property
basic.cachetimeadd
Data type
integer
Description
The secure link is only valid for a limited time, which is calculated from the cache time that is used for the page that carries the link plus this value (in seconds). Default is 3600 sec (= 1 h).
Default
3600
linkFormat¶
Property
basic.linkFormat
Data type
string
Description
The Format for the link generated by secure_downloads. You can change this if you apply appropriate mod_rewrite rules in your .htaccess file.
Example:
linkFormat: securedl/###FEUSER###/###TIMEOUT###/###HASH###/###FILE###
Put the following in your .htaccess (one line)
RewriteRule ^securedl/([\d]+)/([\d]+)/([0123456789abcdef]+)/([^&]+)$ index.php?eID=tx_securedownloads&u=$1&t=$2&hash=$3&file=$4 [nc,L]
Default
index.php?eID=tx_securedownloads&u=###FEUSER###&g=###FEGROUPS###&t=###TIMEOUT###&hash=###HASH###&file=###FILE###
enableGroupCheck¶
Property
basic.enableGroupCheck
Data type
boolean
Description
Allows forwarding a secure download link to others, who can access that file if they have at least one front-end user group in common. Enabling this makes the checks less restrictive!
Default
false
groupCheckDirs¶
Property
basic.groupCheckDirs
Data type
string
Description
A list of directories for the less restrictive group check, separated by a pipe (|). Leave empty if you want to enable the group check for all directories.
Default
empty
excludeGroups¶
Property
basic.excludeGroups
Data type
string
Description
A comma separated list of groups that are excluded from the group check feature (if enabled).
Default
empty
securedDirs¶
Property
basic.securedDirs
Data type
string
Description
List of directories of your TYPO3 Server in that files should be secured, separated by pipe (|)
For exclude a sub-directory in a directory use (?!path/to/sub)path
Default
typo3temp|fileadmin|uploads
securedFiletypes¶
Property
basic.securedFiletypes
Data type
string
Description
List of file types that should be protected. Multiple file extension patterns can be separated by a pipe (|).
Default
pdf|jpe?g|gif|png|odt|pptx?|docx?|xlsx?|zip|rar|tgz|tar|gz
domain¶
Property
basic.domain
Data type
string
Description
This is only required for absolute filelinks to your local server, e.g. http://my.server.com/fileadmin/image.jpg. Not needed for internal (relative) links.
Default
http://mydomain.com/|http://my.other.domain.org/
apacheDelivery¶
Property
filedelivery.apacheDelivery
Data type
boolean
Description
Feature to deliver files through Apache Webserver not PHP (beta)
Default
false
forcedownload¶
Property
filedelivery.forcedownload
Data type
boolean
Description
If this is checked some filetypes are forced to be downloaded in contrast of beeing embedded in the browser window
Default
false
forcedownloadtype¶
Property
filedelivery.forcedownloadtype
Data type
string
Description
List of filetypes that should be forced to be downloaded (see above)
Default
odt|pptx?|docx?|xlsx?|zip|rar|tgz|tar|gz
additionalMimeTypes¶
Property
filedelivery.additionalMimeTypes
Data type
string
Description
Comma separated list of additional MIME types (file extension / mime type pairs, in which file extension and MIME type is separated by a pipe symbol). Can be used to override existing MIME type settings of the extension as well.
Default
txt|text/plain,html|text/html
outputFunction¶
Property
filedelivery.outputFunction
Data type
string
Description
Due to possible restrictions in php and php settings, you probably need to adjust this value. By default “readfile” is used to deliver the file. If this function is disabled in your php settings, you can try fpasstrugh. If you hav problems with php memory_limit and big files to download, you need to set this to readfile_chunked, which delivers the files in small portions. If you activate the logging, only the transmitted portions are stored in the database table. Again, make sure you have no performance problem here, because multiple SQL-queries are fired to track the transmitted bytes.
Default
readfile
outputChunkSize¶
Property
filedelivery.outputChunkSize
Data type
integer
Description
Only applicable if you use readfile_chunked (see outputFunction). Specify the number of bytes, served as one chunk when delivering the file. Choosing this value too low is a performance killer.
Default
1048576
log¶
Property
module.log
Data type
boolean
Description
Each file access will be logged to database, this could be a performance issue, if you have a high traffic site. If you decide to turn it on, a backend module will be activated to see the traffic caused by user/ file
Default
false
debug¶
Property
debug.debug
Data type
string
Description
For developing only
Default
0
You also need to secure all the directories and filetypes by your server configuration. This can be done with .htaccess files. Some example .htaccess files you find in the /res folder.
Important
This extension cannot secure links to files that you include in your CSS file. For example you can secure /fileadmin with the default .htaccess_deny file by putting the file in /fileadmin. You can allow /fileadmin/templates/ with the default .htaccess_allow file by putting this file to /fileadmin/template/