Data Settings

These are Endatix API settings (Endatix:Data). They control migrations and sample seeding.

Configuration

To configure the data settings, add the following snippet to your appsettings.json file. Customize the values based on your requirements:

"Endatix": {
    "Data": {
        "EnableAutoMigrations": true,
        "SeedSampleData": true,
        "InitialUser": {
            "Email": "admin@example.com",
            "Password": "StrongPassword123!"
        }
    }
}

Settings Reference

Setting	Description	Default
EnableAutoMigrations	Controls whether database migrations are automatically applied at application startup	false
SeedSampleData	Controls whether initial sample data (including user) is seeded at startup	false
InitialUser	Configuration for the initial admin user when seeding sample data	(see below)

InitialUser Options

These properties are read only on a first run: when SeedSampleData is enabled and the database has no users. Once a user exists, the API ignores them, so you can remove them after the first sign-in.

Property	Description	Required
Email	Email address for the initial user. Defaults to admin@endatix.com	No
Password	Password for the initial user. There is no default	Yes, for a first run

If the database has no users and Password is not set, the API starts but creates no admin. It logs this error (event id 1110):

❌ The database has no users, but the initial admin was not created because Endatix:Data:InitialUser:Password is not configured.

Set the password and restart. Outside your machine, pass it as the Endatix__Data__InitialUser__Password environment variable or a secret, not in a committed appsettings.json. After the first sign-in, change the password and remove InitialUser from the configuration.

Changed in 0.8.1

Earlier versions created admin@endatix.com / P@ssw0rd on a first run when no password was configured, and the API's appsettings.json shipped that password. Both are gone. Databases that already have users are not affected. Only appsettings.Development.json still carries a development password.

Programmatic Configuration

You can also configure data settings using the builder pattern:

builder.Services.AddEndatix(configuration)
    .Persistence
        .EnableAutoMigrations(true)
        .EnableSampleDataSeeding(true)
    .Build();

Note on importance

🔥 Data settings are a critical part of your deployment strategy. You should carefully decide when and if data migrations and seeding are executed to ensure your database schema and data are properly managed according to your application's needs.