Girder
Administrator Documentation
System Prerequisites
Debian / Ubuntu
CentOS / Fedora / Red Hat Enterprise Linux
Arch Linux
OS X
Windows
Installation
Install with pip
Install from Git Checkout
Run
Initial Setup
Deploy
Heroku
Reverse Proxy
Apache
Nginx
Girder Settings
Docker Container
Google Container Engine
Configuration
Logging
Plugin path
Server thread pool
Changing file limits
User Documentation
User Guide
Document Conventions
Concepts
Users
Groups
Collections
Folders
Items
Files
Assetstores
Permissions
Developer Documentation
API Documentation
RESTful API
Models
Model Helper Functions
Model Base
Events
User
Password
Token
Group
Collection
Folder
Item
Setting
Python API for RESTful web API
Base Classes and Helpers
User
Group
Item
Folder
Utility
Constants
Clients
jQuery Plugins
Developer Guide
Configuring Your Development Environment
Vagrant
Utilities
Configuration Loading
Server Development
Python Style
Use
%
instead of
format
Client Development
Server Side Testing
Running the Tests
Running the Tests with Coverage Tracing
Client Side Testing
Adding a New Client Side Test
Code Review
Creating a new release
Releasing the python client package
Plugin Development
Example Plugin
Extending the Server-Side Application
Adding a new route to the web API
Adding a new resource type to the web API
Adding a new model type in your plugin
The events system
Automated testing for plugins
Extending the Client-Side Application
Executing custom Grunt build steps for your plugin
JavaScript extension capabilities
Setting an empty layout for a route
Developer Cookbook
Client cookbook
Authenticating to the web API
Upload a file
Using the Girder upload widget in a custom app
Server cookbook
Creating a REST route
Loading a resource by its ID
Send a raw/streaming HTTP response body
Serving a static file
Sending Emails
Logging a Message
Adding Automated Tests
Serving a custom app from the server root
Supporting web browser operations where custom headers cannot be set
External Web Clients
Including the Girder REST API
Apache
Tangelo
Using Girder JavaScript Utilities and Views
Including the JavaScript
Initializing Girder
Using Girder Register and Login UI
Python Client and Girder CLI
Installation
The Command Line Interface
Specifying the Girder Instance
Upload a local file hierarchy
Download a Folder hierarchy into a local folder
The Python Client Library
Recursively inherit access control to a Folder’s descendants
Set callbacks for Folder and Item uploads
Further Examples and Function Level Documentation
Security
Default Authorization
CORS (Cross-Origin Resource Sharing)
Database Injection Attacks
Session Management
Cross-Site Scripting (XSS)
Cross-Site Request Forgery (CSRF)
Dependent Libraries
Notes on Secure Deployment
Build the Sphinx Documentation
Plugins
Jobs
Geospatial
Google Analytics
Metadata Extractor
OAuth Login
Google
Provenance Tracker
API
Gravatar Portraits
Javascript clients
HDFS Assetstore
Importing data
Girder
Docs
»
Edit on GitHub
Index
Symbols
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
P
|
R
|
S
|
T
|
U
|
V
Symbols
$.girderBrowser() ($ method)
A
AccessControlledModel (class in girder.models.model_base)
AccessException
AccessType (class in girder.constants)
add_folder_upload_callback() (girder_client.GirderClient method)
add_item_upload_callback() (girder_client.GirderClient method)
addMetadataToFolder() (girder_client.GirderClient method)
addMetadataToItem() (girder_client.GirderClient method)
addResponse() (girder.events.Event method)
addScope() (girder.models.token.Token method)
addTemplateDirectory() (in module girder.utility.mail_utils)
addUser() (girder.models.group.Group method)
AssetstoreType (class in girder.constants)
AsyncEventsThread (class in girder.events)
authenticate() (girder.models.password.Password method)
(girder_client.GirderClient method)
B
bind() (in module girder.events)
boolParam() (girder.api.rest.Resource method)
boundHandler (class in girder.api.rest)
C
checkConsistency() (girder.models.item.Item method)
childFiles() (girder.models.item.Item method)
childFolders() (girder.models.folder.Folder method)
childItems() (girder.models.folder.Folder method)
clearModels() (in module girder.utility.model_importer)
Collection (class in girder.models.collection)
configureServer() (in module girder.utility.server)
copyAccessPolicies() (girder.models.model_base.AccessControlledModel method)
copyFolder() (girder.models.folder.Folder method)
copyFolderComponents() (girder.models.folder.Folder method)
copyItem() (girder.models.item.Item method)
createCollection() (girder.models.collection.Collection method)
createFolder() (girder.models.folder.Folder method)
(girder_client.GirderClient method)
createGroup() (girder.models.group.Group method)
createItem() (girder.models.item.Item method)
(girder_client.GirderClient method)
createResource() (girder_client.GirderClient method)
createToken() (girder.models.token.Token method)
createUser() (girder.models.user.User method)
D
deleteAuthTokenCookie() (girder.api.rest.Resource method)
downloadFile() (girder_client.GirderClient method)
downloadFolderRecursive() (girder_client.GirderClient method)
downloadItem() (girder_client.GirderClient method)
E
encryptAndStore() (girder.models.password.Password method)
endpoint() (in module girder.api.rest)
ensureIndex() (girder.models.model_base.Model method)
ensureIndices() (girder.models.model_base.Model method)
ensureTextIndex() (girder.models.model_base.Model method)
ensureTokenScopes() (girder.api.rest.Resource method)
(in module girder.api.rest)
Event (class in girder.events)
exposeFields() (girder.models.model_base.Model method)
F
fileList() (girder.models.collection.Collection method)
(girder.models.folder.Folder method)
(girder.models.item.Item method)
(girder.models.user.User method)
filter() (girder.models.collection.Collection method)
(girder.models.folder.Folder method)
(girder.models.group.Group method)
(girder.models.item.Item method)
(girder.models.model_base.AccessControlledModel method)
(girder.models.model_base.Model method)
(girder.models.user.User method)
filterDocument() (girder.models.model_base.Model method)
filterResultsByPermission() (girder.models.item.Item method)
(girder.models.model_base.AccessControlledModel method)
find() (girder.models.model_base.Model method)
findOne() (girder.models.model_base.Model method)
Folder (class in girder.models.folder)
G
genToken() (in module girder.models.token)
get() (girder.models.setting.Setting method)
getAccessLevel() (girder.models.group.Group method)
(girder.models.model_base.AccessControlledModel method)
getAdmins() (girder.models.user.User method)
getAllowedScopes() (girder.models.token.Token method)
getBodyJson() (girder.api.rest.Resource method)
(in module girder.api.rest)
getCurrentToken() (girder.api.rest.Resource method)
getCurrentUser() (girder.api.rest.Resource method)
getDbConfig() (in module girder.models)
getDbConnection() (in module girder.models)
getDefault() (girder.models.setting.Setting method)
getEmailUrlPrefix() (in module girder.utility.mail_utils)
getFolder() (girder_client.GirderClient method)
getFolderAccess() (girder_client.GirderClient method)
getFullAccessList() (girder.models.model_base.AccessControlledModel method)
getFullRequestList() (girder.models.group.Group method)
getInvites() (girder.models.group.Group method)
getItem() (girder_client.GirderClient method)
getMembers() (girder.models.group.Group method)
getPagingParameters() (girder.api.rest.Resource method)
getResource() (girder_client.GirderClient method)
getSizeRecursive() (girder.models.folder.Folder method)
girder.api.rest (module)
girder.constants (module)
girder.events (module)
girder.models (module)
girder.models.collection (module)
girder.models.folder (module)
girder.models.group (module)
girder.models.item (module)
girder.models.model_base (module)
girder.models.password (module)
girder.models.setting (module)
girder.models.token (module)
girder.models.user (module)
girder.utility.config (module)
girder.utility.mail_utils (module)
girder.utility.model_importer (module)
girder.utility.server (module)
girder_client (module)
GirderClient (class in girder_client)
GirderException
Group (class in girder.models.group)
H
handleRoute() (girder.api.rest.Resource method)
hasAccess() (girder.models.group.Group method)
(girder.models.item.Item method)
(girder.models.model_base.AccessControlledModel method)
hasScope() (girder.models.token.Token method)
hideFields() (girder.models.model_base.Model method)
HttpError
I
increment() (girder.models.model_base.Model method)
inheritAccessControlRecursive() (girder_client.GirderClient method)
initialize() (girder.models.model_base.Model method)
inviteUser() (girder.models.group.Group method)
isFileCurrent() (girder_client.GirderClient method)
Item (class in girder.models.item)
J
joinGroup() (girder.models.group.Group method)
L
list() (girder.models.collection.Collection method)
(girder.models.group.Group method)
listFolder() (girder_client.GirderClient method)
listItem() (girder_client.GirderClient method)
listMembers() (girder.models.group.Group method)
listResource() (girder_client.GirderClient method)
load() (girder.models.folder.Folder method)
(girder.models.item.Item method)
(girder.models.model_base.AccessControlledModel method)
(girder.models.model_base.Model method)
loadmodel (class in girder.api.rest)
M
Model (class in girder.models.model_base)
model() (girder.utility.model_importer.ModelImporter static method)
ModelImporter (class in girder.utility.model_importer)
move() (girder.models.folder.Folder method)
(girder.models.item.Item method)
P
parentsToRoot() (girder.models.folder.Folder method)
(girder.models.item.Item method)
Password (class in girder.models.password)
preventDefault() (girder.events.Event method)
R
recalculateSize() (girder.models.item.Item method)
registerModel() (girder.utility.model_importer.ModelImporter static method)
remove() (girder.models.collection.Collection method)
(girder.models.folder.Folder method)
(girder.models.group.Group method)
(girder.models.item.Item method)
(girder.models.model_base.Model method)
(girder.models.user.User method)
removeRoute() (girder.api.rest.Resource method)
removeUser() (girder.models.group.Group method)
removeWithQuery() (girder.models.model_base.Model method)
renderTemplate() (in module girder.utility.mail_utils)
requireAccess() (girder.models.model_base.AccessControlledModel method)
requireAdmin() (girder.api.rest.Resource method)
(in module girder.api.rest)
requireParams() (girder.api.rest.Resource method)
Resource (class in girder.api.rest)
RestException
route() (girder.api.rest.Resource method)
run() (girder.events.AsyncEventsThread method)
S
save() (girder.models.model_base.Model method)
search() (girder.models.user.User method)
sendAuthTokenCookie() (girder.api.rest.Resource method)
sendEmail() (in module girder.utility.mail_utils)
sendRestRequest() (girder_client.GirderClient method)
set() (girder.models.setting.Setting method)
setAccessList() (girder.models.collection.Collection method)
(girder.models.folder.Folder method)
(girder.models.model_base.AccessControlledModel method)
setFolderAccess() (girder_client.GirderClient method)
setGroupAccess() (girder.models.model_base.AccessControlledModel method)
setMetadata() (girder.models.folder.Folder method)
(girder.models.item.Item method)
setPassword() (girder.models.user.User method)
setPublic() (girder.models.model_base.AccessControlledModel method)
Setting (class in girder.models.setting)
SettingDefault (class in girder.constants)
SettingKey (class in girder.constants)
setup() (in module girder.utility.server)
setUserAccess() (girder.models.group.Group method)
(girder.models.model_base.AccessControlledModel method)
STATIC_ROOT_DIR (in module girder.constants)
staticFile() (in module girder.utility.server)
stop() (girder.events.AsyncEventsThread method)
stopPropagation() (girder.events.Event method)
subtreeCount() (girder.models.collection.Collection method)
(girder.models.folder.Folder method)
(girder.models.model_base.Model method)
(girder.models.user.User method)
T
TerminalColor (class in girder.constants)
textSearch() (girder.models.item.Item method)
(girder.models.model_base.AccessControlledModel method)
(girder.models.model_base.Model method)
Token (class in girder.models.token)
TokenScope (class in girder.constants)
trigger() (girder.events.AsyncEventsThread method)
(in module girder.events)
U
unbind() (in module girder.events)
unbindAll() (in module girder.events)
unset() (girder.models.setting.Setting method)
update() (girder.models.model_base.Model method)
updateCollection() (girder.models.collection.Collection method)
updateFolder() (girder.models.folder.Folder method)
updateGroup() (girder.models.group.Group method)
updateItem() (girder.models.item.Item method)
upload() (girder_client.GirderClient method)
uploadFileToItem() (girder_client.GirderClient method)
User (class in girder.models.user)
V
validate() (girder.models.folder.Folder method)
(girder.models.model_base.Model method)
(girder.models.setting.Setting method)
(girder.models.user.User method)
validateCorePluginsEnabled() (girder.models.setting.Setting method)
ValidationException
Read the Docs
v: v1.3.0
Versions
latest
v1.3.0
v1.2.4
v1.2.3
v1.2.2
v1.2.1
v1.2.0
v1.1.0
v1.0.1
v1.0.0
Downloads
pdf
htmlzip
epub
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.