Skip to content

Commit 8103664

Browse files
committed
tweaked readme
1 parent def2ebd commit 8103664

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,10 @@ All requirements for running the API are packaged and uploaded to AWS as a lambd
2222
7. Get the URL of the deployed API endpoint by running `hatch run ./get_api_url.py` in the root directory.
2323
8. Get the API Key generated by AWS by running `hatch run ./get_api_key.py` in the root directory. The deployment is configured to reject any API call that does not have this key passed via the `x-api-key` HTTP header.
2424

25-
For convenience `./deploy.sh` in the project root will clean the environment and perform all of these steps (using `-var="dnssec_enabled=false"`), with the exception of copying over the example config to the operational config and running `tofu init` in the open-tofu dir.
26-
In addition, `hatch run lambda:prepare` will run steps 2-5 in a single command.
27-
Finally, `hatch run lambda:deploy` will clean the environment and then run steps 2-6, in the same manner as `deploy.sh`.
25+
For convenience:
26+
* `./deploy.sh` in the project root will clean the environment and perform steps 2-6 (using `-var="dnssec_enabled=false"`), with the exception of copying over the example config to the operational config and running `tofu init` in the open-tofu dir.
27+
* `hatch run lambda:prepare` will run steps 2-5 in a single command.
28+
* `hatch run lambda:deploy` will clean the environment and then run steps 2-6, in the same manner as `deploy.sh`.
2829

2930
## Testing
3031
The following is an example of a test API call that uses bash command substitution to fill in the proper values for the API URL and the API key.

0 commit comments

Comments
 (0)