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.4.2. Using NFS
  • 3.5. Start Agora
  • 3.6. 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
  • 5.8. Setup an SSH Task Container
    • 5.8.1. Overview
    • 5.8.2. Architecture
    • 5.8.3. Example config snippet
    • 5.8.4. Key points
    • 5.8.5. How to apply
    • 5.8.6. Connecting from Agora
    • 5.8.7. Connecting from within the Agora app container
    • 5.8.8. Optional: publish to host
    • 5.8.9. Troubleshooting
• 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
  • 8.2. Agora management commands
    • 8.2.1. Command reference
• 9. Optimize Agora
  • 9.1. Database
• 10. Administration Settings
  • 10.1. General Settings
    • 10.1.1. Hostname
    • 10.1.2. Registration
    • 10.1.3. Authentication
    • 10.1.4. Single Sign-On (SSO)
    • 10.1.5. Error Logging
    • 10.1.6. User Feedback
    • 10.1.7. Download
  • 10.2. Mail Settings
  • 10.3. User Management
  • 10.4. Global Hosts
  • 10.5. DICOM Auto-Routing
  • 10.6. Task Queue
  • 10.7. Logs
  • 10.8. Impersonate User
  • 10.9. Admin Mode
  • 10.10. License
• 11. Appendix
  • 11.1. Using a Proxy Sevrer
    • 11.1.1. Configure Linux to use a proxy
    • 11.1.2. CA certificates
    • 11.1.3. apt-get (Ubuntu)
    • 11.1.4. yum (RHEL, CentOS)
    • 11.1.5. Docker Service
    • 11.1.6. Sudo

User Documentation

• 1. What’s New in Agora
  • 1.1. Triggers — Automated Workflows with Python
  • 1.2. Parameter Forms — Structured Metadata Collection
  • 1.3. Booking System — Schedule Shared Resources
  • 1.4. Project Sync & Data Transfer — Connect Agora Instances
    • 1.4.1. Project Synchronization
  • 1.5. DICOM Auto-Routing — Route Incoming Data Automatically
• 2. Introduction
  • 2.1. Signing up for an account
  • 2.2. Signing in
• 3. Getting Started
  • 3.1. Dashboard
  • 3.2. Main Menu Bar
  • 3.3. Status Bar
  • 3.4. MyAgora Project
  • 3.5. Customizing your account
  • 3.6. Install AgoraApp
• 4. Projects
  • 4.1. Project Groups
  • 4.2. Project Page
  • 4.3. Project Menu
    • 4.3.1. Folder Tree
    • 4.3.2. Study List
    • 4.3.3. Patient List
    • 4.3.4. Recently Used Items
    • 4.3.5. Search and Queries
    • 4.3.6. Timeline
    • 4.3.7. Tasks
    • 4.3.8. Triggers
    • 4.3.9. Project Settings
    • 4.3.10. Trash Box
• 5. Agora Data Model
  • 5.1. Parameter Sets
  • 5.2. Data Upload vs. Data Import
  • 5.3. Segmented Data Import
  • 5.4. Data Storage and Project Isolation
    • 5.4.1. File-Level Sharing (Copy-on-Write)
  • 5.5. Duplicate Import Behaviour
    • 5.5.1. Study and Series Merging
    • 5.5.2. Dataset and File Deduplication
    • 5.5.3. Special Cases
• 6. Importing Data to Agora
  • 6.1. Elements of a data import
  • 6.2. Upload Data over the Browser
  • 6.3. Upload Data directly from an MR scanner
    • 6.3.1. Philips Platform
  • 6.4. Import from Bruker scanners
  • 6.5. Import from Siemens scanners
  • 6.6. Import from GE scanners
  • 6.7. DICOM Data Transfer
  • 6.8. Upload Data from the command line
  • 6.9. Upload Data using Python
  • 6.10. Upload Data using MATLAB
  • 6.11. Custom Import with a Manifest File
    • 6.11.1. Manifest File Format
    • 6.11.2. Minimal Example
    • 6.11.3. Using the Python Connector
