Skip to content

Commit

Permalink
chore: update README and .env.example with ssh key info (#1133)
Browse files Browse the repository at this point in the history
02_fetch_ssh_keys.sh has been updated to pull ssh keys from env vars, so update README and .env.example to match
  • Loading branch information
jacobkwan authored Feb 19, 2024
1 parent 671f75d commit bcb9370
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
5 changes: 5 additions & 0 deletions .env-example
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,8 @@ export GROWTHBOOK_CLIENT_KEY=""

# Uptime robot
export UPTIME_ROBOT_API_KEY=""

# Git SSH Keys
export ENV_TYPE="LOCAL"
export LOCAL_SSH_PUBLIC_KEY=""
export LOCAL_SSH_PRIVATE_KEY=""
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

1. grab a copy of the environment variables from the 1PW Isomer vault
2. ensure that you have your `AWS_ACCESS_KEY_ID` together with `AWS_SECRET_ACCESS_KEY`. These can be generated from the IAM console, under security credentials. (see [here](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) for more details)
3. next, generate your ssh keys and save them under `.ssh/github` and `.ssh/github.pub`. (See [here](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) for details on generating a new SSH key and adding it to your Github account.)
3. next, generate your ssh keys and add them to the .env file. (See [here](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) for details on generating a new SSH key and adding it to your Github account.)
4. run `npm run dev`

## Setup
Expand Down

0 comments on commit bcb9370

Please sign in to comment.