Skip to content

Update setup instructions for db #217

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 6, 2025
Merged

Update setup instructions for db #217

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 16 additions & 19 deletions db/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,37 +12,34 @@ You can use the scripts in this directory (`db`, `run-proxy`) to connect and int

`db` depends on `mysql` v8.

### Required Environment Variables

Before starting, ensure you have set the following environment variables. The credentials and the cloud SQL database info are available from 1Password's team vault.

- `GCLOUD_AUTH`
- `CLOUD_SQL_CONNECTION_NAME`
- `CLOUD_SQL_DATABASE_PORT`
- `CLOUD_SQL_DATABASE_USERNAME`
- `CLOUD_SQL_DATABASE_PASSWORD`
- `CLOUD_SQL_DATABASE_NAME`: The name of the database to use currently. Example: `preflight`.
- `CLOUD_SQL_CREDENTIALS`: The location of cloud-sql-proxy.json file, which is available from 1Password.

### Setup Instructions

1. Download the dependencies: Google Cloud CLI and MySQL v8.
1. Open `Cloud SQL auth credentials / config` from 1Password's team vault. Save the following variables in
your shell's `rc` file (or a file that your `rc` file imports)
* `CLOUD_SQL_DATABASE_USERNAME`
* `CLOUD_SQL_DATABASE_PASSWORD`
* `CLOUD_SQL_DATABASE_NAME` (use `preflight`)
* `CLOUD_SQL_DATABASE_HOST`
* `CLOUD_SQL_DATABASE_PORT`
2. Download `cloud-sql-proxy.json` from 1Password. Save the file somewhere under your home directory. Note the path.
3. Add `CLOUD_SQL_CREDENTIALS` to the `rc` file. The value the path of `cloud-sql-proxy.json`.
4. Download the dependencies: Google Cloud CLI and MySQL v8.
```
brew install gcloud
brew install gcloud-cli
brew install [email protected]
```
2. Log in to Google Cloud and configure the project name.
5. Log in to Google Cloud and configure the project name.
```
gcloud auth login
gcloud config set project [GCP project name]
```
3. Download the [Cloud SQL Auth Proxy](https://cloud.google.com/sql/docs/mysql/connect-auth-proxy#install) appropriate for your OS.
4. Place the binary in this `DB/` directory.
5. Open a terminal tab and run:
6. Download the [Cloud SQL Auth Proxy](https://cloud.google.com/sql/docs/mysql/connect-auth-proxy#install) appropriate for your OS.
7. Place the binary in this `DB/` directory.
8. Open a terminal tab and run:
```
./run-proxy
```
6. In another terminal tab, run:
9. In another terminal tab, run:
```
./db -h
```
Expand Down