Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
coolbeevip committed Nov 9, 2023
1 parent 3ef160e commit ddd7bc9
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,20 @@

🔍 This application consistently conducts active surveillance on the specified port of the instance. 🚫If access is obstructed, it will renew the static IP of the instance ⚡ and update the domain name record 🔄.

## Environment
## Quick Start

```shell
docker run -d --rm --name guard \
-e AWS_ACCESS_KEY_ID=<your aws access key id> \
-e AWS_SECRET_ACCESS_KEY=<your aws secret access key> \
-e REGION_NAME=<region of instance> \
-e LIGHTSAIL_INSTANCE_NAME=<instance name> \
-e DOMAIN_ENTRY_NAME=<your domain> \
-e LIGHTSAIL_INSTANCE_PORT=<port for inspection> \
coolbeevip/aws-lightsail-guard
```

## Dev Environment

Create .env file in the root directory of the project, and add the following content:

Expand All @@ -20,11 +33,12 @@ LIGHTSAIL_INSTANCE_PORT=<port for inspection>
DOMAIN_ENTRY_NAME=<your domain>
```

## Usage
Run the following command to start the application:

```bash
python main.py
```

# Reference

* https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/lightsail.html

0 comments on commit ddd7bc9

Please sign in to comment.