• 7. Data Download and Export
  • 7.1. Download via the Browser
  • 7.2. Download with the Agora App
  • 7.3. Download with Python
  • 7.4. Download with MATLAB
• 8. Managing Data
  • 8.1. Creating a Folder
  • 8.2. Creating Studies and Series
  • 8.3. Creating a Patient
  • 8.4. Adding a dataset to an existing series
    • 8.4.1. Limitations
  • 8.5. Selecting Items
  • 8.6. Detail Panel
  • 8.7. User-Defined Parameters
    • 8.7.1. Parameter Sets
    • 8.7.2. Parameters
    • 8.7.3. Value Types
    • 8.7.4. Searching by User-Defined Parameters
    • 8.7.5. Automating User-Defined Parameters with Triggers
  • 8.8. Forms Tab
  • 8.9. Organization Within a Project
  • 8.10. Quick Search and Filtering
  • 8.11. Query Folders
    • 8.11.1. Attaching a Query
    • 8.11.2. Synchronizing a Query Folder
    • 8.11.3. Managing Attached Queries
    • 8.11.4. Constraints
  • 8.12. Tags and Rating
    • 8.12.1. Tags
    • 8.12.2. Rating
  • 8.13. Favorites
  • 8.14. Selection Set
  • 8.15. Editing Objects
  • 8.16. Dataset Versions
    • 8.16.1. Viewing Versions
    • 8.16.2. Restoring a Version
    • 8.16.3. Deleting a Version
    • 8.16.4. Enabling and Disabling Versioning
  • 8.17. Deleting Objects
  • 8.18. Copying Objects to Another Project
  • 8.19. Moving Objects
  • 8.20. Copying Objects to a Remote Agora Instance
  • 8.21. Transferring Data Between Projects
• 9. Parameter Form Templates
  • 9.1. Template Types
  • 9.2. Managing Templates in Project Settings
    • 9.2.1. Creating a Template
    • 9.2.2. Defining Fields
    • 9.2.3. Field Types
    • 9.2.4. Signature Fields
  • 9.3. HTML Layout and Placeholder Syntax
  • 9.4. Filling in a Form
    • 9.4.1. Central Frame View
  • 9.5. Saved Values and Parameter Sets
  • 9.6. Exporting and Importing Templates
  • 9.7. Copying and Duplicating Templates
  • 9.8. Sharing Forms with External Users (Public Links)
    • 9.8.1. How It Works
    • 9.8.2. Generating a Share Link
    • 9.8.3. Managing Existing Links
    • 9.8.4. What the External User Sees
    • 9.8.5. Submission Behaviour and Restrictions
• 10. Viewer
  • 10.1. Single Viewer
  • 10.2. Multi-Viewer
  • 10.3. Supported Formats
  • 10.4. Navigation
  • 10.5. Toolbar
  • 10.6. Workbooks
  • 10.7. 3D Viewer
  • 10.8. Spectroscopy Viewer
• 11. Database Search
  • 11.1. Quick Search
  • 11.2. Database Queries
    • 11.2.1. Basic Syntax
    • 11.2.2. Fields
    • 11.2.3. Result Types
    • 11.2.4. Comparison Operators
    • 11.2.5. Values
    • 11.2.6. Date Fields
    • 11.2.7. Count Queries
    • 11.2.8. Parameter Queries
    • 11.2.9. Examples
    • 11.2.10. Saved Queries
• 12. Hosts
  • 12.1. Adding a Host
  • 12.2. Host Types
    • 12.2.1. SSH Server
    • 12.2.2. Docker Repository
    • 12.2.3. DICOM Node
    • 12.2.4. Agora Server
  • 12.3. Authentication
  • 12.4. Testing the Connection
  • 12.5. Global Hosts
