Skip to content

Commit 0c3595f

Browse files
author
Nick Grippin
committed
update standalone readme
1 parent 3822673 commit 0c3595f

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,11 @@ docker-compose -f docker-dev.yml up
157157

158158
When finished, use `docker-compose down` to gracefully stop the running containers.
159159

160+
In order to not get Postgres connection error upon signing a submission, you may want to start up the keycloak image as well.
161+
```shell
162+
docker-compose up keycloak
163+
```
164+
Not having the keycloak image running will produce an error in the console, but will not cause the platform to crash.
160165

161166
#### Running the API
162167

@@ -214,13 +219,13 @@ The Filing API will run on `$(docker-machine ip):8080`
214219
The Public API will run on `$(docker-machine ip):8082`
215220

216221
By default, the `HDMA Platform` runs with a log level of `INFO`. This can be changed by establishing a different log level in the `HMDA_LOGLEVEL` environment variable.
217-
For the different logging options, see the [reference.conf](https://github.com/akka/akka/blob/master/akka-actor/src/main/resources/reference.conf#L38) default configuration file for `Akka`.
222+
For the different logging options, see the [reference.conf](https://github.com/akka/akka/blob/master/akka-actor/src/main/resources/reference.conf#L38) default configuration file for `Akka`.
218223

219224
#### To run the entire platform
220225

221226
1. Ensure you have a Docker Machine with sufficient resources, as described in the [Docker](#docker) section above.
222227

223-
1. Clone [hmda-platform-ui](https://github.com/cfpb/hmda-platform-ui) and
228+
1. Clone [hmda-platform-ui](https://github.com/cfpb/hmda-platform-ui) and
224229
[hmda-platform-auth](https://github.com/cfpb/hmda-platform-auth) into the same
225230
directory as hmda-platform.
226231

@@ -270,7 +275,7 @@ For the different logging options, see the [reference.conf](https://github.com/a
270275
**Note:** You must register with an email address from our whitelist of email domains.
271276
For convenience, `bank0.com` and `bank1.com` address should be available automatically.
272277

273-
1. Browse to the mock email server at https://192.168.99.100:8443/mail/, and select the
278+
1. Browse to the mock email server at https://192.168.99.100:8443/mail/, and select the
274279
verification link in the email found there. This should take you back to the HMDA
275280
filing web app, now logged in.
276281

@@ -281,7 +286,7 @@ For the different logging options, see the [reference.conf](https://github.com/a
281286

282287
##### Updating an existing system
283288

284-
If you've updated any of the hmda-platform services, and would like to see those
289+
If you've updated any of the hmda-platform services, and would like to see those
285290
changes reflected in the Docker Compose setup, the simplest way to do this is to
286291
rebuild everything from scratch. The following command should be executed from
287292
within the `hmda-platform` directory.

docker-dev.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ services:
1111
ports:
1212
- '9042:9042'
1313
- '7000:7000'
14-
- '7199:7199'
14+
- '7199:7199'

0 commit comments

Comments
 (0)