Deploying Account Management with Docker Compose

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.

The Account Management release package consists of a Docker Compose file that builds and deploys Account Management locally for testing or investigation purposes.

The Docker Compose deployment also includes Keycloak, MySQL, email, and web mail containers that provide a complete Account Management experience. Keycloak is an open source identity provider that is compatible with OpenID Connect.

note

Elastic Path Commerce applications are not included in the Docker Compose deployment. For more information on how to deploy Elastic Path Commerce see Elastic Path documentation. For Account Management specific changes see the Update Elastic Path Commerce section.

Pre-requisites

• Ensure that Docker is installed

Procedure

1. Download the Account Management release package from Elastic Path Nexus.

   For more information about the deployment prerequisites, see prerequisites.

2. Unzip the package.

3. In the terminal, navigate to the unarchived directory.

4. Run the docker-compose up command. Ensure that all the Docker images are built and all containers are deployed.

After the initialization completes, you can access the Account Management user interface, Account Management API Studio and Keycloak from your browser. For details on default addresses and credentials, see the Accessing the Account Management Service section.

note

The Docker Compose file creates a Docker volume where data is persisted. For information on how to teardown the Account Management stack with or without the persisted data, see docker-compose down.

Accessing the Account Management Service

Component	Address	Username	Password
Account Management User Interface	http://localhost:28082	seller.admin@example.com	password
Account Management API Studio	http://localhost:28080/studio	seller.admin@example.com	password
Keycloak	http://localhost:28081	admin	admin
Webmail	http://localhost:28083/	Any valid email address	Any non-empty string

note

The webmail service uses the virtual email service, Greenmail, that acts as a fully functional SMTP and IMAP service. You can use this service to login and view all emails that are sent by any of the constituent systems, which are stored locally.

Creating associates in Keycloak

By default, the local deployment package only has a seller administrator configured. Use this procedure to create associates in the deployment.

1. Log in to Keycloak using the location and credentials.
2. In the Master drop down menu, click Commerce. For more information about realms, see the Keycloak Manual Chapter 3 -- The Master Realm section.
3. Create a new user following the instructions at Keycloak Manual Chapter 4 - Creating New Users.

note

By default, the local deployment of Keycloak automatically assigns associate role to the new users. For more information about the implementation, see the local-deployment/am-config/config-entrypoint.sh file.