6. Usage

• 6.1. API
  • 6.1.1. Reference
  • 6.1.2. Authentication
    • 6.1.2.1. JWT Authentication
    • 6.1.2.2. Client Keys
      • 6.1.2.2.1. Creating Client Keys
      • 6.1.2.2.2. Using Client Keys
  • 6.1.3. Submitting Workflow
    • 6.1.3.1. Migrate
  • 6.1.4. Trailing Slashes
• 6.2. Monitoring and Management
  • 6.2.1. systemd service
  • 6.2.2. ngeneahubctl cli tool
  • 6.2.3. Docker containers
  • 6.2.4. Hub Task Metrics
  • 6.2.5. Health endpoints
• 6.3. Custom Workflows
  • 6.3.1. Defining workflows
    • 6.3.1.1. Filter Rules
    • 6.3.1.2. Runtime fields
  • 6.3.2. Running Workflows
    • 6.3.2.1. Discovery Steps
      • 6.3.2.1.1. Discovery Options
  • 6.3.3. Includes and Excludes
• 6.4. Jobs
  • 6.4.1. Housekeeping
• 6.5. Site Sync
  • 6.5.1. Troubleshooting
• 6.6. Bidirectional Site Sync
  • 6.6.1. Schedule
  • 6.6.2. Workflow
  • 6.6.3. Troubleshooting
• 6.7. Search
  • 6.7.1. Submitting a query
    • 6.7.1.1. Filters
  • 6.7.2. Retrieving results
    • 6.7.2.1. Proxies
    • 6.7.2.2. Parameters
    • 6.7.2.3. Merged results
    • 6.7.2.4. Results grouped by name
  • 6.7.3. Max Results
  • 6.7.4. Housekeeping
• 6.8. Controlling Bandwidth Usage
  • 6.8.1. Bandwidth configuration in the UI
  • 6.8.2. Checking Node status
  • 6.8.3. Registering Datastores
    • 6.8.3.1. Cloud IPAddresses
    • 6.8.3.2. Using manual IP addresses
  • 6.8.4. Linking a Datastore to a Site
  • 6.8.5. Applying the bandwidth
• 6.9. Configuration
  • 6.9.1. Global Configurations
    • 6.9.1.1. Available Settings
    • 6.9.1.2. REST API
    • 6.9.1.3. Settings Migration
  • 6.9.2. Site-specific Configurations
    • 6.9.2.1. Available Settings
      • 6.9.2.1.1. File Batching
      • 6.9.2.1.2. Dynamic File Batching
    • 6.9.2.2. REST API
• 6.10. Certificate Lifetime
  • 6.10.1. Viewing the Certificate Lifetime
  • 6.10.2. Modifying the Certificate Lifetime
  • 6.10.3. Summary
• 6.11. Feature Flags
  • 6.11.1. REST API
  • 6.11.2. ngclient
• 6.12. Actions
  • 6.12.1. Available Actions
    • 6.12.1.1. discover_nodes
  • 6.12.2. REST API
• 6.13. Limitations
  • 6.13.1. Site Sync
    • 6.13.1.1. Site Sync must only be used in one direction
    • 6.13.1.2. Site Sync only considers changes within an applicable time window for synchronisation
    • 6.13.1.3. Site Sync supports Independent Filesets
    • 6.13.1.4. Destination site Independent Filesets must exist prior to synchronisation
    • 6.13.1.5. Directory deletion is not supported
  • 6.13.2. Bidirectional Site Sync
    • 6.13.2.1. Bidirectional Site Sync implements eventual consistency
    • 6.13.2.2. Bidirectional Site Sync is only supported via schedules
    • 6.13.2.3. Bidirectional synchronisation is sequential
    • 6.13.2.4. Swapping files / Last write wins
    • 6.13.2.5. Renaming or deleting files and directories causes re-sending of data
    • 6.13.2.6. Renaming or files and directories on both bidirectional Site Sync sites causes duplication of data
    • 6.13.2.7. Creation or deletion of empty directories on site 1 does not synchronise to site 2