Skip to content

Commit

Permalink
Document how to provide AWS credentials.
Browse files Browse the repository at this point in the history
  • Loading branch information
jdorn committed May 26, 2021
1 parent 203b9cc commit ba96bd6
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,14 @@ In addition, there are **client libraries** to help you implement A/B tests in [
- Lightweight idea board and prioritization framework
- Document everything! (upload screenshots, add markdown comments, and more)
- Automated email alerts when tests become significant
- Visual Editor for non-technical users to create experiments _(beta)_

## Community

Join [our Growth Book Users Slack community](https://join.slack.com/t/growthbookusers/shared_invite/zt-oiq9s1qd-dHHvw4xjpnoRV1QQrq6vUg) if you need help, want to chat, or are thinking of a new feature. We're here to help - and to make Growth Book even better.

View the developer docs at https://docs.growthbook.io

## Requirements

- NodeJS 12.x or higher (https://nodejs.org/en/)
Expand All @@ -43,6 +46,14 @@ yarn init:dev

Edit the default values in `packages/back-end/.env.local` and `packages/front-end/.env.local` as needed.

### S3

S3 is used to store uploaded experiment screenshots. We support multiple ways of providing credentials with the following order of precedence:

1. Environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` (on dev, add to `packages/back-end/.env.local`)
2. Shared credentials file `~/.aws/credentials`
3. ECS credentials provider or EC2 instance IAM role (when deployed to AWS)

### MongoDB

To quickly get a local MongoDB instance running for development, you can use docker:
Expand Down

0 comments on commit ba96bd6

Please sign in to comment.