Skip to content

Commit

Permalink
clarifies dev environment setup details and access credentials
Browse files Browse the repository at this point in the history
closes #37
  • Loading branch information
AndriusA committed Dec 6, 2017
1 parent 6a8c515 commit 242da47
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ To launch the HAT, follow these steps:
```
4. Run the project:
```bash
sbt "project hat" -Dconfig.resource=dev.conf run
sbt "project hat" "run -Dconfig.resource=dev.conf"
```
5. Go to http://bobtheplumber.hat.org:9000

Expand All @@ -68,9 +68,16 @@ To launch the HAT, follow these steps:
### Customising development environment
Your best source of information on how the development environment could
be customised is the `hat/conf/dev.conf` configuration file. Make sure it
is *enabled* in `hat/conf/activeHats.conf` -- such setup is not intended
to be used in production, but becomes handy for local testing.
be customised is the `hat/conf/dev.conf` configuration file. Make sure you
run the project locally with the configuration enabled (using the steps above)
or it will just show you the message that the HAT could not be found.
Among other things, the configuration includes:
- host names alongside port numbers of the test HATs (bobtheplumber.hat.org:9000)
- access credentials used to log in as the owner or restricted platform user into the HAT (the default password is a very unsafe *testing*)
- database connection details (important if you want to change your database setup above)
- private and public keys used for token signing and verification
Specifically, it has 4 major sections:
Expand Down

0 comments on commit 242da47

Please sign in to comment.