Configuring AdminUI

Configuring AdminUI

Before AdminUI can be started, we must first configure it to our environment. This includes configuring settings such as the location of your IdentityServer and your Identity databases.

AdminUI reads configuration values from the environment it is running in. For example, you can set configuration settings in your Docker Compose file, your web.config or even your Windows account's environment variables. Whatever ASP.NET Core can load in as environment variables, AdminUI can use.

AdminUI Configuration Settings

API

  • DbProvider: This sets the database type you are using. Supported types and their values are:
    • SqlServer
    • MySql
    • PostreSql
  • IdentityConnectionString: The connection string for your Identity database (users)
  • IdentityServerConnectionString: The connection string for your IdentityServer database (clients, resources & grants)
  • AuthorityUrl: Url of the IdentityServer installation protecting the UI
  • UiUrl: Url of the AdminUI frontend (the idxui container)
  • RequireHttpsMetadata: Set to true or false if you want to ensure IdentityServer discovery endpoint uses TLS. Must be true for production
  • RunIdentityServerMigrations: Set to true or false if you require AdminUI to run Entity Framework migrations for IdentityServer DbContext's. This is useful if you have a new instance of IdentityServer currently without databases.
  • IdentityDatabaseToMigrateConnectionString (optional): The connection string of your existing ASP.NET Core Identity Entity Framework database that will be migrated to the database used in IdentityConnectionString (this must not be equal to IdentityConnectionString).
  • LoggingMinimumLevel: Minimum level of logging (debug, info, warning, error, or critical). Defaults to info
  • UseLegacyPaging: Allows support for legacy databases such as SQL Server 2008
  • LicenseKey: The full license key for AdminUI

UI

  • AuthorityUrl: Url of the IdentityServer installation protecting AdminUI
  • ApiUrl: Url of the AdminUI backend (the idxapi container)
  • UiUrl: Url of the AdminUI frontend (the idxui container)