Environment Variables#

The following environment variables are available for use in the connector:

CENSYS_API_KEY#

Your Censys ASM API key found in the ASM Integrations Page. (Required)

PROVIDERS_CONFIG_FILE#

The path to Provider Configuration.

Default: ./providers.yml

SECRETS_DIR#

The path to the directory containing the secrets.

Default: ./secrets

LOGGING_LEVEL#

The logging level. Valid values are DEBUG, INFO, WARN, ERROR, and CRITICAL.

Default: INFO

DRY_RUN#

If set to true, the connector will not write any data to the ASM platform.

Default: false

HEALTHCHECK_ENABLED#

If set to false, the connector will not report its health to the ASM platform.

Default: true

Sample .env File#

.env.sample is a sample file that contains the above environment variables. Please use this file as a template to create your own .env file.

CENSYS_API_KEY=your-censys-api-key-here-xxxxxxxxxxx
SECRETS_DIR=./secrets
PROVIDERS_CONFIG_FILE=./providers.yml
LOGGING_LEVEL=INFO
DRY_RUN=false
HEALTHCHECK_ENABLED=true

# Censys API Settings
# CENSYS_ASM_API_BASE_URL=https://app.censys.io/api
# CENSYS_COOKIES={"key": "value"}