The environment configuration is implemented by the Go third-party library viper. When the program starts, viper will read the 'yaml' configuration file and map the environment variables to the variables in the configuration file.

The following is the 'yaml' configuration file, where the variables can be overwritten by the environment variables prefixed with 'CRAWLAB_'.

api:
  address: "http://localhost:8000"  # API address
mongo:
  host: localhost  # MongoDB host
  port: 27017  # MongoDB port
  db: crawlab_test  # MongoDB database
  username: ""  # MongoDB username
  password: ""  # MongoDB password
  authSource: "admin"  # MongoDB auth source database
redis:
  address: localhost  # Redis host
  password: ""  # Redis password
  database: 1  # Redis database
  port: 6379  # Redis port
log:
  level: info  # Log Level
  path: "/var/logs/crawlab"  # Log Path
  isDeletePeriodically: "N"  # Delete log regularly (default is no)
  deleteFrequency: "@hourly"  # Log deletion frequency
server:
  host: 0.0.0.0  # Back end listening address
  port: 8000  # Back end listening port
  master: "Y"  # Master node or not
  secret: "crawlab"  # JWT secret
  register:
    # mac address or IP address. If it is IP address, you need to specify IP manually
    type: "mac"
    ip: ""
  lang: # Install language environment, y is installation, n is not installation
    python: "Y"
    node: "N"
    java: "N"
    dotnet: "N"
spider:
  path: "/app/spiders"  # spider path
task:
  workers: 4  # Number of actuators running tasks at the same time
other:
  tmppath: "/tmp"  # Temporary file directory
version: 0.4.7  # Version
setting:
  allowRegister: "N"  # Allow registration or not
  enableTutorial: "N"  # Discard tutorial or not
  runOnMaster: "Y"  # Whether to run the task on the master node
  demoSpiders: "N"  # Whether to load demo spider
  checkScrapy: "Y"  # Whether to check Scrapy automatically
notification: # Message notification 
  mail: # Email notification
    server: '' # SMPT server address
    port: ''  # SMTP server port
    senderEmail: ''  # Sender email
    senderIdentity: ''  # Sender identity
    smtp:  # SMTP
      user: ''  # SMTP user
      password: ''  # SMTP password

The list of environment variables is as follows.