Skip to content

Commit

Permalink
Prettify
Browse files Browse the repository at this point in the history
  • Loading branch information
jason-fox committed Jun 4, 2024
1 parent b6b440c commit 93c4597
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,9 +227,10 @@ The `keyrock` container is a web application server listening on two ports:
- Port `3443` has been exposed for secure HTTPS traffic for the site and REST API

> [!NOTE]
> HTTPS should be used throughout for any secured application, but to do this properly,
> **Keyrock** requires a trusted SSL certificate - the default certificate is self-certified and available for testing
> purposes. The certificates can be overridden by attaching a volume to replace the files under `/opt/fiware-idm/certs`.
>
> HTTPS should be used throughout for any secured application, but to do this properly, **Keyrock** requires a trusted
> SSL certificate - the default certificate is self-certified and available for testing purposes. The certificates can
> be overridden by attaching a volume to replace the files under `/opt/fiware-idm/certs`.
>
> In a production environment, all access should occur over HTTPS, to avoid sending any sensitive information using
> plain-text. Alternatively HTTP can be used within a private network behind a configured HTTPS Reverse Proxy
Expand All @@ -252,10 +253,10 @@ The `keyrock` container is driven by environment variables as shown:
| IDM_HTTPS_PORT | `3443` | Port used by the **Keyrock** App Server for HTTP traffic this has been altered from the default 443 |

> [!NOTE]
> that this example has secured the MySQL password using **Docker Secrets** By using
> `IDM_DB_PASS` with the `_FILE` suffix and referring to a secrets file location. This avoids exposing the password as
> an `ENV` variable in plain-text - either in the `Dockerfile` Image or as an injected variable which could be read
> using `docker inspect`.
>
> that this example has secured the MySQL password using **Docker Secrets** By using `IDM_DB_PASS` with the `_FILE`
> suffix and referring to a secrets file location. This avoids exposing the password as an `ENV` variable in
> plain-text - either in the `Dockerfile` Image or as an injected variable which could be read using `docker inspect`.
>
> The following list of variables (where used) should be set via secrets with the `_FILE` suffix in a Production System:
>
Expand Down Expand Up @@ -317,6 +318,7 @@ git checkout NGSI-LD
```

> [!NOTE]
>
> The initial creation of Docker images can take up to three minutes

Thereafter, all services can be initialized from the command-line by running the
Expand All @@ -330,6 +332,7 @@ repository:
Where `<command>` will vary depending upon the exercise we wish to activate.

> [!NOTE]
>
> If you want to clean up and start over again you can do so with the following command:
>
> ```console
Expand Down

0 comments on commit 93c4597

Please sign in to comment.