Versions Compared

Old Version 20

changes.mady.by.user Casey Henderson

Saved on

compared with

New Version 21

changes.mady.by.user Casey Henderson

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

If you notice that the framework for your app is automatically set to ‘web’ instead of ‘Next.js - SSR', please scroll down to the ‘Common errors' section of this document and follow the instructions for updating the framework manually.

This section also has instructions for updating the app platform manually - on rare occasions Amplify will automatically set it to ‘Web’ when it should be ‘Web compute’.

For more information, please refer to the relevant AWS Amplify docs.

Setting up environment variables and Keycloak

  1. To set up the necessary environment variables for DCB Admin, you must navigate to ‘App settings’ and then to ‘Environment variables’.

  2. Add the required environment variables from the table below. Some of these variables are deployment-specific, and others will need to come from your Keycloak configuration.

  3. You will then need to modify the Amplify build specification file amplify.yml to make these variables accessible to Next.js. This can be found under ‘App build specification’ in ‘Build settings’. Simply click ‘Edit’ and add these lines under build: commands:

...

  1. Save your changes and redeploy your application - go to ‘All apps', click on your deployment and select ‘redeploy this version’.

  2. Navigate to your Keycloak Admin UI, select dcb-hub and then select dcb from ‘clients'. You will then need to add the URL of your deployment to ‘Valid redirect URIs’ and 'Valid post-logout redirect URIs’ like so: https://<your-app-URL>/*. This must be done for all URLs to which DCB Admin is deployed.

For more information please refer to the official documentation.

...

  • If you encounter the following error (or similar) when deploying DCB Admin, there is a simple fix: CustomerError: It looks like you are attempting to deploy a Next.js SSR app, but your app's framework looks wrong. Please update your app's framework to 'Next.js - SSR' to ensure that your app is deployed correctly.

    • Solution: Run the following command in CloudShell. This will update the framework manually:

      • aws amplify update-branch --app-id <value> --branch-name <value> --framework 'Next.js - SSR'

      • The value of app-id can be found under ‘App ARN’ in App settings → General. It is the value at the end of the ARN (highlighted in the screenshot)

        image-20240314-142025.png

  • If you deploy successfully, but encounter a 404 Not Found page when you click on the branch URL, your app platform may have been set incorrectly by Amplify (see this GitHub issue - it should be Web compute). To fix this, run this the command aws amplify update-app --app-id <APP_ID> --platform WEB_COMPUTE --region <REGION>, getting the value of app-id with the method described above.

  • If you encounter an error when attempting to login (i.e. the URL changes to indicate an OAuthSignInError), please confirm that your Keycloak server is up, and that you have added the correct URL of your DCB Admin deployment to the ‘Valid redirect URIs’ and ‘Valid post-logout redirect URIs’ in your Keycloak admin UI.

  • If you encounter an error connecting to the repository, please contact Knowledge Integration.

  • Amplify docs can be found here for further context and troubleshooting https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html