.env

# Example dotenv file for Golismero.

##############################################
## Please do not use this in production !!! ##
##############################################

# MongoDB connection details.
MONGO_USERNAME=root
MONGO_PASSWORD=root
MONGO_URL=mongodb://root:root@localhost:27017/

# MySQL connection details.
SQL_DATABASE=golismero
SQL_ROOT_PASSWORD=password
SQL_USERNAME=user
SQL_PASSWORD=password
SQL_DSN='user:password@tcp(localhost:3306)/golismero'

# MQTT connection details.
MQTT_USERNAME=root
MQTT_PASSWORD=root
MQTT_URL=mqtt://root:root@localhost:1883/

# THC Hydra configuration.
HYDRA_LOGIN_FILE=resources/wordlists/top-usernames-shortlist.txt
HYDRA_PASSWORD_FILE=resources/wordlists/twitter-banned.txt
HYDRA_MAX_TASKS=16

# Golismero log level. Recommended to use "info" in production and "debug" in staging.
G3_LOG_LEVEL=debug

# Forces all plugins to be in this docker network.
# Normally this would be best done on a case by case basis by editing dockeropt in the .g3p file.
#G3_DOCKER_NETWORK=g3net

# Plugin environment variables.
# Any env var named G3_ENV_* is auto-forwarded to every plugin container and is
# also readable from plugin templates via {{(env).VAR_NAME}}. Use these to
# expose deployment capabilities to plugins (IPv6 stack, proxy settings, etc.).

# Set to "true" if this deployment can make outbound IPv6 connections from
# plugin containers. Default unset → IPv6 is treated as unavailable: IPv6-aware
# plugin conditions are skipped, AND the worker disables the IPv6 stack in each
# plugin container's network namespace (docker --sysctl) so tools that resolve
# hostnames internally (nikto, wafw00f, ...) don't attempt IPv6. The stack
# disable is skipped automatically if the host kernel has no IPv6 support.
#G3_ENV_IPV6_SUPPORTED=false

# Golismero g3worker configuration.
G3_WORKER_ID=g3worker-debug
G3_HOLD_CANCEL=5m

# Instance ID options for scanner and worker processes.
# These control how MQTT client IDs are derived when G3_SCANNER_ID / G3_WORKER_ID
# are not set explicitly.
#
# BEHAVIOR CHANGE NOTE: Prior to this feature, leaving G3_SCANNER_ID / G3_WORKER_ID
# unset resulted in a fresh random MQTT client ID per process restart (functionally
# equivalent to today's G3_INSTANCE_TRANSIENT=true mode, just implicit). The new
# default (hostname-derived) is stable across restarts of the same container —
# usually what you want for MQTT session persistence. On bare-metal hosts where
# hostname is generic ("localhost" etc.), startup will fail loud — set
# G3_INSTANCE_TRANSIENT=true to opt back into the prior random behavior, or set
# an explicit ID.
#
# G3_INSTANCE_PREFIX: (optional) Prepended to auto-derived IDs. Useful when
#   multiple deployments share infrastructure (e.g. "site-east-", "site-west-").
#   Cannot be set together with G3_SCANNER_ID / G3_WORKER_ID — that combination
#   is a startup error.
#G3_INSTANCE_PREFIX=
#
# G3_INSTANCE_TRANSIENT: (optional) When true, a fresh random ID is used on each
#   process restart instead of deriving from the container hostname. MQTT sessions
#   won't persist across restarts — queued messages from a prior session will be
#   dropped by the broker. Defaults to false.
#G3_INSTANCE_TRANSIENT=false

# Golismero shared artifacts volume.
# G3_ARTIFACTS_ROOT is the path the worker/g3api processes read and write.
# G3_ARTIFACTS_HOST_ROOT is what the worker passes to `docker run -v` (the host
# daemon's view); it equals G3_ARTIFACTS_ROOT when the volume is mounted at the
# same absolute path on host and container. In docker-compose these are set
# explicitly per-service; the entries here are for running the binaries directly.
#G3_ARTIFACTS_ROOT=/app/artifacts
#G3_ARTIFACTS_HOST_ROOT=/app/artifacts

# Golismero g3scanner configuration.
G3_SCANNER_PARALLEL_MODE=true
G3_SCANNER_MAX_PIPELINES=20
G3_SCANNER_MAX_DEPTH=20

# Golismero g3api configuration.
G3_API_TOKEN=changeme
G3_HTTP_BUFFER=65536
G3_FILE_UPLOAD_MAX=33554432
G3_UPLOAD_TTL=24h

# Golismero client configuration.
G3_API_BASEURL=http://localhost:8888/api
G3_API_WSURL=ws://localhost:8888/api/ws
G3_CMD_LOG_LEVEL=info
G3_DEBUG_API=true