Skip to content

Commit 7434202

Browse files
committed
Update instructions for Windows
1 parent d9ed963 commit 7434202

1 file changed

Lines changed: 35 additions & 13 deletions

File tree

examples/chem-sync-local-flask/README.md

Lines changed: 35 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,12 @@ Create an empty placeholder file for Docker secrets. *nix example:
2424
touch .client_secret
2525
```
2626

27+
Windows example:
28+
29+
```cmd
30+
echo.> .client_secret
31+
```
32+
2733
Start Docker:
2834

2935
```bash
@@ -32,6 +38,11 @@ docker compose up --build -d
3238

3339
Tip: You can omit the `-d` option if you want to run in the foreground. Otherwise, use `docker compose logs -f` to tail logs.
3440

41+
> ℹ️ **Windows Note 1:** "Use ContainerD for pulling and storing images" may need to be enabled in `Docker > Settings > Features in development > Beta Features`
42+
43+
> ℹ️ **Windows Note 2**: If running into an error like "ERROR: request returned Bad Gateway for API route and version", [this solution](https://github.com/docker/for-mac/issues/6956#issuecomment-1876444658) may fix the problem.
44+
45+
3546
You can verify that Flask is up and running:
3647

3748
```bash
@@ -101,19 +112,6 @@ Generate a client secret in Benchling and be sure to copy the secret.
101112

102113
![image info](./docs/generate-secret.gif)
103114

104-
One easy way to set these environment variables for Docker is to add a `.env` file.
105-
106-
```bash
107-
touch .env
108-
```
109-
110-
Open it in an editor of your choice and set the values with the plaintext client ID
111-
for your App. For example:
112-
113-
```
114-
CLIENT_ID=42a0cd39-0543-4dd2-af02-a866c97f0c4d
115-
```
116-
117115
Since the client secret is sensitive, it's handled a bit differently. It's
118116
registered as a `secret` in our `docker-compose.yaml` file, which will be looking
119117
for a file `./client_secret`.
@@ -130,6 +128,30 @@ pbpaste > .client_secret
130128
131129
You'll then need to restart _just_ the `benchling-app` Docker service to pick up the changes:
132130

131+
### Setting Client ID
132+
133+
Our App needs a Client ID to pair with the Client Secret for authentication to Benchling. In this case, we've created our
134+
App to accept `CLIENT_ID` as an environment variable.
135+
136+
One easy way to set an environment variables for Docker is to add a `.env` file.
137+
138+
```bash
139+
touch .env
140+
```
141+
142+
Windows example:
143+
144+
```cmd
145+
echo.> .env
146+
```
147+
148+
Open it in an editor of your choice and set the values with the plaintext client ID
149+
for your App. For example:
150+
151+
```
152+
CLIENT_ID=42a0cd39-0543-4dd2-af02-a866c97f0c4d
153+
```
154+
133155
```
134156
docker-compose up -d
135157
```

0 commit comments

Comments
 (0)