plugin:filelist
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
plugin:filelist [2019-07-03 15:37] – [Usage] andi | plugin:filelist [2024-05-09 13:02] (current) – no for Igor 2003:ea:ef05:526:2c8d:691d:8e6e:1f88 | ||
---|---|---|---|
Line 6: | Line 6: | ||
email : freaks@dokuwiki.org | email : freaks@dokuwiki.org | ||
type : syntax | type : syntax | ||
- | lastupdate : 2016-09-10 | + | lastupdate : 2024-04-03 |
- | compatible : Binky, Ponder Stibbons, " | + | compatible : !Igor, Jack Jackrum, Kaos |
depends | depends | ||
conflicts | conflicts | ||
similar | similar | ||
- | tags : file, listing, download, media, filter, odt | + | tags : file, listing, download, filter, odt |
+ | |||
+ | updatemessage: | ||
downloadurl: | downloadurl: | ||
Line 20: | Line 22: | ||
---- | ---- | ||
- | ====== Description ====== | + | The filelist plugin provides a syntax for creating linked listings of arbitrary file system locations. It is meant to add easy access to file server shares and similar document stores. |
- | The filelist plugin provides a syntax for adding linked and sorted lists of files as selected by wildcard based glob patterns to a wiki page and thus allows dynamically including file listings of arbitrary filesystem locations and media namespaces. Using the additional'' | + | ===== Installation ===== |
- | ====== Configuration ====== | + | Search and install the plugin using the [[plugin: |
- | The filelist plugin has three configurable options: | ||
- | ^Option ^Description | | + | ==== Upgrade from older Versions ==== |
- | |'' | + | |
- | |'' | + | |
- | |'' | + | |
- | ===== Usage ===== | + | Release 2024-02-27 is a complete refactoring of the old plugin. The following features have been removed: |
- | The filelist plugin provides two new commands to be used in wiki pages, '' | + | * all handling of media files including |
- | < | + | * This is better served by other plugins like the [[filelisting]] or [[gallery]] plugins |
- | {{[ command ]>[ pattern | + | * output of single links |
- | </ | + | * page style output |
+ | * paging options (offset, limit, index) | ||
- | * **command** | + | If you accidentally updated and need to revert back to the previous release, refer to tag [[https://github.com/dokufreaks/plugin-filelist/releases/tag/ |
- | * **pattern** | + | |
- | * **parameterlist** | + | |
- | ==== Paths ==== | + | Path configuration differs from previous releases. Please see below to set up your paths again. |
- | The filelist plugin supports both absolute as well as relative paths into the filesystem or Dokuwiki media namespaces. All paths are checked against a whitelist of allowed paths for scanning (as defined via the [[http://web.archive.org/web/20150411215519/http:// | + | Some more info is available in the [[https://github.com/dokufreaks/plugin-filelist/pull/39|pull request]]. |
- | Relative paths into the filesystem are interpreted relative to the Dokuwiki basedir. Relative media paths (without a leading '':'' | + | ===== Path Configuration ===== |
- | ==== Parameters ==== | + | To use this plugin, you need to configure one or more **paths** that should be allowed for listings. |
- | ^Name ^Description ^Possible values ^Default | | + | These paths need to be available on the same server your wiki is running |
- | |'' | + | |
- | |'' | + | |
- | |'' | + | |
- | |'' | + | |
- | ^ ^'' | + | |
- | |'' | + | |
- | |'' | + | |
- | |'' | + | |
- | |'' | + | |
- | |'' | + | |
- | |'' | + | |
- | |'' | + | |
- | |'' | + | |
- | |'' | + | |
- | |'' | + | |
- | |'' | + | |
- | |'' | + | |
- | |'' | + | |
- | |'' | + | |
- | |'' | + | |
- | |'' | + | |
- | |'' | + | |
- | ^ ^'' | + | |
- | |'' | + | |
- | ===== Examples ===== | + | All files and directories below the configured paths will be available to the plugin for listing. The PHP process running your DokuWiki needs to be allowed to read these files and directories! |
- | === filelist === | + | > Note: in older plugin versions the paths were configured in the '' |
- | == Example 1 == | + | For each configured path an optional **alias** may be configured. This alias will simplify the syntax when using the plugin (see examples below). |
- | < | + | For each configured path you may configure how the listed files are to be accessed via the web. Eg. how the full URL to download a file is to be constructed. By default files will be delivered by DokuWiki itself, without any additional permission checks |
- | {{filelist>: | + | |
- | </ | + | |
+ | For example custom web prefixes could be used for using your web server to deliver the files without involving PHP or to redirect all links to a document management system. | ||
+ | > Note: in older plugin versions the web prefixes were configured in the '' | ||
- | == Example 2 == | + | All the above things are configured in the '' |
- | + | ||
- | <code> | + | |
- | {{filelist> | + | |
- | </code> | + | |
- | == Example | + | **Example** |
< | < | ||
- | {{filelist>lib/images/*& | + | \\somewindows.server\with\a\share |
+ | W> https://somewindows.server/ | ||
+ | A> fileserver | ||
+ | / | ||
+ | A> local | ||
</ | </ | ||
+ | Forward or backward slashes are mostly interchangeable. Only UNC paths have to start with two backslashes. | ||
- | ====== Discussion ====== | + | > Important: the plugin will never list or give access to files in the DokuWiki or data directories, |
+ | ===== Other Config Options | ||
- | ---- | + | There are a few more options you can set in the [[plugin: |
- | The links to the details description and syntax seem to be not working, so we're not able to work out how this plugin | + | |
- | ---- | + | * '' |
+ | * '' | ||
+ | * '' | ||
- | Works with my DokuWiki version // | ||
- | ---- | + | ===== Usage ===== |
- | I played around with getting this to work for a while, before realising that, under Windows, the case of the drive letter does actually matter! | + | The filelist plugin provides |
- | + | ||
- | + | ||
- | ---- | + | |
- | + | ||
- | I had no end of trouble getting this to work on Bitnami WAMPStack Server (Windows, Apache, MySQL, PHP). I finally discovered that not only is the case of the path important, the mix of \ and / path separators used in the dokuwiki config path is important. It works now that I used the exact path specified in the dokuwiki " | + | |
- | + | ||
- | ---- | + | |
- | + | ||
- | In my judgement this plugin does not work with Rincewind. At least not in my configuration. In Rincewind I could this only get working with the direct-option and absolute paths, not the namespace notation. The namespace-notation resulted in Access-denied. | + | |
- | And ' | + | |
- | + | ||
- | The medialist-plugin | + | |
- | + | ||
- | Examples: | + | |
- | So this displayed a list | + | |
< | < | ||
- | {{filelist> | + | {{filelist> |
</ | </ | ||
- | This did NOT: | + | The **pattern** defines what files to list. It uses the [[man> |
- | < | + | For example, with the example path configuration from above, the following would list all files ending on '' |
- | {{filelist> | + | |
- | </ | + | |
- | Omission of //& | + | {{filelist> |
- | There seems to be no real alternative to this plugin, it would be nice if this could be repaired (or my mistake in the usage of it be clarified) | ||
- | The bug-report link on the owner' | ||
- | ---- | + | The **parameterlist** |
- | **It works with Rincewind and Angua.** | + | ==== Parameters ==== |
- | I had to go to //Admin > Configuration Settings > Filelist Plugin Settings// and give values | + | ^Name ^Description ^Possible |
- | + | |'' | |
- | |plugin»filelist»web_paths | + | |'' |
- | |plugin»filelist»allowed_absolute_paths | + | |'' |
- | + | |'' | |
- | [[http:// | + | |'' |
- | + | |'' | |
- | I also had to consider [[http:// | + | |'' |
- | + | |'' | |
- | With this modifications, I can use something like this: | + | |'' |
- | + | |'' | |
- | {{filelist>/ | + | |'' |
- | + | ||
- | or like this: | + | |
- | + | ||
- | {{filelist>/ | + | |
- | + | ||
- | to list the contents of my file system. | + | |
- | + | ||
- | In Firefox with the LocalLink extension, one may right-click on a link/ | + | |
- | + | ||
- | I have tested this in Mac OS X and Ubuntu. I have made a trial in Windows 7 with the following values (also trying | + | |
- | + | ||
- | |plugin»filelist»web_paths | + | |
- | |plugin»filelist»allowed_absolute_paths | + | |
- | + | ||
- | {{filelist> | + | |
- | + | ||
- | ----- | + | |
- | + | ||
- | This | + | |
- | {{filelist>: | + | |
- | works without any modification as expected | + | |
- | + | ||
- | ===== Binky ===== | + | |
- | + | ||
- | After upgrading to Binky, previously working code now displays: | + | |
- | + | ||
- | < | + | |
- | + | ||
- | I am logged in as admin and have made no changes to ACL rules. | + | |
- | + | ||
- | The configuration settings have not changed, path on server & url are correct: | + | |
- | + | ||
- | My previously working entries were of different format to discussion above (as follows): | + | |
- | + | ||
- | |plugin>> | + | |
- | |plugin>> | + | |
- | + | ||
- | Has anyone got this very useful plugin working on Binky? | + | |
- | + | ||
- | --- [[user> | + | |
- | + | ||
- | All these: | + | |
- | < | + | |
- | {{filelist>: | + | |
- | & | + | |
- | + | ||
- | {{filelist>: | + | |
- | & | + | |
- | + | ||
- | {{filelist>: | + | |
- | & | + | |
- | </ | + | |
- | work as expected on Binky. | + | |
- | + | ||
- | JohnG // | + | |
- | + | ||
- | Thanks. I finally figured out the problem, my mistake. I had to change my entry in the configuration settings from '' | + | |
- | + | ||
- | |plugin>> | + | |
- | + | ||
- | as the weburl.com.au points | + | |
- | + | ||
- | --- [[user> | + | |
- | + | ||
- | Actually after tracing through | + | |
- | + | ||
- | |plugin>> | + | |
- | |plugin>> | + | |
- | + | ||
- | Then in the actual code, to for example list all files in the media director of the form Notes*.pdf for the name space project, | + | |
- | + | ||
- | < | + | |
- | + | ||
- | --- [[user> | + | |
- | + | ||
- | It still doesn't work for me in Hrun. I set | + | |
- | |plugin»filelist»allowed_absolute_paths| < | + | |
- | |plugin»filelist»web_paths| < | + | |
- | but I get '' | + | |
- | + | ||
- | --- Hana Skoumalová // | + | |
- | + | ||
- | + | ||
- | ===== Hrun ===== | + | |
- | The default setting | + | |
- | * set the absolute path to '' | + | |
- | * set the absolute path to '' | + | |
- | --- [[user> | + | |
- | + | ||
- | + | ||
- | + | ||
- | on my dokuwiki hrun on a synology NAS and using multiple [[doku> | + | |
- | * plugin»filelist»allowed_absolute_paths = '' | + | |
- | * plugin»filelist»defaults = '' | + | |
- | + | ||
- | where | + | |
- | * '' | + | |
- | * '' | + | |
- | + | ||
- | by using the '' | + | |
- | ===== Detritus ===== | + | |
- | The setting | + | |
- | + | ||
- | ==== Filelist Future proof? ==== | + | |
- | Great plug-in but seems old and a bit unstable now and then? Our intranet depends | + | |
- | \\ ----2016.03.31 17:05 - MartinNL | + | |
- | + | ||
- | > You can always pay someone | + | |
- | + | ||
- | >> Thank you, I am going to discuss this here. | + | |
- | | + | |
- | + | ||
- | ===== History ===== | + | |
- | I have copied the essentials from the developer' | ||
- | --- [[user> | ||
- | The original page with illustrated examples is here: http:// | ||
- | The original git repository of the plugin can be found [[http:// |
plugin/filelist.1562161049.txt.gz · Last modified: 2019-07-03 15:37 by andi