This is an old revision of the document!
Table of Contents
Display File Plugin
Compatible with DokuWiki
- 2020-07-29 "Hogfather" yes
- 2018-04-22 "Greebo" yes
- 2017-02-19 "Frusterick Manners" yes
- 2016-06-26 "Elenor Of Tsort" yes
The plugin offers a single block element that expands into the content of the specified file. The element is self-closing and should not be used as an open/close pair.
| ||yes|| The language of the content file. This is used by Dokuwiki's built-in syntax highlighting GeSHi library. To disable syntax highlighting, specify a dask (-) character for the
| ||yes|| The specific part of a file path to the desired file on the local file system. This will be appended to the value of the plugin's
The plugin provides several settings that can be modified through the Configuration Manager.
| ||empty||Specifies the root directory displayed file paths will evaluate relative to. An empty value effectively disables the plugin.|
| ||'sh'|| Space-separated list of extensions that should be disallowed by the
| ||'txt php js css'|| Space-separated list of extensions that should be allowed by the
- Fix any bugs that are reported.
- Update as necessary for future Dokuwiki versions.
Some level of threat is inherent in the very purpose of this plugin, displaying the contents of files from the local file system. To avoid path traversal attacks, the admin is provided with a configuration option for specifying the root directory path where displayable files are located. Validation is done to ensure that no files outside that root path are displayed and, further more, user-facing error messages have been generalized to remove the chance of ambient data probing. In addition, both allow and deny list configuration options exist to further control what files are and aren't displayable. Any security concerns or suggestions are welcome and should be raised on the Issue Tracker.
Bugs should be reported through the Issue Tracker.
- There are currently no know bugs.
Discussion should be kept on the Plugin's Discussion Page.