diff --git a/README.md b/README.md index cb667cb..91eb998 100644 --- a/README.md +++ b/README.md @@ -239,7 +239,8 @@ the repository: Where `` will vary depending upon the databases we wish to activate. This command will also import seed data from the previous tutorials and provision the dummy IoT sensors on startup. -> :information_source: **Note:** If you want to clean up and start over again you can do so with the following command: +> [!NOTE] +> If you want to clean up and start over again you can do so with the following command: > > ```console > ./services stop @@ -398,7 +399,8 @@ curl -iX POST \ As you can see, the database used to persist context data has no impact on the details of the subscription. It is the same for each database. The response will be **201 - Created** -> :information_source: **Note:** if you see errors of the following form within the **Cygnus** log: +> [!NOTE] +> if you see errors of the following form within the **Cygnus** log: > > ``` > Received bad request from client. @@ -650,7 +652,8 @@ The `postgres-db` container is driven by environment variables as shown: | POSTGRES_USER | `postgres` | Username for the PostgreSQL database user | | POSTGRES_DB | `postgres` | The name of the PostgreSQL database | -> :information_source: **Note:** Passing the Username and Password in plain text environment variables like this is a +> [!NOTE] +> Passing the Username and Password in plain text environment variables like this is a > security risk. Whereas this is acceptable practice in a tutorial, for a production environment, you can avoid this > risk by applying [Docker Secrets](https://blog.docker.com/2017/02/docker-secrets-management/) @@ -702,7 +705,8 @@ The `cygnus` container is driven by environment variables as shown: | CYGNUS_API_PORT | `5080` | Port that Cygnus listens on for operational reasons | | CYGNUS_POSTGRESQL_ENABLE_CACHE | `true` | Switch to enable caching within the PostgreSQL configuration | -> :information_source: **Note:** Passing the Username and Password in plain text environment variables like this is a +> [!NOTE] +> Passing the Username and Password in plain text environment variables like this is a > security risk. Whereas this is acceptable practice in a tutorial, for a production environment, > `CYGNUS_POSTGRESQL_USER` and `CYGNUS_POSTGRESQL_PASS` should be injected using > [Docker Secrets](https://blog.docker.com/2017/02/docker-secrets-management/) @@ -999,7 +1003,8 @@ The `elasticsearch-db` container is driven by environment variables as shown: | ES_JAVA_OPTS | `-Xmx256m -Xms256m` | Setting JVM heap size. It is not recommended in production environment. | | ELASTIC_PASSWORD | `changeme` | Password for the PostgreSQL database user. | -> :information_source: **Note:** Passing the Password in plain text environment variables like this is a security risk. +> [!NOTE] +> Passing the Password in plain text environment variables like this is a security risk. > Whereas this is acceptable practice in a tutorial, for a production environment, you can avoid this risk by applying > [Docker Secrets](https://blog.docker.com/2017/02/docker-secrets-management/) @@ -1285,7 +1290,8 @@ mysql-db: - 'MYSQL_ROOT_HOST=%' ``` -> :information_source: **Note:** Using the default `root` user and displaying the password in an environment variables +> [!NOTE] +> Using the default `root` user and displaying the password in an environment variables > like this is a security risk. Whereas this is acceptable practice in a tutorial, for a production environment, you can > avoid this risk by setting up another user and applying > [Docker Secrets](https://blog.docker.com/2017/02/docker-secrets-management/) @@ -1329,7 +1335,8 @@ cygnus: - 'CYGNUS_SERVICE_PORT=5050' ``` -> :information_source: **Note:** Passing the Username and Password in plain text environment variables like this is a +> [!NOTE] +> Passing the Username and Password in plain text environment variables like this is a > security risk. Whereas this is acceptable practice in a tutorial, for a production environment, `CYGNUS_MYSQL_USER` > and `CYGNUS_MYSQL_PASS` should be injected using > [Docker Secrets](https://blog.docker.com/2017/02/docker-secrets-management/)