frappe-config

Frappe Config Command

Manage Frappe site configuration including site_config.json settings, environment variables, and feature flags.

Steps to Execute

1. Verify Environment

• Check if in valid Frappe bench
• Verify site exists
• Check site_config.json file exists

2. Configuration Operation Selection

Ask user what they want to configure:

A. View Current Config

• Display site_config.json
• Show environment variables
• List feature flags

B. Database Settings

• Configure MariaDB/PostgreSQL
• Set connection parameters
• Configure read replicas

C. Redis Settings

• Configure cache Redis
• Configure queue Redis
• Configure socketio Redis

D. Email Settings

• SMTP configuration
• Email accounts
• Outgoing email settings

E. Developer Settings

• Developer mode
• Debug mode
• Logging levels

F. Feature Flags

• Enable/disable features
• Experimental features
• Module toggles

3. View Configuration

Display site_config.json:

cat sites/[site-name]/site_config.json | jq .

Get Specific Config:

bench --site [site-name] console
>>> frappe.conf.get('db_name')
>>> frappe.conf.get('developer_mode')

List All Configs:

import json
print(json.dumps(frappe.conf, indent=2))

4. Set Configuration Values

Set Single Value:

bench --site [site-name] set-config [key] [value]

Examples:

# Enable developer mode
bench --site [site-name] set-config developer_mode 1

# Set session timeout
bench --site [site-name] set-config session_timeout 3600

# Set file size limit
bench --site [site-name] set-config max_file_size 10485760

Set Multiple Values:

# Via console
config_updates = {
    'developer_mode': 1,
    'allow_tests': 1,
    'log_queries': 1
}

for key, value in config_updates.items():
    frappe.db.set_value('Website Settings', None, key, value)

frappe.db.commit()

5. Database Configuration

Database Settings:

{
  "db_name": "site_db",
  "db_host": "localhost",
  "db_port": 3306,
  "db_type": "mariadb",
  "db_socket": "/var/run/mysqld/mysqld.sock"
}