Configuration

Environment files#

Configuration comes from the environment, read in this order (later wins):

1. .env in the project root;
2. .env.{APP_ENV} (for example .env.testing), when APP_ENV is set;
3. the process environment;
4. overrides passed in code (withEnv({...}), used by tests).

The syntax is Laravel's (phpdotenv 5): comments, export, single and double quotes, escapes in double quotes, values in double quotes that span several lines, and ${NAME} references. A bare $NAME stays as written, so a password such as p$ss reads the same in Laravel and Daravel.

dartisan key:generate writes a fresh APP_KEY. Without a .env, APP_ENV defaults to production.

Encrypted environment files#

dartisan env:encrypt writes .env.encrypted in the format of php artisan env:encrypt; set DARAVEL_ENV_ENCRYPTION_KEY (or LARAVEL_ENV_ENCRYPTION_KEY) and the application decrypts it in memory at boot. See Deployment.

Typed configuration#

Each module reads its variables into a typed section (AppConfig, DatabaseConfig, CacheConfig, QueueConfig, ...), validated at boot: debug mode in production, a malformed APP_KEY or an unknown DB_CONNECTION stop the application with a clear message.

final app = Config.section<AppConfig>();      // typed
final name = Config.get<String>('app.name');  // dot notation, like config()

Your own settings get a section too:

final class BillingConfig implements ConfigSection {
  BillingConfig(this.currency, this.trialDays);

  factory BillingConfig.fromEnv(Env env) => BillingConfig(
    env.string('BILLING_CURRENCY', 'IDR'),
    env.integer('BILLING_TRIAL_DAYS', 14),
  );

  final String currency;
  final int trialDays;

  @override
  String get key => 'billing';

  @override
  Map<String, Object?> toMap() => {'currency': currency, 'trial_days': trialDays};
}

// bootstrap/app.dart
Application.configure(basePath: '.').withConfig(BillingConfig.fromEnv);

Env has typed readers: string, integer, boolean, duration (30s, 5m, 500ms), list, url and enumValue. Configuration is frozen after boot.

Common variables#

dartisan doctor checks the configuration and the database connection; doctor --production treats warnings as failures.