Deploying Account Management User Interface
note
Account Management API is now deprecated and we recommend that you use Account Management functionality built into Elastic Path Commerce 8.2 and later.
Pre-requisites
- Ensure that all requirements described in the Requirements section are met.
- Ensure that you have access to the
account-management-2.4.x.zip
file in the Elastic Path public Nexus repository. - Ensure that the public URL of the Account Management UI is listed as a valid redirect URI in the identity provider. For more information, see the
redirect_uri
parameter in OpenID Connect 1.0 -- Section 3.1.2.1.
Procedure
Extract the files in the
account-management-2.4.x.zip
file.- Ensure that all contents including the
account-management-app
folder are extracted. This folder contains the code to build the Docker image.
- Ensure that all contents including the
On your computer, build the Docker image by using
account-management-app/docker/Dockerfile
)- Ensure that you build the Docker image by running the following command in the parent directory:
cd account-management-2.4.x/account-management-app/ docker build -f ./Dockerfile
Push the Docker image to Amazon ECR (Elastic Container Registry).
Deploy the Docker image in Amazon ECS (Elastic Container Services) with appropriate parameters. For more information, see the Docker Image Environment Variables section.
Create and configure a new Amazon ELB (Elastic Load Balancer) with the Amazon ECS service and appropriate SSL certificates.
Docker image environment variables
Parameter | Value |
---|---|
INSTANCE_URL | The Account Management user interface URL. |
COMMERCE_MANAGER_URL | The URL for the Commerce Manager instance. |
ADMIN_API_URL | The URL for the Account Management API Service. For example, https://<ACCOUNT-MANAGEMENT-API>/admin . |
Localization
You can add up to ten additional locales to your deployment. To add a new locale, do the following:
- Copy the existing translation file:
account-management-2.4.x/account-management-app/src/locales/en-US.json
- Translate the strings for the keys in your new JSON file.
- Host the file on the web with CORS (Cross Origin Resource Sharing) headers enabled.
- Add the following environment variables to your deployment:
ADDED_LOCALE_<INDEX>_NAME
: The locale identifier of the new locale, for example,fr-FR
.ADDED_LOCALE_<INDEX>_TITLE
: The name of the new locale to be shown in the language dropdown, for example,Française
.ADDED_LOCALE_<INDEX>_JSON_PATH
: The URL path to the hosted JSON file with translations, for example,https://my.website.com/locales/fr-FR.json
.
You can set the <INDEX>
parameter from 0 through 9 for a total of 10 additional locales.
View and test the changes with the docker compose deploy by adding the environment variables to the following env
file:
account-management-2.4.x/local-deployment/am.env
Validating User Interface Deployment
Use this procedure to verify that the Elastic Path Account Management service deployment is complete and successful in AWS (Amazon Web Services).
Go to the Account Management user interface URL.
The system redirects you to the identity provider configured on the Account Management API Service.
Log in to the identity provider with the seller administrator credentials.
The system redirects you to the Account Management user interface to continue with the login.