How to Run

The simplest way to run the application is to use the provided hosted instances here and here.

If you want to run the application yourself, you can do so. If you want to make modifications and build it yourself, follow this explanation.

If you just want to run it, follow this guide. The application consists of two parts: one for issuing credentials and one for creating badges. Since the latter is usually the one you'd like to run on your own (as you likely already have a solution for issuing credentials), we start with this one.

Hosting the Application to Create Badges

A Docker image for the application is available here:

docker pull ghcr.io/bsandmann/credentialbadges-web:latest

To run the image, create a docker-compose.yml file with the following contents:

services:
  credentialweb:
    image: ghcr.io/bsandmann/credentialbadges-web:latest
    # Expose ports locally (uncomment or adjust as needed)
    ports:
      - "8080:8080"
    restart: unless-stopped
    environment:
      - ConnectionStrings__CredentialBadgesDatabase=<postgres connection stirng>
      - PrismDid__BaseUrl=https://opn.mainnet.blocktrust.dev
      - PrismDid__DefaultLedger=mainnet
      - Badge__LoaderScriptUrl=https://0cfa9cc0.blocktrust-credential-badges.pages.dev/badge-loader.min.js

If you don't have a PostgreSQL database, you can set it up using Docker Compose like this:

services:
  credentialweb:
    image: ghcr.io/bsandmann/credentialbadges-web:latest
    # Expose ports locally (uncomment or adjust as needed)
    ports:
      - "8080:8080"
    restart: unless-stopped
    environment:
      - ConnectionStrings__CredentialBadgesDatabase=Host=credentialdb;Port=5432;Database=webdatabase;Username=blocktrustpostgres;Password=YOUR-SECRET-PASSWORD
      - PrismDid__BaseUrl=https://opn.mainnet.blocktrust.dev
      - PrismDid__DefaultLedger=mainnet
      - Badge__LoaderScriptUrl=https://0cfa9cc0.blocktrust-credential-badges.pages.dev/badge-loader.min.js
    depends_on:
      - credentialdb

  credentialdb:
    image: postgres:15
    restart: unless-stopped
    environment:
      - POSTGRES_DB=webdatabase
      - POSTGRES_USER=blocktrustpostgres
      - POSTGRES_PASSWORD=YOUR-SECRET-PASSWORD
    volumes:
      - credentialdbdata:/var/lib/postgresql/data

volumes:
  credentialdbdata:

The loader script is hosted via a CDN here: https://0cfa9cc0.blocktrust-credential-badges.pages.dev/badge-loader.min.js

Change this if you want to modify the script or if the CDN is not to your liking.

Short-form DIDs are resolved through the OpenPrismNode (OPN) project. The configuration points to the relevant OPN server and the default ledger. You can, of course, host your own. If you want to use the badges for preprod, use this server instead: https://opn.preprod.blocktrust.dev with preprod as the default ledger.

Hosting the Application to Issue Credentials

The Docker container is available here:

docker pull ghcr.io/bsandmann/credentialbadges-builder:latest

Note that you need an already deployed Identus agent for this scenario. We recommend following the Identus quick start guide.

The proposed setup works with two agent instances (to align with the quick start guide) for issuing and holding credentials. You'll need to create an API for both and the appropriate endpoint. You also need to take note of the issuing DID of the issuing agent.

SendGrid is used for sending the registration emails—you can sign up for free. The SnippetsUrl is the URL of the above application, used to link to it when a credential has been created.

Similarly, you can set it up like this for the builder project:

services:
  credentialbuilder:
    image: ghcr.io/bsandmann/credentialbadges-builder:latest
    # Expose ports locally (uncomment or adjust as needed)
    ports:
      - "8080:8080"
    restart: unless-stopped
    environment:
      - ConnectionStrings__BuilderDbConnection=Host=credentialbuilderdb;Port=5432;Database=builderdatabase;Username=blocktrustpostgres;Password=YOUR-SECRET-PASSWORD
      - AppSettings__AdminAgentBaseUrl=http://<URL>/cloud-agent/
      - AppSettings__UserAgentBaseUrl=http://<URL>/cloud-agent/
      - AppSettings__AdminApiKey=
      - AppSettings__UserApiKey=
      - AppSettings__IssuingDID=did:prism:<ISSUERDID>
      - AppSettings__SendGridKey=
      - AppSettings__SendGridFromEmail=
      - AppSettings__SnippetsUrl=https://badges.blocktrust.dev
    depends_on:
      - credentialbuilderdb

  credentialbuilderdb:
    image: postgres:15
    restart: unless-stopped
    environment:
      - POSTGRES_DB=builderdatabase
      - POSTGRES_USER=blocktrustpostgres
      - POSTGRES_PASSWORD=YOUR-SECRET-PASSWORD
    volumes:
      - credentialbuilderdbdata:/var/lib/postgresql/data

volumes:
  credentialbuilderdbdata

Last modified: 19 March 2025