• 13. Tasks
  • 13.1. UI Tasks
    • 13.1.1. Task Name
    • 13.1.2. Execution Target
    • 13.1.3. Container
    • 13.1.4. Inputs
    • 13.1.5. Command Line
    • 13.1.6. Additional Parameters
    • 13.1.7. Examples
  • 13.2. Script Tasks
    • 13.2.1. Structure
    • 13.2.2. Stages
    • 13.2.3. Inputs
    • 13.2.4. Job Fields
    • 13.2.5. Artifacts
    • 13.2.6. Template Variables
    • 13.2.7. Examples
  • 13.3. Where Tasks Run
    • 13.3.1. Local Tasks
    • 13.3.2. Host Server Tasks
    • 13.3.3. Containers (Docker and Podman)
  • 13.4. Monitoring Task Output
  • 13.5. Task Results
  • 13.6. Batch Mode
  • 13.7. Task Templates
  • 13.8. How-To Guides
    • 13.8.1. Setup and perform a Philips Recon 2.0 reconstruction
• 14. Triggers
  • 14.1. Overview
  • 14.2. Events
  • 14.3. Selectors
  • 14.4. Python Script Filter
    • 14.4.1. Script structure
    • 14.4.2. The context dictionary
    • 14.4.3. Script filter examples
  • 14.5. Actions
    • 14.5.1. Link to folder / Copy to project
    • 14.5.2. Run task
    • 14.5.3. Rename
    • 14.5.4. Add Tag
    • 14.5.5. Remove Tag
    • 14.5.6. Add Parameter
    • 14.5.7. Log Message
    • 14.5.8. Send Email
    • 14.5.9. Python Script
  • 14.6. Project Counters
    • 14.6.1. Using counters in Jinja2 templates
    • 14.6.2. Using counters in Python scripts
  • 14.7. Developing and Debugging Python Scripts
  • 14.8. Trigger History
• 15. Showcases
  • 15.1. Creating a Showcase
  • 15.2. Adding Objects
  • 15.3. Managing Access
  • 15.4. Viewing Showcases
  • 15.5. Expiration
• 16. User Profile and Settings
  • 16.1. Profile
    • 16.1.1. Identification
    • 16.1.2. Password
    • 16.1.3. API Key
    • 16.1.4. Date and Time Format
  • 16.2. Appearance
  • 16.3. Agora App
  • 16.4. Information
  • 16.5. Downloads
• 17. Booking
  • 17.1. Booking Resources
  • 17.2. The Week View
  • 17.3. Creating a Booking
  • 17.4. Editing and Deleting a Booking
  • 17.5. Recurring Bookings
  • 17.6. Booking on Behalf of Another User
  • 17.7. My Bookings
  • 17.8. Administration
    • 17.8.1. Managing Resources
    • 17.8.2. Managing Groups
    • 17.8.3. Statistics

Developer Documentation

• 1. Developer Manual
  • 1.1. Agora REST Interface
  • 1.2. Agora API Libraries
• 2. REST API
  • 2.1. Authentication
  • 2.2. Pagination
  • 2.3. Projects
  • 2.4. Folders
  • 2.5. Studies (Exams)
  • 2.6. Series
  • 2.7. Datasets
  • 2.8. Uploading Data
  • 2.9. Downloading Data
  • 2.10. Tasks
  • 2.11. Search
  • 2.12. Public Form Links
  • 2.13. Current User
• 3. Python API Library
• 4. Matlab API Library

About

• Changelog
  • [7.20.1] - 2026-05-05
    • Added
    • Changed
    • Fixed
  • [7.19.1] - 2026-04-10
    • Added
    • Fixed
  • [7.18.3] - 2026-03-19
    • Added
    • Changed
  • [7.18.2] - 2026-02-17
    • Added
    • Fixed
  • [7.18.1] - 2025-12-16
    • Added
    • Fixed
    • Changed
  • [7.17.1] - 2025-10-24
    • Changed
  • [7.17.0] - 2025-10-15
    • Added
    • Fixed
  • [7.16.1] - 2025-06-24
    • Added
    • Fixed
  • [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