Girder Configuration Options¶
General Plugin Settings¶
There are some general plugin settings that affect large_image as a Girder plugin. These settings can be accessed by an Admin user through the
Admin Console /
Plugins and selecting the gear icon next to
YAML Configuration Files¶
Some settings can be specified per-folder tree using yaml files. For these settings, if the configuration file exists in the current folder it is used. If not, the parent folders are checked iteratively up to the parent collection or user. If no configuration file is found, the
.config folder in the collection or user is checked for the file. Lastly, the
Configuration Folder specified on the plugin settings page is checked for the configuration file.
The configuration files can have different configurations based on the user’s access level and group membership.
The yaml file has the following structure:
--- # most settings are key-value pairs, where the value could be another # directionary with keys and values, lists, or other valid data. <key>: <value> # The access key is special access: # logged in users get these settings user: # If the value is a dictionary and the key matches a key at the base # level, then the values are combined. To completely replace the base # value, add the special key "__all__" and set it's value to true. <key>: <value> # admin users get these settings admin: <key>: <value> # The groups key specifes that specific user groups have distinct settings groups: <group name>: <key>: <value> # groups can specify access based on user or admin, too. access: ... # If __inherit__ is true, then merge this config file with the next config # file in the parent folder hierarchy. __inherit__: true
This is used to specify how items appear in item lists. There are two settings, one for folders in the main Girder UI and one for folders in dialogs (such as when browsing in the file dialog).
If there are no large images in a folder, none of the image columns will appear.
Editing Configuration Files¶
Some file types can be edited on their item page. This is detected based on the mime type associated with the file:
application/json for json files and
text/x-yaml for yaml files. If a user has enough permissions, these can be modified and saved. Note that this does not alter imported files; rather, on save it will create a new file in the assetstore and use that; this works fine for using the configuration files.
For admins, there is also support for the
application/x-girder-ini mime type for Girder configuration files. This has a special option to replace the existing Girder configuration and restart the server and should be used with due caution.