Welcome to Agora’s documentation!

Administrator Documentation

• 1. Server Requirements
  • 1.1. Hardware
  • 1.2. Software
  • 1.3. Docker
  • 1.4. Proxy
• 2. Installation using the Wizard
  • 2.1. Prepare Installation
    • 2.1.1. Internet access
    • 2.1.2. License
    • 2.1.3. Storage
  • 2.2. Start Installation
  • 2.3. Agora configuration
  • 2.4. Useful commands
    • 2.4.1. Wizard
    • 2.4.2. Start Agora
    • 2.4.3. Stop Agora
    • 2.4.4. Update Agora
    • 2.4.5. Update the Agora Installer
    • 2.4.6. Diagnose
• 3. Manual installation
  • 3.1. Step-by-Step Instructions
  • 3.2. Docker Registry
  • 3.3. Configuration
    • 3.3.1. Time zone
    • 3.3.2. Docker user
    • 3.3.3. Dicom node
    • 3.3.4. Create the docker-compose configuration
    • 3.3.5. Create the docker-compose configuration
  • 3.4. Data storage
    • 3.4.1. Docker Volumes
  • 3.5. Data storage
    • 3.5.1. Docker Volumes
    • 3.5.2. Using NFS
  • 3.6. Start Agora
  • 3.7. Stop Agora
• 4. Installation on Kubernetes
  • 4.1. Step-by-Step Instructions
• 5. Post installation tasks
  • 5.1. License
  • 5.2. Email Settings
  • 5.3. Hostname
  • 5.4. Dicom Node
  • 5.5. Webserver Certificate
  • 5.6. Global Hosts
  • 5.7. Useful Docker commands
• 6. Maintain Agora
  • 6.1. Update Agora
  • 6.2. Update with the possibility to return to the previous version
  • 6.3. Update to a specific version
  • 6.4. Update Agora-Installer
  • 6.5. Move data
• 7. Backup
  • 7.1. Backup Configuration
  • 7.2. Backup Data Files
  • 7.3. Backup Databases
  • 7.4. Restore
    • 7.4.1. Download the Agora Installer
    • 7.4.2. Restore Agora Configuration
    • 7.4.3. Create the Agora Volumes
    • 7.4.4. Rebuild the docker-compose file and pull the Agora images:
    • 7.4.5. Restore the Data Files
    • 7.4.6. Restore the Agora Database (Postgres)
    • 7.4.7. Restore the Parameter Database (MongoDB)
    • 7.4.8. Start Agora
• 8. Management Tasks
  • 8.1. Create a new superuser
• 9. Optimize Agora
  • 9.1. Database
• 10. Appendix
  • 10.1. Using a Proxy Sevrer
    • 10.1.1. Configure Linux to use a proxy
    • 10.1.2. CA certificates
    • 10.1.3. apt-get (Ubuntu)
    • 10.1.4. yum (RHEL, CentOS)
    • 10.1.5. Docker Service
    • 10.1.6. Sudo

User Documentation

• 1. Introduction
  • 1.1. Signing up for an account
  • 1.2. Signing in
• 2. Getting Started
  • 2.1. Dashboard
  • 2.2. Main Menu Bar
  • 2.3. Status Bar
  • 2.4. MyAgora Project
  • 2.5. Customizing your account
  • 2.6. Install AgoraApp
• 3. Projects
  • 3.1. Project Groups
  • 3.2. Project Page
  • 3.3. Project Menu
    • 3.3.1. Folder Tree
    • 3.3.2. Study List
    • 3.3.3. Patient List
    • 3.3.4. Recently Used Items
    • 3.3.5. Search and Queries
    • 3.3.6. Timeline
    • 3.3.7. Tasks
    • 3.3.8. Triggers
    • 3.3.9. Project Settings
    • 3.3.10. Trash Box
