Any YAML file placed in this directory will automatically be added to the configuration. Files are read in alphabetical order. The parameters are updated using the following rules:
- If no parameter with this name exists, it is added
- If a parameter with this name already exists and
- both are lists, they are concatenated
- both are objects, they are merged
- neither of the previous is true, it is overwritten.
(Changed in version 1.2: The old, direct, configuration of the python logging has been removed.)
Options regarding logging can be specified in the logging object. Currently only the log levels can be adjusted.
Possible parameters:
level(intorstring, default:WARNING): Default log level (possible values areDEBUG,INFO,WARNING,ERRORandCRITICAL)loggers(object, default:{}): Associative array containing options for specific loggers
Parameters necessary to make the grommunio-chat management work can be configured in the chat object.
Possible parameters:
connection(object): Parameters for connecting to the grommunio-chat API. See Mattermost Driver for possible parameters.
Parameters necessary for database connection can be configured by the DB object.
Possible parameters:
user(string): User for database accesspass(string): Password for user authenticationdatabase(string): Name of the database to connect tohost(string, default:127.0.0.1): Host the database runs onport(int, default:3306): Port the database server runs onsessionTimeout(int, default:28800): Time in seconds after which database connection closed by the server and a new one is needed
The behavior of the OpenAPI validation can be configured by the openapi object.
Possible parameters:
validateRequest(boolean, default:true): Whether request validation is enforced. If set totrue, an invalid request will generate a HTTP 400 response. If set tofalse, the error will only be logged, but the request will be processed.validateResponse(boolean, default:true): Whether response validation is enforced. If set totrue, an invalid response will be replaced by a HTTP 500 response. If set tofalse, the error will only be logged and the invalid response is returned anyway.
grommunio-admin can provide access to journald logs through the API. Accessible log files can be configured in the logs object.
Each entry in the logs object describes a log file. The name of the entry is the name used to access the file through the API.
Possible parameters for each entry:
source(string, required): Name of the systemd unit
Some configurations can be managed by grommunio-admin. Parameters can be configured by the mconf object.
Possible parameters:
fileUid(stringorint): If set, change ownership of created configuration files to this user. Defaults tooptions.fileUidif omittedfileGid(stringorint): If set, change ownership of created configuration files to this group. Defaults tooptions.fileGidif omittedfilePermissions(int): If set, change file permissions of created configuration files to this bitmask. Defaults tooptions.filePermissionsif omittedldapPath(string): Path to the LDAP configuration fileauthmgrPath(string): Path to the authmgr configuration file
Parameters regarding security and authentication can be configured by the security object.
Possible parameters:
jwtPrivateKeyFile(string, default:res/jwt-privkey.pem): Path to the private RSA key filejwtPublicKeyFile(string, default:res/jwt-pubkey.pem): Path to the public RSA key file
Some parameters determining how grommunio-admin connects to grommunio-sync can be adjusted in the sync object.
Possible parameters:
host(string, default127.0.0.1): Host running the Redis instanceport(int, default6379): Port the Redis instance is listening ondb(string, default0): Name of the Redis databasepassword(string, default ``): Password to connect withtopTimestampKey(string, defaultgrommunio-sync:topenabledat): Key to write the current timestamp totopdataKey(string, defaultgrommunio-sync:topdata): Key containing the top data hashtopExpireEnded(int, default20): Time (in seconds) after which ended processes are removedtopExpireUpdate(int, default120): Time (in seconds) since the last update after which processes are removedsyncStateFolder(string, defaultGS-SyncState): Sub-folder containing the device sync statespolicyHosts(list of strings, default["127.0.0.1", "localhost"]): List of hosts that have unauthenticated access to user policiesdefaultPolicy(object): Overrides for the default Active Sync policy. For available values and defaults seeres/config.yaml.
The TasQ server can be configured with the tasq object.
Possible parameters:
disabled(boolean, default:false): Disable automatic startupworkers(integer, default:1): Number of workers to start
Further parameters can be set in the options object:
dataPath(string, default:/usr/share/grommunio/common): Directory where shared resources used by grommunio modules are storedportrait(string, default:admin/api/portrait.jpg): File containing the default portrait image, relative todataPathdomainStoreRatio(int, default:10): Mysterious storage factor fordomain.maxSizedomainPrefix(string, default:/d-data/): Prefix used for domain exmdb connectionsuserPrefix(string, default:/u-data/): Prefix used for user exmdb connectionsexmdbHost(string, default:::1): Hostname of the exmdb service providerexmdbPort(string, default:5000): Port of the exmdb service providerfileUid(stringorint): If set, change ownership of created files to this userfileGid(stringorint): If set, change ownership of created files to this groupfilePermissions(int): If set, change file permissions of any created files to this bitmaskantispamUrl(string, default:http://localhost:11334): URL of the grommunio-antispam backendantispamEndpoints(list of strings, default:["stat", "graph", "errors"]): List of allowed endpoints to proxy to grommunio-antispamvhosts(object, default:{}): Name -> URL mapping of nginx VHost status endpoints