Yabi Documentation

• About Yabi
  • Key features
  • A brief history
  • Architecture
    • Client
    • Yabi Application
    • Yabi Backend
  • Source code
  • Licence
  • Authors
  • Acknowledgements
• Installation
  • Components
  • How to install
    • Prerequisites
    • Installation of the Yabi web application under Apache
    • Database Setup
    • Caching and Sessions
    • Last steps
    • Setting up Yabish
• Logging
• Testing
  • Running Tests
    • Lint
• Yabi Authentication
  • Database Authentication
  • LDAP Authentication
    • Required settings:
    • Optional settings:
  • Kerberos and LDAP Authentication
  • Fallback on Database Authentication
• Adding Users
  • Adding Regular Users
    • Using Different Authentication Backends
  • Adding Adminstrator Users
  • Viewing a User’s Setup
    • User Tools
    • User Backends
• Backends
  • Setting up an SSH File System Backend
    • A note about the Path field
    • Additional Fields
  • Adding an Execution Backend
    • Submission Template Field
  • Troubleshooting SSH
  • Null Backend
  • S3 Backend
  • OpenStack Swift Backend
• Credentials
  • A note about encryption
  • How credentials are used by the backend
    • Adding Credentials
    • Credential Actions
• Backend Credentials
  • Adding Backend Credentials
  • Default Stageout Explained
  • What the user will see
• Dynamic Backends
  • AWS Credentials
  • OpenStack Credentials
  • Dynamic Backends in Admin
  • Dynamic Backend Configurations
    • AWS specific configuration
    • OpenStack specific configuration
• Submission Templates
  • Submission Template Lookup Order
  • Submission Template Variables
  • User-supplied Environment Variables
• Adding Tools
  • Tool Description
  • Tool Parameter Fields
    • Switch
    • Switch Use
    • Rank
    • Mandatory
    • Output File
    • Extension Param
    • Possible Values
    • Default Value
    • Helptext
    • File Assignment
    • Use Output Filename
    • Accepted Filetypes
  • Tool
• Importing and Exporting Tools
  • Exporting tools in JSON
  • Importing tools in JSON
• Toolsets and Toolgroups
  • Toolsets
  • Toolgroups
• Frequently Asked Questions
  • Admin
    • I’ve installed Yabi but when I try to login why do I see this error “Unable to create a new session key.”?
    • What backend should a file select tool use or why won’t my file select run?
    • What is the default stageout field for?
    • How does Yabi handle the URI construction with the Backend and Backend Credential records?
    • I’m trying to add a tool that takes an input directory which it will use as a working directory, how do I do this?
    • I’m having trouble setting up an SSH backend, what am I doing wrong?
    • SSH works, but I’m having trouble submitting jobs with YABI?
    • How do I get symlinking working?