[DOCS-11013] Provide an example configuration file for BI Connector Created: 14/Nov/17  Updated: 29/Oct/23  Resolved: 21/Nov/17

Status: Closed
Project: Documentation
Component/s: BI Connector
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: Major - P3
Reporter: Rachelle Palmer Assignee: Steve Renaker (Inactive)
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 6 years, 13 weeks, 1 day ago
Story Points: 0.25

 Description   

https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#config-format

This page provides all the fields that need to be configured but customers will likely find it more helpful to have a file they can use as an example (or copy and modify).

We should probably provide example configuration file with build, with comments helping explain the two different connections as well as when authentication/encryption needed. We may also want to include an example that is Atlas specific.



 Comments   
Comment by Rachelle Palmer [ 14/Nov/17 ]

Sure this is terrific!

Comment by Bryan Reinero [ 14/Nov/17 ]

rachelle.palmer Good idea! Here is an example configuration I use for my own test instance for mongosqld. Embedding the config in the build (as a part of the installer) is a good idea too but should be tracked as as BI ticket

systemLog:
  logAppend: false
  path: /var/log/mongosqld/mongosqld.log
  verbosity: vv
 
security:
  enabled: true
 
mongodb:
  net:
    uri: 10.11.12.13:27017
    auth:
      username: "root"
      password: "changeme"
 
net:
  bindIp: 10.11.12.13
  port: 3307
  ssl:
    mode: "allowSSL"
    PEMKeyFile: "/vagrant/certificates/mongosqld-server.pem"
    CAFile: "/vagrant/certificates/ca.crt"
 
schema:
  path: "/etc/mongosqld/schema/"
 
processManagement:
  service:
    name: mongosqld
    displayName: mongosqld
    description: "BI Connector SQL proxy server"

Generated at Thu Feb 08 08:01:52 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.