Broadleaf Microservices
  • v1.0.0-latest-prod

Evaluation Credentials

Evaluation Credentials vs Enterprise License Credentials

If you’ve signed up for a free developer evaluation trial (https://www.broadleafcommerce.com/developer-evaluation), you should receive an email with getting started instructions that include a username, password, and an expiration date.

You should be aware that there are slightly different "Getting Started" steps that are only applicable to Evaluation Credentials. As you are following any of the getting started guides on this portal, make sure to pay attention to any instructions that callout different steps needed for "Evaluation Credential Holders".

How do I know if I have evaluation credentials?

You have evaluation credentials if:

Differentiated Setup Steps

One of the main differences between Evaluation Credentials and Enterprise License Credentials is that "Evaluation Credential Holders" will only have access to artifacts that reside on Broadleaf’s Evaluation Mirror Repository: https://evaluation.repository.blcdemo.com

Enterprise License Holders will have access to the full suite of Broadleaf resources (depending on their license) on Broadleaf’s primary repository: https://repository.broadleafcommerce.com

Below you will find the list of differentiated steps that you should be aware of when getting started locally.

Docker Registry Authentication

To authenticate with the correct Broadleaf docker registry, run the following based on your credentials:

For Enterprise License Holders:

docker login repository.broadleafcommerce.com:5001

For Evaluation Credential Holders:

docker login https://evaluation.docker.blcdemo.com

Maven Repository Authentication

To build a Broadleaf Initalizr-based project, you will need to have configured authentication to Broadleaf’s private Maven Nexus. The correct ~/.m2/settings.xml configuration depends on the type of credentials you were provisioned.

For Enterprise License Holders:

<settings xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.1.0 http://maven.apache.org/xsd/settings-1.1.0.xsd"
          xmlns="http://maven.apache.org/SETTINGS/1.1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <servers>
        <server>
            <id>broadleaf-microservices</id>
            <username>username_here</username>
            <password>password_here</password>
        </server>
    </servers>
</settings>

For Evaluation Credential Holders:

You will need to set up a mirror configuration to the broadleaf-microservices server id.

<settings xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.1.0 http://maven.apache.org/xsd/settings-1.1.0.xsd"
          xmlns="http://maven.apache.org/SETTINGS/1.1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <servers>
        <server>
            <id>broadleaf-microservices-evaluation</id>
            <username>eval_username_here</username>
            <password>eval_password_here</password>
        </server>
    </servers>
    <mirrors>
        <mirror>
            <id>broadleaf-microservices-evaluation</id>
            <mirrorOf>broadleaf-microservices</mirrorOf>
            <url>https://evaluation.repository.blcdemo.com/repository/microservices/</url>
        </mirror>
    </mirrors>
</settings>

Generating correct docker-compose.yml file

When using Broadleaf’s Maven docker-compose:generate plugin, you will need to specify a mirror param so that the generated demo docker images point to the correct docker registry based on the type of credentials you have:

For Enterprise License Holders:

cd manifest
./mvnw docker-compose:generate
./mvnw docker-compose:up

For Evaluation Credential Holders:

cd manifest
./mvnw docker-compose:generate -Dmirror=evaluation.docker.blcdemo.com
./mvnw docker-compose:up -Dmirror=evaluation.docker.blcdemo.com

Converting from Evaluation to Enterprise License Credentials

If you were given full Enterprise License Credentials and were previously using Evaluation Credentials, then you will want to make sure you correct your local environment setup to no longer use the evaluation mirror.

Authenticate to Correct Docker Registry

docker logout https://evaluation.docker.blcdemo.com
docker login repository.broadleafcommerce.com:5001

Authenticate to Correct Maven Repository

Make sure to change your ~/.m2/settings.xml credentials to remove the evaluation mirror. Your settings.xml file should now look something like this:

<settings xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.1.0 http://maven.apache.org/xsd/settings-1.1.0.xsd"
          xmlns="http://maven.apache.org/SETTINGS/1.1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <servers>
        <server>
            <id>broadleaf-microservices</id>
            <username>username_here</username>
            <password>password_here</password>
        </server>
    </servers>
</settings>