This interface describes JSON config file (vendure-ui-config.json) used by the Admin UI. The values are loaded at run-time by the Admin UI app, and allow core configuration to be managed without the need to re-build the application.
string | 'auto''auto'The hostname of the Vendure server which the admin UI will be making API calls
to. If set to "auto", the Admin UI app will determine the hostname from the
current location (i.e. window.location.hostname).
number | 'auto''auto'The port of the Vendure server which the admin UI will be making API calls
to. If set to "auto", the Admin UI app will determine the port from the
current location (i.e. window.location.port).
string'admin-api'The path to the GraphQL Admin API.
'cookie' | 'bearer''cookie'Whether to use cookies or bearer tokens to track sessions.
Should match the setting of in the server's tokenMethod config
option.
string'vendure-auth-token'The header used when using the 'bearer' auth method. Should match the
setting of the server's authOptions.authTokenHeaderKey config option.
string'vendure-token'The name of the header which contains the channel token. Should match the
setting of the server's apiOptions.channelTokenKey config option.
LanguageCode<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>.enThe default language for the Admin UI. Must be one of the
items specified in the availableLanguages property.
stringv2.2.0The default locale for the Admin UI. The locale affects the formatting of
currencies & dates. Must be one of the items specified
in the availableLocales property.
If not set, the browser default locale will be used.
LanguageCode[]An array of languages for which translations exist for the Admin UI.
string[]v2.2.0An array of locales to be used on Admin UI.
stringIf you are using an external AuthenticationStrategy for the Admin API, you can configure a custom URL for the login page with this option. On logging out or redirecting an unauthenticated user, the Admin UI app will redirect the user to this URL rather than the default username/password screen.
stringThe custom brand name.
booleanfalseOption to hide vendure branding.
booleanfalseOption to hide version.
stringv1.9.0A url of a custom image to be used on the login screen, to override the images provided by Vendure's login image server.
string[]v1.5.0['order.cancel-reason-customer-request', 'order.cancel-reason-not-available']Allows you to provide default reasons for a refund or cancellation. This will be used in the refund/cancel dialog. The values can be literal strings (e.g. "Not in stock") or translation tokens (see Adding Admin UI Translations).
Architecture reviews, custom plugin work, migrations, ongoing support. Get a hand from the team that builds Vendure.
Talk to the team