Extension Configuration¶
All configuration is made in the “Extension Configuration” section of the “Settings” module beneath the “Admin Tools”.
Properties¶
| Property | Tab | Type |
|---|---|---|
| securedDirs | Parsing | string |
| securedFiletypes | Parsing | string |
| domain (legacy) | Parsing | string |
| linkPrefix | Link Generation | string |
| tokenPrefix | Link Generation | string |
| cachetimeadd | Link Generation | positive integer |
| documentRootPath | Link Generation | string |
| enableGroupCheck | Group Check | boolean |
| groupCheckDirs | Group Check | string |
| excludeGroups | Group Check | string |
| strictGroupCheck | Group Check | boolean |
| outputFunction | File Delivery | options |
| outputChunkSize (legacy) | File Delivery | positive integer |
| protectedPath | File Delivery | string |
| forcedownload | File Delivery | boolean |
| forcedownloadtype | File Delivery | string |
| additionalMimeTypes (legacy) | File Delivery | string |
| log | Module | boolean |
| debug (legacy) | Debug | options |
securedDirs¶
Property
securedDirs
Data type
string
Default
typo3temp|fileadmin
Description
List of directories of your TYPO3 Server in that files should be secured, separated by pipe (|). Files in subdirectories will also be secured. You can use Regular Expressions for this option.
securedFiletypes¶
Property
securedFiletypes
Data type
string
Default
pdf|jpe?g|gif|png|odt|pptx?|docx?|xlsx?|zip|rar|tgz|tar|gz
Description
List of file types (file extensions) that should be protected. Multiple file extension patterns can be separated by a pipe (|). You can use an asterisk (*) if you want to protect all files within configured directories. You can use Regular Expressions for this option.
domain¶
Property
domain
Data type
string
Default
http://mydomain.com/|http://my.other.domain.org/
Description
This is only required for absolute file links to your local server, e.g. https://example.com//fileadmin/image.jpg.
Not needed for internal (relative) links. Please note, that this configuration property is deprecated. Parsing the HTML
output will no longer work with version 5. You should consider to use the TYPO3 API instead.
You can use Regular Expressions for this option.
linkPrefix¶
Property
linkPrefix
Data type
string
Default
securedl
Description
Prefix for generated links (the "securedl" part in “https://example.com/securedl/sdl-[JWT]/image.png”).
![https://example.com/securedl/sdl-[JWT]/image.png](https://example.com/securedl/sdl-[JWT]/image.png){kind=link}
tokenPrefix¶
Property
linkPrefix
Data type
string
Default
sdl-
Description
Prefix for generated token (the "sdl-" part in “https://example.com/securedl/sdl-[JWT]/image.png”).
cachetimeadd¶
Property
cachetimeadd
Data type
positive integer
Default
3600
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).
documentRootPath¶
Property
documentRootPath
Data type
string
Default
/
Description
Do only change this configuration option, if your TYPO3 instance is running in a subfolder or you are using a SSL reverse proxy to map TYPO3 into a virtual subfolder. This configuration must start and end with a slash (e.g. “/proxy-typo3/”).
enableGroupCheck¶
Property
enableGroupCheck
Data type
boolean
Default
false
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!
groupCheckDirs¶
Property
groupCheckDirs
Data type
string
Default
unset
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.
excludeGroups¶
Property
excludeGroups
Data type
string
Default
-1,0
Description
A comma separated list of groups that are excluded from the group check feature (if enabled).
strictGroupCheck¶
Property
strictGroupCheck
Data type
boolean
Default
false
Description
If enabled, files are only delivered if the user groups exactly match those of the secured link.
outputFunction¶
Property
outputFunction
Data type
options
Default
stream
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 “fpassthru”. If you have
problems with php memory_limit and big files to download, you need to set this to “stream”, which delivers
the files in small portions. The option “readfile_chunked” is deprecated, but does the same as “stream” for now.
For nginx web servers, there is also the possibility to deliver the file directly from the server by setting this
property to “x-accel-redirect”.
protectedPath¶
Property
protectedPath
Data type
string
Default
unset
Description
Only applicable if you use x-accel-redirect (see: outputFunction). Specify the protected path used in your nginx
location directive. A matching nginx location directive needs to be added.
Example
location /internal {
internal;
alias /path/to/your/protected/storage;
}
outputChunkSize¶
Property
outputChunkSize
Data type
positive integer
Default
1048576
Description
Only applicable if you use “readfile_chunked” or “stream” as output function (see: outputFunction). Specify the number of bytes, served as one chunk when delivering the file. Choosing this value too low is a performance killer. Please note, that this property is deprecated and will be removed in version 5.
forcedownload¶
Property
forcedownload
Data type
boolean
Default
false
Description
If this is checked some file types are forced to be downloaded (see: forcedownloadtype) in contrast of being embedded in the browser window.
forcedownloadtype¶
Property
forcedownloadtype
Data type
string
Default
odt|pptx?|docx?|xlsx?|zip|rar|tgz|tar|gz
Description
A list of file types that should not be opened inline in a browser, separated by a pipe. Only used if “forcedownload” (see: forcedownload) is enabled. You can use an asterisk (*) if you want to force download for all file types. You can use Regular Expressions for this option.
additionalMimeTypes¶
Property
additionalMimeTypes
Data type
string
Default
txt|text/plain,html|text/html
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. Please note, that this property is deprecated and will be removed in version 5. You should use the TYPO3 API for adding additional MIME types.
log¶
Property
log
Data type
boolean
Default
false
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
debug¶
Property
debug
Data type
options
Default
0
Description
For developing only. This configuration is deprecated. Please consider to use PSR-3 Logger.