annotate README @ 0:ccabef3f7d5f draft

Uploaded first version

1 This tool will lookup files on the Galaxy server machine, including mounted directories.
2 
3 The user aspects of the tool are explained in the help section of data_reader.xml
4 
5 Only directories that are included in the white list and not in the black list are allowed.
6 
7 The white and black lists can be changed without the requirement to restart the server as these are read from the tools install directory each time the tool is run.
8 
9 ====
10 
11 The white list is tool-data/white-list.ini
12 
13 Any directory that starts with any entry from this file will be considered to have passed.
14 
15 The default file includes a single / so all absolute paths will pass.
16 
17 ====
18 
19 The black list is tool-data/black-list.ini
20 
21 Any directory that contains any of the blacklisted strings anywhere in the path are excluded.
22 
23 The default file excludes most of the standard linux systems directories where data is unlikely to be found.
24 
25 It also excludes the /galaxy/ pattern to avoid users getting access to galaxy files.
26 
27 Also .. and ~ are excluded for security reasons.
28 
29 
30 
31 
32