Skip to content
This repository was archived by the owner on Jul 16, 2024. It is now read-only.

0.1.2 Environment Variables

James.E.Bell edited this page Sep 21, 2017 · 1 revision

Environment Variables

A way of life

In order to make GREASE more cross-platform friendly and flexible in its' implementation. Below is a maintained list of required and optional variables GREASE interacts with on your system.

Required

  • GREASE_DSN: This string is the DSN (database connection string) for GREASE to talk to its' database. If this is not filled out you will receive exceptions when a blank connection string is presented to the psycopg2 connector
  • GREASE_CONF_PKG: This string is the Python Package name used by the system to load command configurations from
  • GREASE_CONF_DIR: This string is the directory in the GREASE_CONF_DIR to load the configurations from
  • GREEASE_SOURCES_PKG: This string provides the python package to load scanners from

Optional

Note: For MongoDB while it is optional, source deduplication will only be enabled if Mongo is available for GREASE

  • GREASE_LOG_FILE: This optional string is a path to a supported Python logging configuration file. If not found or not set then GREASE will default to logging in <FILESYSTEM ROOT>/grease/grease.log
  • GREASE_THROTTLE: This optional integer will rate limit execution on the server. (How many times per second to poll for jobs)
  • GREASE_MONGO_HOST: This (along with the other Mongo variables) will enable connections to MongoDB in GREASE
  • GREASE_MONGO_PORT: Optional, defaults to 27017
  • GREASE_MONGO_USER: MongoDB username. If this and password are provided then Mongo Authentication will be preferred over raw mongo connections
  • GREASE_MONGO_PASSWORD: MongoDB Password
  • GREASE_MONGO_DB: Optional DB other than grease to connect to
  • GREASE_DEDUP_SCORE: DeDuplication Score that if less than, a record will be deemed unique
  • GREASE_DEDUP_INSPECTION_STRENGTH: This int will provide how deep of an inspection into the field geometry of the deduplication logic (default is 100)
  • GREASE_SOURCE_FOCUS: If the server is assigned to sourcing, this optional assignment will focus a server only on its' configured source and drop all other configured sources
  • GREASE_VERBOSE_LOGGING: This variable is only observed to be in existence. If it is found, verbose debug messages will be logged

Clone this wiki locally