diff --git a/README.md b/README.md index eecba37..51adbad 100644 --- a/README.md +++ b/README.md @@ -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= \ +-e AWS_SECRET_ACCESS_KEY= \ +-e REGION_NAME= \ +-e LIGHTSAIL_INSTANCE_NAME= \ +-e DOMAIN_ENTRY_NAME= \ +-e LIGHTSAIL_INSTANCE_PORT= \ +coolbeevip/aws-lightsail-guard +``` + +## Dev Environment Create .env file in the root directory of the project, and add the following content: @@ -20,11 +33,12 @@ LIGHTSAIL_INSTANCE_PORT= DOMAIN_ENTRY_NAME= ``` -## 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 \ No newline at end of file