Page Comparison

...

1. Sign into the AWS management console and open the AWS Amplify console for your organisation. You should see a page with the title ‘All apps’.

2. For your first time, you will need to create an Amplify application. To do this, select ‘New app’, and then select ‘Host web app’.

3. On the next page, select GitLab GitHub as your repository provider, and click ‘Continue’.

4. If you are asked to authorize with GitHub, continue, select openlibraryenvironment, and then choose ‘select repositories’ and select dcb-admin-ui from the dropdown.

5. On the ‘Add repository branch’ page,

   1. select the dcb-admin-ui repository

   . You will then be asked to select a branch: we will provide you with the name of the branch to select, so please choose that one

   1. (https://github.com/openlibraryenvironment/dcb-admin-ui)

   2. select the release branch and continue.

6. In the IAM Role section, On the ‘build settings’ page, select ‘Enable SSR logs' if it is not automatically selected, and then choose ‘Create and use a new service role’ to allow Amplify to automatically create a service role for you.

   1. If you have a previously created service role that you want to use instead, select that option.

7. Choose ‘Next’, and then click ‘Save and deploy’.

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. Enter 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:

...

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

5. 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.

...

Common errors and how to solve them

• 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)
      

      

• 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 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