Skip to content

Commit

Permalink
Upd: Instructions to run using make builds as well as via docker images
Browse files Browse the repository at this point in the history
  • Loading branch information
lalc authored Nov 17, 2023
1 parent 2a4c67d commit aea8445
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,43 @@ This repository hosts source code for the reference implementation of the GovSta

Released. Refer to the [wiki page](https://github.com/decentralised-dataexchange/bb-consent-docs/wiki/wps-and-deliverables) for the latest status of the deliverables.

## Instructions to run the docker image

`docker run -p 3030:80 igrantio/bb-consent-privacy-dashboard:<tag>`

Example: To run 2023.11.4 execute the following command in the terminal

`docker run -p 3030:80 igrantio/bb-consent-privacy-dashboard:2023.11.4`

In case you wish to override the base URL for consent-bb API server to connect to from the admin dashboard, use the following command:

`docker run -v ./config.json:/usr/share/nginx/html/config/config.json -p 3030:80 igrantio/bb-consent-privacy-dashboard:2023.11.4`

A sample config

```
{
"baseUrl": "https://api.igrant.dev/v2",
"redirectUrl": "https://staging-consent-bb-privacy-dashboard.igrant.io/login",
"clientId": "igrant-ios-app"
}
```

The privacy dashboard can be run at http://localhost:3030/#/login.

## Instructions to build from source and run

Follow the steps below to get the admin dashboard up and running locally.

1. Clone this repository to your local server using `git clone`.
2. Check out the latest release or any available release you wish to run.
3. Modify the `public/config/config.json` file attribute `baseUrl` in the root folder to point to the Consent BB API server instance.
4. Execute `make setup`. This establishes the necessary dependencies and configurations for running the admin dashboard instance.
5. Execute `make build`. The compiles and assembles source code into executable files or libraries, following the instructions specified in the Makefile of the admin dashboard instance.
6. Execute `make run`. This executes a predefined set of instructions in the Makefile to launch or run the compiled admin dashboard server instance.

The consent BB admin dashboard can now be accessed at [https://privacy.bb-consent.dev](https://privacy.bb-consent.dev) If you have security issues with your browser, you must establish a self-signed certificate.

## Other resources

* Wiki - https://github.com/decentralised-dataexchange/consent-dev-docs/wiki
Expand Down

0 comments on commit aea8445

Please sign in to comment.