Localization Support in Identity Server¶
This page describes how WSO2 Identity Server can be configured to support localization of its UI.
Configure localization for authentication endpoints¶
WSO2 Identity Server provides internationalization support for the web
apps (such as authentication endpoint which is in
directory). The following steps describe how you can configure this:
- Navigate to
Take a copy of the
Resources.propertiesfile to the same location, rename it with the required locale suffix as follows:
- For British English:
- For French (Standard):
Refer Web browser language identification codes for more information on required locale suffixes.
- For British English:
Update values while keeping the keys as follows,
login=<Value in the required locale>
Save the file.
Go to the browser setting and add the language you configured above.
Restart the server.
To try out, do the following:
- Open up a browser.
- Type the My Account application URL (
https://<IS_HOST>:<IS_PORT>/myaccount). You will see the login screen having the contents in the configured language.
If you want to have internationalization of error messages coming from
authentication-framework/oauth-framework, follow the below steps:
First, you need to generate a key from the message itself for the i18n, properties file. following steps below:
- Get the message,
oauthErrorMsgfrom the URL and decode the URL (URLDecode).
- Base64 encode the message,
- Replace = with _ in the base64 encoded message.
Now look for a value in
Resource.properties file with
the relevant locale. If a match is found, define a value for the
property. Otherwise use add new property entry to the relevant locale
based on the Resource file, as explained above. If you don't specify a
value for the key obtained above, the error message itself will be
displayed in the UI, as default.
Configure localization for recovery endpoints¶
Similarly, you can enable localization for
applying the same above steps 2 through 6 in the previous section
starting with the following location.
Configuring Localization for My Account and Console¶
We maintain the i18n (localization) resources for My Account and Console in a separate module inside the identity-apps repository hence the localization configurations should be applied according to the instructions provided in the README.md file of the same repository. For further reference, you can check out the GitHub pull request where the French language was introduced to the applications.Top