annotate README @ 0:25b07ce180d4 draft

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