Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

...

Control the server's basic communication configuration

  • Parameter
    summaryPort of the Saga server
    default8080
    nameapiPort
    typeinteger
    (server only) 
  • Parameter
    summaryIp address the server will be listening for request
    default0.0.0.0
    nameipAddress

Security 

Manages the security configuration regarding encrypted communication and authentication

  • Parameter
    summarySecurity configuration
    namesecurity
    typejson

    • Parameter
      summaryIndicates the encryption key used in all encryption/decryption process
      nameencryptionKey
    • Parameter
      summaryPath to the file holding the encryption key. Recommended over encryptionKey
      nameencryptionKeyFile

      Note

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

    • (server only) 
      Parameter
      summaryUser profiles definitions, an array of json objects, each one representing a user
      nameusers
      typejson
      • (server only) 
        Parameter
        summaryuser account
        nameusername
      • (server only) 
        Parameter
        summaryUser password
        namepassword
      • (server only) 
        Parameter
        summaryUser roles
        nameroles
        typestring array
         (not in use yet)
  • (server only) 
    Parameter
    summarySSL configuration
    namessl
    typejson
    • (server only) 
      Parameter
      summaryEnables and disables the use of the SSL
      defaultfalse
      nameenable
      typeboolean
    • (server only) 
      Parameter
      summarykey store holding the certificate
      namekeyStore
    • (server only) 
      Parameter
      summaryPassword of the key store
      namekeyStorePassword

Export & Import

Manages the export functionality

  • (server only) 
    Parameter
    summaryConfiguration for the export functionality
    nameexportSettings
    typejson
    • (server only) 
      Parameter
      summaryMaximum size in megabytes for each zip generated by the export
      namemaxSize
      typeinteger
    • (server only) 
      Parameter
      summaryQuantity of entries per file
      namebatchSize
      typeinteger

External Libraries & Classes

Defines the location of external libraries and classes 

  • Parameter
    summaryLocations for external libraries, the locations can be either folder paths or paths directly to the jars files
    namelibraryJars
    typestring array
  • (server only) 
    Parameter
    summaryIndicates 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
    namerestHandlers
    typestring array
  • (server only) 
    Parameter
    summaryIndicates 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
    namemodels
    typestring array

Proxys Configuration

  • (server only) 
    Parameter
    summaryConfiguration for the GTP3 proxy
    namegpt3
    • (server only) 
      Parameter
      summarySecret key for the OpenAI API
      namekey

...