Welcome to bam-server’s documentation!

Contents

• What is bam-server
• How it works
• Installation guidelines
  • Requirements
  • Running in dev mode
  • Deployment
  • Configuration
  • Building from source
• BAM query API
  • Authorization
  • API
    • BAM index
    • Range query
    • Using samtools
    • Reads in JSON format
• Authorization protocol
  • HMAC protocol
  • RSA protocol
  • JWT example
  • Supported algorithms
• Local database
  • Schema
  • Fields description
  • Some test data
• Management API
  • Add/remove an app
  • Add/remove users
  • Add/remove samples
  • Add/remove an attribution
• Implementation examples
  • Using IGV.js as reads viewer
  • Example of using Auth0 as authorization server

Indices and tables

• Index
• Module Index
• Search Page