Saga Configuration

The Saga configuration can be use for the core library only or with the server, all the features available for the core library will work in the server, but the features for the server 

Server Access

• (server only)  apiPort ( type=integer | default=8080 | optional ) - Port of the Saga server
• (server only)  ipAddress ( type=string | default=0.0.0.0 | optional ) - Ip address the server will be listening for request

Security 

• security ( type=json | optional ) - Security configuration
  
  • encryptionKey ( type=string | optional ) - Indicates the encryption key used in all encryption/decryption process

  • encryptionKeyFile ( type=string | optional ) - Path to the file holding the encryption key. Recommended over encryptionKey

    We recommend the use of encryptionKeyFile over the encriptionKey directly in the configuration file. Never use both a the same time

  • (server only)  users ( type=json | optional ) - User profiles definitions, an array of json objects, each one representing a user
    • (server only)  username ( type=string | optional ) - user account
    • (server only)  password ( type=string | optional ) - User password
    • (server only)  roles ( type=string array | optional ) - User roles (not yes in use)
• (server only)  ssl ( type=json | optional ) - SSL configuration
  • (server only)  enable ( type=boolean | default=false | optional ) - Enables and disables the use of the SSL
  • (server only)  keyStore ( type=string | optional ) - key store holding the certificate
  • (server only)  keyStorePassword ( type=string | optional ) - Password of the key store

Export & Import

• (server only)  exportSettings ( type=json | optional ) - Configuration for the export functionality
  • (server only)  maxSize ( type=integer | optional ) - Maximum size in megabytes for each zip generated by the export
  • (server only)  batchSize ( type=integer | optional ) - Quantity of entries per file

External Libraries & Classes

• libraryJars ( type=string array | optional ) - Locations for external libraries, the locations can be either folder paths or paths directly to the jars files
• (server only)  restHandlers ( type=string array | optional ) - Indicates the class name of the external REST handler to use. If the class is in a non-standard package path, the whole path needs to be specified
• (server only)  models ( type=string array | optional ) - Indicates the class name of the external Model to use. If the class is in a non-standard package path, the whole path needs to be specified
• (server only)  gpt3 ( type=string | optional ) - Configuration for the GTP3 proxy
  • (server only)  key ( type=string | optional ) - Secret key for the OpenAI API

Providers & Resources

• providers ( type=json | optional ) - Provider configurations
  • name ( type=string | optional )
  • type ( type=string | optional )
• tagManager ( type=json | optional ) - Tag manager configuration
  • resource ( type=string | default=saga-provider:saga_tags | optional ) - Name of the resource to use for the tags. The value should be form by "<provider_name>:<source_name>"
• pipelineManager ( type=json | optional )
  • resource ( type=string | default=saga-provider:saga_pipelines | optional ) - Name of the resource to use for the pipelines. The value should be form by "<provider_name>:<source_name>"
• solutions ( type=json | optional )

{
  "config": {
    "apiPort": 8080,
    "ipAddress": "0.0.0.0",
    "security": {
      "enable": false,
      "encryptionKey": "SDFW$%GW$S%S#",
      "encryptionKeyFile": "./bin/saga.ek",
      "users": [{
        "username": "admin",
        "password": "password",
        "roles": "admin"
      }]
    },
    "libraryJars": [
      "./lib"
    ],
    "tagManager": {
      "resource": "saga-provider:saga_tags"
    },
    "pipelineManager": {
      "resource": "saga-provider:saga_pipelines"
    },
    "datasetFolder": "./datasets",
    "ssl": {
      "enable": false,
      "keyStore": "./bin/saga.jks",
      "keyStorePassword": "encrypted:NxepNROIgJ27pYpmKEw30llscPA8zCUpbQW676E7H8Nwo9DMABKQsIYF3fcSxQGG"
    },
    "exportSettings" : {
      "maxSize" : 40,
      "batchSize" : 5000
    },
    "restHandlers": [],
    "models": [],
    "uiHandlers": [],
    "gpt3": {
      "key": "encrypted:7E7nI0+ofh//r1bFvTQCnY7DQlG6Kh4aA1TQlh44/NoxR0DDzHaeZdBXqYAguEXc"
    },
    "providers": [
      {
        "name": "filesystem-provider",
        "type": "FileSystem",
        "baseDir": "./config"
      },
      {
        "name": "saga-provider",
        "type": "Elastic",
        "scheme": "http",
        "hostname": "localhost",
        "port": 9200,
        "timestamp": "updatedAt",
        "exclude": [
          "updatedAt",
          "createdAt"
        ]
      }
    ],
    "solutions": [
      {
        "display": "Saga",
        "elasticSearch": {
          "scheme": "http",
          "hostname": "localhost",
          "port": 9200,
          "indexName": "saga",
          "timeout": 30,
          "delay": 5,
          "retries": 3
        }
      }
    ]
  }
}

Saga Server Configuration

{
  "config": {
    

    "security": {
      
    },
    
  }
}