Blackfynn Configuration File

NOTE: The recommended way for managing settings is using the Blackfynn Command Line Tool (http://help.blackfynn.com/developers/client-tools/developer-documentation-the-blackfynn-agent )

Blackfynn stores settings and connection information in your Blackfynn configuration file. Advanced users might want to edit their Blackfynn configuration file directly for control of the client libraries.

This document outlines the configuration options shared between the various clients. For additional options specific to each client, see the relevant documentation:

  1. Python client https://developer.blackfynn.io/python/latest/configuration.html

Location

Your configuration file is located in your .blackfynn directory. The .blackfynn directory is found in the $HOME directory (Mac/Linux) or the User directory (Windows).

Full path: $HOME/.blackfynn/config.ini

Format

The config file is in INI <https://en.wikipedia.org/wiki/INI_file>_ format. There are three types of sections: [global], [agent], and [<profile>]. You can have as many [<profile>] sections as you want

Example of the config.ini file:

# Global settings

    [global]

    default_profile = default

    # Profiles

    [default]

    api_token =  xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

    api_secret = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

    [debug_mode]

    use_cache = true

    api_token = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

    api_secret = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

    [super_conn]

    api_token = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

    api_secret = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

    # Settings for the Blackfynn CLI Agent

    [agent]

    uploader = true

    cache_page_size = 100000

    cache_soft_cache_size = 5000000000

    proxy_local_port = 8080

    timeseries_local_port = 9090

    proxy = true

    ...

Environment Variables

It is also possible to set configuration options using environment variables

Note: Environment variables (if present) override any profile-defined settings in your Blackfynn Configuration File. They are useful for terminal-specific settings.

To switch between profiles in a given terminal session, set the environment variable:

    BLACKFYNN_PROFILE="your profile name" 

Alternatively, you can specify your token/secret directly:

    BLACKFYNN_API_TOKEN="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" 

    BLACKFYNN_API_SECRET="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" 

To control the verbosity of the client's logging, set `BLACKFYNN_LOG_LEVEL`:

    BLACKFYNN_LOG_LEVEL=("DEBUG" or "INFO" or "WARN" or "ERROR") 

Did this answer your question?