daniel/route53-compare
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Daniel Brown
2024-09-18 18:06:22 +00:00
parent f708fdbd4b
commit d733d70d75
1 changed files with 4 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -25,7 +25,7 @@ This Bash script helps you identify which assets in your AWS Route53 hosted zone
**Setup** **Setup**
--------- ---------
1. **Create a .env file:** In the same directory as the script, create a file named .env with the following content: **Create a .env file:** In the same directory as the script, create a file named .env with the following content:
Replace the placeholders with your actual AWS profile name, JupiterOne API key, and JupiterOne account ID. Replace the placeholders with your actual AWS profile name, JupiterOne API key, and JupiterOne account ID.
``` ```
AWS_PROFILE=your_aws_profile_name AWS_PROFILE=your_aws_profile_name
@@ -37,12 +37,12 @@ J1_ACCOUNT=your_jupiterone_account\id
**Usage** **Usage**
--------- ---------
1. **Make the script executable: 1. Make the script executable:
```bash ```bash
chmod +x dangle.sh chmod +x dangle.sh
``` ```
2. **Run the script: 2. Run the script:
```bash ```bash
./dangle.sh ./dangle.sh
or or
@@ -59,13 +59,4 @@ The script will output the DNS records and whether or not a corresponding asset
* **Additional Record Types:** Currently the script only handles A and CNAME records. We should extend it to support other record types like MX, TXT, etc. * **Additional Record Types:** Currently the script only handles A and CNAME records. We should extend it to support other record types like MX, TXT, etc.
* **JupiterOne Query:** The JupiterOne query is currently VERY simple. We might want to refine it. * **JupiterOne Query:** The JupiterOne query is currently VERY simple. We might want to refine it.
**Remember:**
* Replace script\_name.sh with the actual filename of your script.
* Ensure the .env file is in the same directory as the script.
* Consider adding more details to the README, such as examples of the output, potential use cases, or troubleshooting tips.