search
how tos

Deploying and Testing Self-Service Operations

Introduction

Self-service operations, such as resetting one’s own password, getting forgotten usernames, and others, require access to email. Mailhog is a lightweight utility for sending and viewing email messages in a Kubernetes cluster, especially for development and test purposes.

Note: Mailhog is not meant for use in production environments.

ForgeRock does not guarantee the individual success developers may have in implementing the code on their development platforms.

References

Set up Mailhog in your Kubernetes cluster

Prerequisites:

  • You have set up the CDK and your Kubernetes context is set to your CDK cluster.
  • You have installed Helm 3.

Deploy Mailhog

  1. Set up your Kubernetes context and namespace. For example:
  2. 
    kubectl ctx minikube
    
    kubectl ns my-namespace
    
    

  3. Install Mailhog in your namespace using Helm 3:
  4. 
    helm repo add codecentric https://codecentric.github.io/helm-charts
    
    helm install mailhog codecentric/mailhog 
    
    

  5. Verify that the Mailhog pod is running:
  6. 
    kubectl get pods | grep mailhog
    mailhog-16...zl   1/1     Running     1          23m
    
    

  7. Optional: To verify delivery of SMTP messages, set up port forwarding on SMTP port 1025 using a terminal window:
  8. 
    
    export POD_NAME=mailhog-16...zl
    
    kubectl port-forward --namespace my-namespace $POD_NAME 1025
    
    

  9. To view the emails received on the Mailhog server, set up port forwarding on HTTP port 8025 using another terminal window:
  10. 
    
    export POD_NAME=mailhog-16...zl
    
    kubectl port-forward --namespace my-namespace $POD_NAME 8025
    
    

    Enable the email service in IDM

    After verifying that the Mailhog server is able to send and receive messages, you can configure email settings in the IDM server:

    1. Log in to the IDM administration console and configure email settings.
    2. Reset a user’s password

      1. In a web browser, access the reset password service in your deployment. For example: https://my-namespace.iam.example.com/am/?service=ResetPassword.
      2. Enter the email ID of the user whose password needs to be reset. For example, the email ID for our test user is [email protected]
      3. A notification appears indicating that an email has been sent to the address you entered.
      4. View your Mailhog inbox to see if you have received an email to reset the password.
      5. Open the reset your password email and click the Reset Password link.
      6. Enter the new password.
      7. Verify that you can log in after you have reset the password.
      8. Obtain a forgotten username

        1. In a web browser, access the reset password service in your deployment. For example: https://my-namespace.iam.example.com/am/?service=ForgottenUsername.
        2. Enter the email ID of the user whose username you want to obtain. For example, the email ID for our test user is [email protected]
        3. A notification appears indicating an email has been sent.
        4. View your Mailhog inbox to see if you have received the Account Information - username email.
        5. Click the login link and log in with the username you received in the email.
        6. Log in with the obtained username and the password.
        7. Verify that you are able to log in as the user.

        There you have it, a simple way to set up mailhog, and the test password reset and forgotten username in a development environment.