Skip to content

Commit

Permalink
md update
Browse files Browse the repository at this point in the history
  • Loading branch information
pipelineburst committed Jul 30, 2024
1 parent 89b9aa8 commit a8589d0
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,19 @@ https://github.com/build-on-aws/agents-for-amazon-bedrock-sample-feature-noteboo
Create the virtual environment within the root of this project using this command

```
$ python3 -m venv .venv
python3 -m venv .venv
```

After the init process completes and the virtualenv is created, you can use the following step to activate your virtualenv.

```
$ source .venv/bin/activate
source .venv/bin/activate
```

Once the virtualenv is activated, you can install the required dependencies.

```
$ pip install -r requirements.txt
pip install -r requirements.txt
```

If you have not used CDK before you will need to [install the CDK CLI](https://docs.aws.amazon.com/cdk/v2/guide/cli.html).
Expand Down Expand Up @@ -73,7 +73,7 @@ cdk deploy --context dev=true
Use this context argument to deploy a supplementary Streamlit app and its supporting cloud services, such as an [Amazon ECS](https://aws.amazon.com/ecs/) cluster. **Note:** This option builds a container image in your execution environment, e.g. your local machine. You can install e.g. docker for that.

```
$ cdk deploy --context email_address=$EMAIL_ADDRESS
cdk deploy --context email_address=$EMAIL_ADDRESS
```

### Strealit HTTPS Support
Expand All @@ -89,21 +89,21 @@ cdk deploy --context acm_certificate_arn=$ACM_CERT_ARN
To add support for an authenticated user you must use the `email_address` flag which will deploy an [Amazon Cognito](https://aws.amazon.com/cognito/) user pool which sits in front of the application. A user will be created in the user pool and password distributed via email for you to login.

```
$ cdk deploy --context email_address=$EMAIL_ADDRESS
cdk deploy --context email_address=$EMAIL_ADDRESS
```

### Strealit Custom Domain Name

If you would like to add a custom domain name in front of the application you must specify the `domain_name` argument. This will allow Cognito hosts to recognise the domain when authenticating. Once you have deployed with this flag you will need to apply any DNS records resolving to this domain.

```
$ cdk deploy --context domain_name=$DOMAIN_NAME
cdk deploy --context domain_name=$DOMAIN_NAME
```

### Supporting Multiple Arguments

To support multiple arguments you simply append the `--context` flags after the previous argument. Please see the example below.

```
$ cdk deploy --context aacm_certificate_arn=$ACM_CERT_ARN --context email_address=$EMAIL_ADDRESS --context domain_name=$DOMAIN_NAME
cdk deploy --context aacm_certificate_arn=$ACM_CERT_ARN --context email_address=$EMAIL_ADDRESS --context domain_name=$DOMAIN_NAME
```

0 comments on commit a8589d0

Please sign in to comment.