...
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 |
---|
summary | Port of the Saga server |
---|
default | 8080 |
---|
name | apiPort |
---|
type | integer |
---|
|
(server only) Parameter |
---|
summary | Ip address the server will be listening for request |
---|
default | 0.0.0.0 |
---|
name | ipAddress |
---|
|
Security
Manages the security configuration regarding encrypted communication and authentication
Parameter |
---|
summary | Security configuration |
---|
name | security |
---|
type | json |
---|
|
Parameter |
---|
summary | Indicates the encryption key used in all encryption/decryption process |
---|
name | encryptionKey |
---|
|
Parameter |
---|
summary | Path to the file holding the encryption key. Recommended over encryptionKey |
---|
name | encryptionKeyFile |
---|
|
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 |
---|
summary | User profiles definitions, an array of json objects, each one representing a user |
---|
name | users |
---|
type | json |
---|
|
- (server only)
Parameter |
---|
summary | user account |
---|
name | username |
---|
|
- (server only)
Parameter |
---|
summary | User password |
---|
name | password |
---|
|
- (server only)
Parameter |
---|
summary | User roles |
---|
name | roles |
---|
type | string array |
---|
|
(not in use yet)
- (server only)
Parameter |
---|
summary | SSL configuration |
---|
name | ssl |
---|
type | json |
---|
|
- (server only)
Parameter |
---|
summary | Enables and disables the use of the SSL |
---|
default | false |
---|
name | enable |
---|
type | boolean |
---|
|
- (server only)
Parameter |
---|
summary | key store holding the certificate |
---|
name | keyStore |
---|
|
- (server only)
Parameter |
---|
summary | Password of the key store |
---|
name | keyStorePassword |
---|
|
Export & Import
Manages the export functionality
- (server only)
Parameter |
---|
summary | Configuration for the export functionality |
---|
name | exportSettings |
---|
type | json |
---|
|
- (server only)
Parameter |
---|
summary | Maximum size in megabytes for each zip generated by the export |
---|
name | maxSize |
---|
type | integer |
---|
|
- (server only)
Parameter |
---|
summary | Quantity of entries per file |
---|
name | batchSize |
---|
type | integer |
---|
|
External Libraries & Classes
Defines the location of external libraries and classes
Parameter |
---|
summary | Locations for external libraries, the locations can be either folder paths or paths directly to the jars files |
---|
name | libraryJars |
---|
type | string array |
---|
|
- (server only)
Parameter |
---|
summary | 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 |
---|
name | restHandlers |
---|
type | string array |
---|
|
- (server only)
Parameter |
---|
summary | 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 |
---|
name | models |
---|
type | string array |
---|
|
Proxys Configuration
- (server only)
Parameter |
---|
summary | Configuration for the GTP3 proxy |
---|
name | gpt3 |
---|
|
- (server only)
Parameter |
---|
summary | Secret key for the OpenAI API |
---|
name | key |
---|
|
...