Standard Configuration

The following provides all possible configuration variables and their default values. You may need to consult the additional variables below if an advanced configuration is needed.

The default .env contains just the required configuration variables.

vectr-community.env

# .env file

APP_NAME=VECTR

VECTR_HOSTNAME=sravectr.internal
VECTR_PORT=8081

# defaults to warn, debug useful for development
VECTR_CONTAINER_LOG_LEVEL=WARN

# If you supply a username:password in the URL, it will get overridden by MONGO_INITDB_ROOT_USERNAME and MONGO_INITDB_ROOT_PASSWORD
MONGO_URL=mongodb://vectr-mongo:27017/?authSource=admin

# MongoDB authentication username
MONGO_INITDB_ROOT_USERNAME=admin

# Change and store in a safe place
MONGO_INITDB_ROOT_PASSWORD=Test1234

# PLEASE change this and store it in a safe place.  Encrypted data like passwords
# to integrate with external systems (like TAXII) use this key
VECTR_DATA_KEY=CHANGEMENOW

# JWT signing (JWS) and encryption (JWE) keys
# Do not use the same value for both signing and encryption!
# It is recommended to use at least 16 characters. You may use any printable unicode character
# PLEASE change these example values!
JWS_KEY=WSӠ$8É*X&*8HѲk!^£
JWE_KEY=VПlδ4x%vЋs$fIT@b€

# This sets the name of your project.  Will show up in the name of your containers.
COMPOSE_PROJECT_NAME=sandbox1

# This is where the mongodb mounts.
VECTR_DATA_DIR=/var/data/

Required Variables:

APP_NAME - This is the "name" displayed by the application at the login screen.

VECTR_HOSTNAME - Hostname used by VECTR. Used to generate self signed certs if certs aren't provided.

VECTR_PORT - The port on which the VECTR docker Tomcat container listens for HTTPS connections, defaults to 8081.

VECTR_CONTAINER_LOG_LEVEL - Log level for container scripts. This is set to Warn by default. Change to DEBUG if additional logging is needed.

MONGO_URL - The MongoDB connection URI. See the MongoDB docs for more details on connection string format. https://docs.mongodb.com/manual/reference/connection-string/

MONGO_INITDB_ROOT_USERNAME - The default root username for mongodb when it is first initalized.

MONGO_INITDB_ROOT_PASSWORD - Root password set for the login of the mongodb database

VECTR_DATA_KEY - The key that is used for site-wide data encryption, for example encrypting 3rd party external service secrets/passwords.

JWS_KEY - The key that is used for JWT signing.

JWE_KEY - The key that is used for JWT payload encryption.

COMPOSE_PROJECT_NAME - This determines the container naming scheme.

VECTR_DATA_DIR - This is the location where VECTR's mongo database will persist its data.

Optional Variables

VECTR_EXTERNAL_HOSTNAME - If your VECTR installation is sitting behind a proxy or load balancer and HTTP hostname header is not forwarded, set this to the value of your external facing domain name.

VECTR_EXTERNAL_PORT - If your VECTR installation is sitting behind a proxy or load balancer and HTTP port header is not forwared and you are using a non-standard HTTPS port, set this to the value of the external facing port.

CA_PASS - If providing a certificate which requires a password enter it here. For details see SSL Configuration.