Bouquet Server configuration guide

Bouquet Server is a tomcat webapp. You need to alter the Tomcat start process by adding some system variables in the JAVA_OPTS environment variable.

Please refer to the Installation documentation: it will help you setting all the variables needed.

This documentation covers two type of configuration variables:

Bouquet Server system variables

This table lists mandatory system variables:

Variable Example Explanation
bouquet.config.file
/path/to/bouquet.json

The path to Bouquet Server's main configuration file

kraken.plugin.dir
/path/to/plugins/dir/

The path to the directory that contains JDBC plugins

config.file
/path/to/auth/conf.xml

The path to the Auth webapp's configuration file

kraken.facet
front,keyserver,queries,queryworker
Set the purposes of this Bouquet Server
user.timezone
UTC
We highly recommend you to set this variable to UTC.

This table lists optional system variables:

Variable Example Explanation
DEBUG.MONGO
false

Print mongo communication debug messages

DB.TRACE
false

Print DB communication debug messages

logback.configurationFile
/path/to/logback.xml

The path to Bouquet's Logback conf file

This table lists elasticsearch system variables. You need them if you want to use the embedded/local Elasticsearch engine, instead of an external one:

Variable Example Explanation
es.path.data
/path/to/es/data

The path to the directory where ES writes its indeces

es.network.bind_host
127.0.0.1

host/IP address, which the embedded ES instance must bind to

Bouquet Server configuration file variables

Specify the path to the Bouquet Server configuration file with:

-Dbouquet.config.file=/path/to/config.json

You can find a sample configuration file here. All attributes in this file are mandatory.

This table lists cache clustering configuration variables:

Variable Example Explanation
cache.queriesServerID
{"port": -1,
   "host": "localhost"}

Address and port of the Query Server

cache.generationalKeysServerID
{"port": -1,
   "host": "localhost"}

Address and port of the (unique) generational keys server

cache.redisID
{"port": 6379,
  "host": "localhost"}

Address and port of the redis server

cache.workers
[
   {
     "port": -1,
     "host": "localhost"
   }
]

(Array of) address and ports of available SQL Workers

cache.appName
v4.2

Name of the cluster. Must be the same for all Bouquet Servers in a cluster.

cache.querieServerThreadPoolSize
5

Number of threads in the query server

cache.maxRecord
-1

Not used anymore

cache.ttlInSecond
86400

Cache entries time to live

cache.maxChunkSizeInMByte
50

Size of chunks saved in the redis server. Defaults to 10.

This table lists the mongo connection configuration variables:

Variable Example Explanation
mongo.host
localhost

Address of the mongo server

mongo.port
27017

Listening port of mongo DB

mongo.user
bouquet

User to log into mongo DB

mongo.password
strong(...)password

Password to log into mongo DB

mongo.dbname
bouquet

The name of the mongo database

This table lists email configuration variables. They are used by the Password reset mechanism to ensure that the user can receive an email containing a link to the reset password page:

Variable Example Explanation
mail.hostname
smtp.gmail.com

Address of the authenticated SMTP server

mail.sslPort
465

Listening port of the authenticated SMTP server

mail.senderName
youraccount@gmail.com

TLS SMTP login

mail.senderPassword
pass

Auth password for SMTP server

mail.senderEmail
noreply@yourcompany.com

Mails will come from this email

This table lists API configuration variables:

Variable Example Explanation
krakenWSAPI
release

It's the version of the API.Can be either dev, staging or release.

wsHost
localhost:8080

 

krakenOAuthEndpoint
https://yourcompany.com/release/auth/oauth

URL of the Auth webapp, which Bouquet Server will redirect to

publicBaseUri
https://yourcompany.com/release/v4.2

Public URI of the API, when it's hosted behind a NAT or a reverse-proxy

This table lists misc. variables:

signupEmailBCC

contact@yourcompany.com

 

Variable Example Explanation
serverMode
dev

When set to "dev", Bouquet Server will not check Clients URLs nor authentication

defaultClientURL
localhost,127.0.0.1

The URLs that will be allowed by default by a newly created Customer

     
elasticLocal
true

Use the embedded elasticsearch

 

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.