Skip to content

chore: Update some documentation #1619

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: development
Choose a base branch
from
Open

chore: Update some documentation #1619

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions deploy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,9 +158,3 @@ From the `deploy` folder:
-H 'Content-Type: application/json' \
-d '{ "pathToFile": "/folder/path/to/copy/file/<environment>_dump_<timestamp>.sql" }'
```

## GitHub Workflow Automation Configuration

- The `jwt-signing-key.pem` file should be located in the project root folder. Obtain `ansible-vault-password.txt` from a project administrator and place it in the `deploy` folder. From within the `deploy` folder, you can run `ansible-vault view --vault-password-file ansible-vault-password.txt files/jwt-signing-key.pem.enc > ../jwt-signing-key.pem` to decrypt the configuration file.
- The `AUTOMATION_CALLBACK_FQDN` environment variable in the environment configuration file should be a **fully qualified domain name** that is accessible from the github workflow server pointing at the running instance of aria-at-app. For local development testing of these features, a forwarding proxy server like `ngrok` is recommended: `npx ngrok http 3000 --host-header=rewrite` will setup a server forwarding to your local 3000 development port. You can then use the domain it gives you when launching the app:
`AUTOMATION_CALLBACK_FQDN=128935b17294.ngrok.app yarn dev`
11 changes: 11 additions & 0 deletions docs/automation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Automation setup and configuration

This project makes use of an external github repository [aria-at-gh-actions-helper](https://github.com/bocoup/aria-at-gh-actions-helper) to launch github actions that run the automation suite.
More documentation about the tools used in that repository are in it's [README](https://github.com/bocoup/aria-at-gh-actions-helper/README.md).
This repository also has a second copy [aria-at-gh-actions-helper-dev](https://github.com/bocoup/aria-at-gh-actions-helper-dev) which is used in the staging or local environments by default to not get in the way of the queue for the live service.

## GitHub Workflow Automation Configuration

- The `jwt-signing-key.pem` file should be located in the project root folder. Obtain `ansible-vault-password.txt` from a project administrator and place it in the `deploy` folder. From within the `deploy` folder, you can run `ansible-vault view --vault-password-file ansible-vault-password.txt files/jwt-signing-key.pem.enc > ../jwt-signing-key.pem` to decrypt the configuration file.
- The `AUTOMATION_CALLBACK_FQDN` environment variable in the environment configuration file should be a **fully qualified domain name** that is accessible from the github workflow server pointing at the running instance of aria-at-app.
- For **local development** testing of these features, a forwarding proxy server like `ngrok` is recommended: `npx ngrok http 3000 --host-header=rewrite` will setup a server forwarding to your local 3000 development port. You can then use the domain it gives you when launching the app: `AUTOMATION_CALLBACK_FQDN=128935b17294.ngrok.app yarn dev`
Loading