/
    • Siren Federate
      • Introduction
        • The reflection of external databases
        • A distributed join between indices
        • Join query cache
      • Architecture
        • Distributed Join Workflow
        • Query Planning and Optimisation
        • IO
      • Getting Started
        • Installing the Siren Federate Plugin
        • Starting Elasticsearch
        • Loading Some Relational Data
        • Relational Querying of the Data
      • Setting up Siren Federate
        • Configuring logging
        • Configuring off-heap memory
        • Configuring security
          • Configuring Search Guard
          • Configuring Elastic Stack Security
        • Configuring joins by type
        • Disabling Federate
      • Federate Modules
        • Planner
        • Memory
        • IO
        • Thread Pools
        • Query Cache
      • Search APIs
        • Search API
        • Multi Search API
        • Search Request
        • Search Response
        • Cancelling a request
        • Validating a request
      • Query DSL
        • Join query
        • Extended join condition syntax
        • Multi-conditional join
        • Project fields
        • Federate Object Runtime Field
      • Paginating a Search
      • Joining your data
        • Join based on the metadata field _id
        • Join based on a runtime field
        • Join based on a composite key
        • Retrieving a projected field
        • Retrieving a runtime field
        • Projecting and retrieving fields of a nested data type
        • Filter using a projected field
        • Sorting based on a projected field
        • Spatial join using range fields
        • Spatial join using simple fields
        • Handling missing fields
        • Scoring capabilities
        • Document Score
        • Scoring based on a projected field
        • Aggregating based on a projected field
        • Data example for company and person indices
      • Known limitations
      • Cluster APIs
        • Nodes Statistics
      • Index APIs
      • Sessions APIs
        • Get Sessions
        • Clear Sessions
      • License APIs
        • Put License
        • Get License
        • Delete License
      • Siren Consolidator
      • Performance Considerations
      • Troubleshooting
      • Release Notes
      • Glossary
Siren Federate 37.0
  • Siren ER
    • 2.0.0
  • Siren Federate
    • 37.0
    • 36.2
    • 35.1
    • 34.1
    • 33.2
    • 32.1
    • 31.2
    • 30.1
    • 29.2
    • 28.1
    • 27.4
    • 26.5
    • 25.3
    • 24.0
    • 23.0
    • 22.5
    • 21.6
    • 20.2
  • Siren NLP
    • 0.5.1
  • Siren Platform
    • 14.4
    • 14.3
    • 14.2
    • 14.1
    • 14.0
    • 13.5
    • 13.4
    • 13.3
      /  
  • Siren Federate
  • Setting up Siren Federate
37.0 36.2 35.1 34.1 33.2 32.1 31.2 30.1 29.2 28.1 27.4 26.5 25.3 24.0 23.0 22.5 21.6 20.2

Setting up Siren Federate

After Siren Federate is installed, you must configure it for your organization’s needs.

The following sections include examples to ensure that you get started with Siren Federate as quickly as possible.

In this section

Configuring logging

Configuring off-heap memory

Configuring security

fdef::output-html[Configuring joins by type]

Disabling Federate

Copyright © 2020 - Siren.