• 4. Agora Data Model
  • 4.1. Parameter Sets
  • 4.2. Data Upload vs. Data Import
  • 4.3. Segmented Data Import
• 5. Importing Data to Agora
  • 5.1. Elements of a data import
  • 5.2. Upload Data over the Browser
  • 5.3. Upload Data directly from an MR scanner
    • 5.3.1. Philips Platform
  • 5.4. Import from Bruker scanners
  • 5.5. Import from Siemens scanners
  • 5.6. Import from GE scanners
  • 5.7. DICOM Data Transfer
  • 5.8. Upload Data using the command line interface
  • 5.9. Uploading Data from within your Programs
• 6. Data Download and Export
• 7. Working with Tables
• 8. Viewer
  • 8.1. Supported image formats
  • 8.2. Spectroscopy Viewer
• 9. Database Search
  • 9.1. Quick Search
  • 9.2. Database Queries
• 10. Tasks
  • 10.1. Task Definition
    • 10.1.1. Task Parameters
  • 10.2. Script Tasks
  • 10.3. Task Templates
  • 10.4. Docker and Podman Support
  • 10.5. Local tasks
    • 10.5.1. Examples
  • 10.6. Server tasks
    • 10.6.1. Examples
• 11. Task Execution Hosts
  • 11.1. Global Hosts
• 12. Anonymization
• 13. Showcases
• 14. Tags and Rating
  • 14.1. Tags
  • 14.2. Rating
• 15. Data Transfer Request
  • 15.1. Scenarios (When should I use his feature)
  • 15.2. Prerequisites
  • 15.3. Usage
    • 15.3.1. Creating a transfer request
    • 15.3.2. Providing the transfer request token
    • 15.3.3. Transferring files from Agora
    • 15.3.4. Transferring files with gtTransfer
    • 15.3.5. Import transferred files into Agora
    • 15.3.6. Download transferred files
• 16. Miscellaneous Features
  • 16.1. Favorites
  • 16.2. Trash
  • 16.3. Python connector
• 17. HowTo’s

Developer Documentation

• 1. Developer Manual
  • 1.1. Agora REST Interface
  • 1.2. Agora API Libraries
• 2. Python API Library
• 3. Matlab API Library
• 4. C/C++ API Library

About

• Changelog
  • [7.16.0] - 2025-05-26
    • Added
  • [7.15.3] - 2025-05-14
    • Added
    • Fixed
    • Changed
  • [7.14.0] - 2025-02-13
    • Added
    • Fixed
    • Changed
  • [7.13.1] - 2025-01-07
    • Added
    • Fixed
    • Changed
  • [7.12.7] - 2024-12-17
    • Fixed
    • Changed
  • [7.12.6] - 2024-11-24
    • Added
    • Fixed
  • [7.12.2] - 2024-10-21
    • Added
    • Changed
    • Fixed
  • [7.12.1] - 2024-10-03
    • Changed
    • Fixed
  • [7.12.0] - 2024-09-27
    • Added
    • Changed
    • Fixed
  • [7.11.6] - 2024-08-29
    • Added
    • Changed
    • Fixed
  • [7.11.5] - 2024-07-17
    • Changed
  • [7.11.4] - 2024-07-17
    • Changed
  • [7.11.3] - 2024-07-16
    • Changed
    • Fixed
  • [7.11.2] - 2024-07-10
    • Changed
  • [7.11.1] - 2024-07-05
    • Changed
  • [7.11.0] - 2024-07-04
    • Added
    • Changed
  • [7.10.4] - 2024-04-30
    • Changed
  • [7.10.3] - 2024-04-29
    • Fixed
  • [7.10.2] - 2024-04-26
    • Fixed
  • [7.10.1] - 2024-04-25
    • Fixed
  • [7.10.0] - 2024-04-24
    • Added
    • Fixed
  • [7.9.15] - 2024-04-19
    • Added
    • Fixed

Indices and tables

• Index

• Module Index

• Search Page