Configuration

The Osumi Framework configuration is managed through JSON files located in src/Config/. These settings control application behavior, database connections, environment-specific variables, and more.

Configuration Files

1. Config.json: main configuration.
2. Config_{environment}.json: optional environment-specific overrides.

Core Configuration Blocks

Application Settings

{
	"name": "My Awesome App",
	"lang": "en",
	"use-session": true,
	"allow-cross-origin": true,
	"base_url": "https://example.com",
	"css_list": [],
	"js_list": [],
	"head_elements": []
}

Database (db)

{
	"db": {
		"driver": "mysql",
		"host": "localhost",
		"user": "root",
		"pass": "secret",
		"name": "my_database",
		"charset": "utf8mb4",
		"collate": "utf8mb4_unicode_ci"
	}
}

Logging (log)

{
	"log_level": "DEBUG",
	"log": {
		"name": "app_log",
		"max_file_size": 50,
		"max_num_files": 3
	}
}

Custom Directories (dir)

{
	"dir": {
		"uploads": "{{base}}public/uploads/",
		"exports": "{{ofw_export}}my_reports/"
	}
}

Extra Settings (extra)

{
	"extra": {
		"api_key": "12345-abcde",
		"items_per_page": 20
	}
}

Assets and Head Elements

css_list and js_list accept arrays of names resolved below public.

head_elements accepts entries containing an item and an attributes object.

Accessing Configuration in Code

$apiKey = $this->getConfig()->getExtra('api_key');
$uploadPath = $this->getConfig()->getDir('uploads');
$dbName = $this->getConfig()->getDB('name');

Environment Overrides

When a value exists in both Config.json and the selected environment file, the environment-specific value overrides the main one.

Application Paths

OConfig defines a set of default application paths:

Best Practices

• Never commit secrets.
• Use environment-specific configuration where appropriate.
• Validate values returned by generic configuration getters when their type matters.
• Keep JSON files syntactically valid.