5. Usage

• 5.1. Web Interface
  • 5.1.1. Authentication
    • 5.1.1.1. Login
    • 5.1.1.2. Logout
  • 5.1.2. Browser
    • 5.1.2.1. Recent Jobs
    • 5.1.2.2. Search
      • 5.1.2.2.1. Managing the search filters from the dialog
      • 5.1.2.2.2. Submitting the search and viewing search results
      • 5.1.2.2.3. Advanced usage: Managing the search filters from the search bar
    • 5.1.2.3. Browse Directories
      • 5.1.2.3.1. Migrate
      • 5.1.2.3.2. Premigrate
      • 5.1.2.3.3. Recall
      • 5.1.2.3.4. Send
  • 5.1.3. Jobs
    • 5.1.3.1. Pagination
    • 5.1.3.2. Apply Filter
    • 5.1.3.3. Job ID
    • 5.1.3.4. Owner
  • 5.1.4. Administration
    • 5.1.4.1. Sites
      • 5.1.4.1.1. Add Site
      • 5.1.4.1.2. Delete Site
    • 5.1.4.2. Users
      • 5.1.4.2.1. Add User
      • 5.1.4.2.2. Activate User
      • 5.1.4.2.3. Deactivate User
    • 5.1.4.3. File Status Types
• 5.2. API
  • 5.2.1. Reference
  • 5.2.2. Authentication
    • 5.2.2.1. JWT Authentication
    • 5.2.2.2. Client Keys
      • 5.2.2.2.1. Creating Client Keys
      • 5.2.2.2.2. Using Client Keys
  • 5.2.3. Submitting Workflow
    • 5.2.3.1. Migrate
  • 5.2.4. Trailing Slashes
• 5.3. Monitoring and Management
  • 5.3.1. systemd service
  • 5.3.2. ngeneahubctl cli tool
  • 5.3.3. Docker containers
  • 5.3.4. Hub Task Metrics
  • 5.3.5. Health endpoints
    • 5.3.5.1. }
    • 5.3.5.2. }
• 5.4. Custom Workflows
  • 5.4.1. Defining workflows
    • 5.4.1.1. Filter Rules
    • 5.4.1.2. Runtime fields
  • 5.4.2. Running Workflows
    • 5.4.2.1. Discovery Steps
      • 5.4.2.1.1. Discovery Options
  • 5.4.3. Includes and Excludes
• 5.5. Jobs
  • 5.5.1. Housekeeping
• 5.6. Site Sync
  • 5.6.1. Schedule
  • 5.6.2. Workflow
  • 5.6.3. Additional Options
  • 5.6.4. Troubleshooting
• 5.7. Bidirectional Site Sync
  • 5.7.1. Schedule
  • 5.7.2. Workflow
  • 5.7.3. Troubleshooting
• 5.8. Search
  • 5.8.1. Submitting a query
    • 5.8.1.1. Filters
  • 5.8.2. Retrieving results
    • 5.8.2.1. Proxies
    • 5.8.2.2. Parameters
    • 5.8.2.3. Merged results
    • 5.8.2.4. Results grouped by name
  • 5.8.3. Max Results
  • 5.8.4. Housekeeping
• 5.9. Controlling Bandwidth Usage
  • 5.9.1. Enabling the bandwidth feature in the UI
  • 5.9.2. Checking Node status
  • 5.9.3. Registering Datastores
    • 5.9.3.1. Cloud IPAddresses
    • 5.9.3.2. Using manual IP addresses
  • 5.9.4. Linking a Datastore to a Site
  • 5.9.5. Applying the bandwidth
• 5.10. Configuration
  • 5.10.1. Global Configurations
    • 5.10.1.1. Available Settings
    • 5.10.1.2. REST API
    • 5.10.1.3. Settings Migration
  • 5.10.2. Site-specific Configurations
    • 5.10.2.1. Available Settings
      • 5.10.2.1.1. File Batching
      • 5.10.2.1.2. Dynamic File Batching
    • 5.10.2.2. REST API
• 5.11. Certificate Lifetime
  • 5.11.1. Viewing the Certificate Lifetime
  • 5.11.2. Modifying the Certificate Lifetime
  • 5.11.3. Summary
• 5.12. Feature Flags
  • 5.12.1. Available Features
  • 5.12.2. REST API
  • 5.12.3. ngclient
• 5.13. Actions
  • 5.13.1. Available Actions
    • 5.13.1.1. discover_nodes
  • 5.13.2. REST API
• 5.14. Limitations
  • 5.14.1. Site Sync
    • 5.14.1.1. Site Sync must only be used in one direction
    • 5.14.1.2. Site Sync only considers changes within an applicable time window for synchronisation
    • 5.14.1.3. Site Sync supports Independent Filesets
    • 5.14.1.4. Destination site Independent Filesets must exist prior to synchronisation
    • 5.14.1.5. Directory deletion is not supported
  • 5.14.2. Bidirectional Site Sync
    • 5.14.2.1. Bidirectional Site Sync implements eventual consistency
    • 5.14.2.2. Bidirectional Site Sync is only supported via schedules
    • 5.14.2.3. Bidirectional synchronisation is sequential
    • 5.14.2.4. Swapping files / Last write wins
    • 5.14.2.5. Renaming or deleting files and directories causes re-sending of data
    • 5.14.2.6. Renaming or files and directories on both bidirectional Site Sync sites causes duplication of data
    • 5.14.2.7. Creation or deletion of empty directories on site 1 does not synchronise to site 2