Configrutions

Database Configuration

Datasherlock offers support for all major databases. Choose the database type that suits your application's requirements and configure it accordingly.

Configuration:

MySQL

Configuration

type: "mysql"
database:
  host: "<DB_HOST>"
  username: "<DB_USERNAME>"
  port: "<DB_PORT>"
  database: "<DB_NAME>"
  ssl: "<DB_SSL>" 

Configuration Options

• host : Your database host URL

• username : Your Database Username

• port : Your Database Password, default 3306

• database : "Your Database name"

• ssl : "SSL is enabled or disable (true, false)"

PostgresSQL

Configuration

type: "postgres"
database:
  host: "<DB_HOST>"
  username: "<DB_USERNAME>"
  port: "<DB_PORT>"
  database: "<DB_NAME>"
  ssl: "<DB_SSL>" 

Configuration Options

• host : Your database host URL

• username : Your Database Username

• port : Your Database Password, default 5432

• database : "Your Database name"

• ssl : "SSL is enabled or disable (enable, disable)"

BigQuery

Configuration

type: "bigquery"
database:
  database: "<DB_NAME>"
  project_id: "<GCP_PROJECT_ID>" 

Configuration Options

• database : "Your Database name"

• project_id : GCP Project id

SnowFlake

Configuration

type: "snowflake"
database:
  database: "<DB_NAME>"
  username: "<SNOWFLAKE_USERNAME>"
  account: "<SNOW_FLAKE_ACCOUNT>"
  warehouse: "<SNOW_FLAKE_WAREHOUSE>"
  schema: "<SNOW_FLAKE_SCHEMA>"

Configuration Options

• database : "Your Database name"

• account : "Only used for snowflake account"

• warehouse : "Only used for snowflake warehouse"

• schema : "Only used for snowflake schema name"

• username : Your Database Username

MsSQL

Configuration

type: "mssql"
database:
  host: "<DB_HOST>"
  username: "<DB_USERNAME>"
  port: "<DB_PORT>"
  database: "<DB_NAME>"

Configuration Options

• host : Your database host URL

• username : Your Database Username

• port : Your Database Password, default 3306

• database : "Your Database name"

Redshift

Configuration

type: "redshift"
database:
  host: "<DB_HOST>"
  username: "<DB_USERNAME>"
  port: "<DB_PORT>"
  database: "<DB_NAME>"
  ssl: "<DB_SSL>" 

Configuration Options

• host : Your database host URL

• username : Your Database Username

• port : Your Database Password, default 443

• database : "Your Database name"

Single Sign-On (SSO) Configuration

Integrate Single Sign-On (SSO) functionality into Datasherlock using the following configuration parameters:

Configure your chosen SSO, such as OKTA or Google. Here's an example with Google Cloud Console:

• Create an OAuth client ID in your Google Cloud project (e.g., API Console) - choose "Web application" type.

• Set your app's origins and redirect URLs: where Google can send users after login.

• Grab your client ID and client secret: store them securely, they're your keys to Google SSO.

Redirect URL:

• For Local Testing

http://127.0.0.1:8080/authorization-code/callback

• For Production Deployment

Remote_URL/authorization-code/callback

NOTE: Get the Remote_URL from the dashboard.

Update the Sherlock configuration file with these parameters:

Google

Extend Sherlock config by adding oauth field:

type: <DB_TYPE>
database:
  ....
oauth:  
  client_id: "client_id"
  scopes: ["openid", "profile", "email"]
  provider: "https://accounts.google.com"

Github

oauth:  
  client_id: "client_id"
  scopes: ["openid", "profile", "email"]
  provider: "provider_url"

Replace the client_id given by your Auth provider.

Also add the client_secret provided by the Auth Provider, as an environment variable.

export CLIENT_SECRET="client_secret"

With these configurations in place, Datasherlock can seamlessly connect to your chosen database and offer SSO support for your application.

Use the following command to register an agent with the Datasherlock cloud. It will provide you with a token and a remote link. Make sure to keep these credentials secure.