.env.example

# Environment Configuration Template for sftp-sync
# Copy this file to .env and fill in your actual values.
# This file documents every environment variable the application actually reads.
#
# The .env file is loaded from the current working directory at startup
# (via github.com/joho/godotenv). A missing file is ignored.
# Variables already present in the shell are NOT overridden.
#
# NOTE: credentials used by --dest (passwords, key passphrases) are NOT
# environment variables — they are passed in the destination URL itself.
# Do not commit a real .env file: it is already listed in .gitignore.

# =============================================================================
# APPLICATION CONFIGURATION
# =============================================================================

# Debug Logging
# Purpose: Enables debug-level logging for the whole application; same effect
#          as passing the --debug flag on the command line.
# Format:  Boolean value accepted by Go's strconv.ParseBool
#          (1, t, T, true, TRUE, True).
#          0 or false disables debug logging; unset (default) disables it.
#          An unparseable value (e.g. "yes") makes the command fail at startup.
# Default: unset (disabled)
# Example: DEBUG=1
DEBUG=0

# =============================================================================
# SSH AUTHENTICATION (SFTP destinations only)
# =============================================================================

# SSH Agent Socket
# Purpose: Read by sftp-sync when the destination URL enables the SSH agent
#          (?agent=true) to authenticate to an SFTP server. Provides the
#          signers used for public-key authentication.
# Format:  Absolute path to a Unix domain socket.
# Default: provided by ssh-agent / the system — do not set it yourself unless
#          you know you need to; leaving it unset disables agent auth.
# Example: SSH_AUTH_SOCK=/tmp/ssh-XXXXXX/agent.1234
#SSH_AUTH_SOCK=/tmp/ssh-XXXXXX/agent.1234