annotate README @ 0:ccabef3f7d5f draft

Uploaded first version
author brenninc
date Sun, 08 May 2016 11:01:03 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
1 This tool will lookup files on the Galaxy server machine, including mounted directories.
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
2
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
3 The user aspects of the tool are explained in the help section of data_reader.xml
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
4
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
5 Only directories that are included in the white list and not in the black list are allowed.
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
6
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
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.
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
8
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
9 ====
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
10
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
11 The white list is tool-data/white-list.ini
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
12
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
13 Any directory that starts with any entry from this file will be considered to have passed.
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
14
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
15 The default file includes a single / so all absolute paths will pass.
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
16
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
17 ====
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
18
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
19 The black list is tool-data/black-list.ini
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
20
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
21 Any directory that contains any of the blacklisted strings anywhere in the path are excluded.
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
22
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
23 The default file excludes most of the standard linux systems directories where data is unlikely to be found.
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
24
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
25 It also excludes the /galaxy/ pattern to avoid users getting access to galaxy files.
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
26
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
27 Also .. and ~ are excluded for security reasons.
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
28
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
29
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
30
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
31
ccabef3f7d5f Uploaded first version
brenninc
parents:
diff changeset
32