-
Notifications
You must be signed in to change notification settings - Fork 318
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4617 from AfraHussaindeen/master_localization_sup…
…port_master_fix Add instructions to configure localization for authentication and recovery endpoints
- Loading branch information
Showing
1 changed file
with
41 additions
and
0 deletions.
There are no files selected for viewing
41 changes: 41 additions & 0 deletions
41
en/identity-server/next/docs/guides/branding/localization.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,43 @@ | ||
{% set product_url_format = "https://localhost:9443" %} | ||
{% include "../../../../../includes/guides/branding/localization.md" %} | ||
|
||
## Configuring localization for authentication endpoints | ||
|
||
WSO2 Identity Server provides internationalization support for its web applications (such as the authentication endpoint located in the `<IS_HOME>/repository/deployment/server/webapps/` directory). The following steps describe how you can configure this: | ||
|
||
1. Navigate to `<IS_HOME>/repository/deployment/server/webapps/authenticationendpoint/WEB-INF/classes/org/wso2/carbon/identity/application/authentication/endpoint/i18n/` | ||
|
||
2. Duplicate the `Resources.properties` file in the same location and rename it with the required locale suffix as follows: | ||
- For British English: `Resources_en_GB.properties` | ||
- For French (Standard): `Resources_fr.properties` | ||
|
||
Refer to [Web browser language identification codes](https://www.localeplanet.com/icu/) for more information on locale suffixes. | ||
|
||
3. Update the values for each key as follows: | ||
``` | ||
login=<Value in the required locale> | ||
``` | ||
|
||
4. Save the file. | ||
|
||
5. Navigate to `<IS_HOME>/repository/deployment/server/webapps/authenticationendpoint/WEB-INF/classes/` and open the `LanguageOptions.properties` file. | ||
|
||
6. Add information about the new language in the following format & save the file. | ||
``` | ||
<language switcher name>=<language code>,<language name>` | ||
``` | ||
|
||
7. Go to the browser settings and add the language you configured above. | ||
|
||
8. Restart the server. To try out, do the following: | ||
1. Open up a browser. | ||
2. Type the My Account portal URL. (If you are running the server in your localhost, the URL is: [https://localhost:9443/myaccount/](https://localhost:9443/myaccount/)). You will see the login screen having the contents in the configured language. | ||
|
||
## Configuring localization for recovery endpoints | ||
|
||
You can enable localization for `accountrecoveryendpoint` by applying the same steps 1 through 8 in the previous section, for the following location: | ||
|
||
`<IS_HOME>/repository/deployment/server/webapps/accountrecoveryendpoint/WEB-INF/classes/org/wso2/carbon/identity/mgt/recovery/endpoint/i18n/`. | ||
|
||
Update the LanguageOptions.properties file located at: `<IS_HOME>/repository/deployment/server/webapps/authenticationendpoint/WEB-INF/classes/LanguageOptions.properties` to include the new language options. | ||
|