Skip to content
← Cbox ID 2.0.0 View on GitHub

Languages

Languages

The pages your users and your customers' IT admins see can be shown in six languages:

Code Language
en English
da Dansk
de Deutsch
sv Svenska
nb Norsk bokmål
fr Français

That covers sign-in, sign-up, two-factor and step-up prompts, password reset, invitations and email confirmation, the OAuth consent screen and organization picker, the Admin Portal, the error pages, and the emails those flows send.

The admin console stays in English, whatever language your browser prefers. So do the device-approval and "confirm it's you" screens, which sit inside the console.

How a visitor's language is chosen

Each sign-in page asks these sources in order. The first one that names a language switched on for the environment wins:

  1. ui_locales from your app. OpenID Connect lets the app that sends someone to sign in say which languages it wants, most preferred first, separated by spaces: /oauth/authorize?…&ui_locales=da en. The choice lasts for the whole sign-in, so the MFA prompt and the consent screen after it stay in that language.
  2. The visitor's own pick. The language menu in the footer of every sign-in page remembers the choice in a cookie for a year. Picking a language there also overrides ui_locales for the rest of that sign-in.
  3. The browser's language list (Accept-Language), in the browser's own order. da-DK counts as Danish, and no counts as Norwegian Bokmål.
  4. The environment's default language.

A language that is not on the list above is skipped, and so is a supported language that the environment has switched off. Either way the next source is asked.

There is no per-user language setting. The cookie is what remembers someone's choice, because most people use the menu before they have signed in.

Which language emails are sent in

  • Emails a person asks for themselves, such as a sign-in link, a password reset or a sign-up confirmation, use the language of the page they asked from.
  • Emails an administrator sends, such as an invitation, a password they set or a reset they triggered, use the environment's default language. The console the administrator works in says nothing about the reader's language. The page the email links to then follows the reader's own browser.

Emails and error pages carry your deployment's product name (CBOX_ID_BRAND_NAME), not "Cbox ID".

Changing the default and the list

For the whole deployment, set two environment variables. See environment variables.

CBOX_ID_DEFAULT_LOCALE=da
CBOX_ID_LOCALES=da,en,sv,nb

For one environment, set default_locale and enabled_locales in that environment's settings. These are stored with its sign-in appearance and override the deployment's values:

{ "default_locale": "de", "enabled_locales": ["de", "en", "fr"] }

The console has no screen for these two settings yet. Write them the same way as other environment settings, for example from php artisan tinker:

$environment = \Cbox\Id\Organization\Models\Environment::find('…');
$environment->settings = [...$environment->settings, 'default_locale' => 'de', 'enabled_locales' => ['de', 'en', 'fr']];
$environment->save();

The default is always kept inside the list. If you name a default that the list leaves out, the first language in the list becomes the default. If only one language is left on, the language menu is hidden.

For developers: adding or changing text

The text lives in lang/<code>/*.php, one file per group: hosted (the shared page frame), auth, oauth, portal, mail and errors. English is the source:

  1. Add or change the key in lang/en/….
  2. Run php artisan i18n:types. This regenerates resources/js/i18n/keys.ts, so React pages can only ask for keys that exist in English. CI fails if that file is out of date.
  3. Add the same key, with the same :placeholders, to the other five languages. LangParityTest fails if any language is missing a key, has an extra key, or changes a placeholder.

In React, use useTranslator() from @/i18n. It gives you t(key, params) for text, rich(key, { name: <b>…</b> }) when a placeholder is a React element, and choice(key, count) for two-form plurals. A page receives only its own group's text.

← Previous Access reviews Next → Role conflicts