You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[board-server] Implement support for simple secrets.
- **Factor out SecretProvider and SecretManagerProvider.**
- **Add SimpleSecretsProvider.**
- **docs(changeset): Implement support for simple secret provider.**
Fixesbreadboard-ai#2963.
Copy file name to clipboardExpand all lines: packages/board-server/README.md
+52Lines changed: 52 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -135,3 +135,55 @@ npm run deploy
135
135
```
136
136
137
137
This will build the project and deploy it to App Engine.
138
+
139
+
## Using secrets
140
+
141
+
If you wish to run boards on the server, you will need to store secrets on the board server.
142
+
143
+
Currently, there are two choices: using [Google Cloud Secret Manager](https://cloud.google.com/security/products/secret-manager?hl=en) and using the `secrets.json` file.
144
+
145
+
The choice is based on the value of the `STORAGE_BACKEND` variable.
146
+
147
+
If the value is `sqlite`, the `secrets.json` file will be used to retrieve the secrets.
148
+
149
+
If the value is `firestore`, the Google Cloud Secret Manager will be used.
150
+
151
+
Each secret must contain three pieces of information:
152
+
153
+
-**name**, such as `GEMINI_KEY`. This name should match the key that the boards use to ask for this secret.
154
+
155
+
-**value** -- the value of the secret.
156
+
157
+
-**origin** -- the associated [origin](https://developer.mozilla.org/en-US/docs/Glossary/Origin) of the key. The secrets are most often used to gain access to various service APIs. To ensure that only those services can see their secret, the secrets are bound to the origin of the service.
158
+
159
+
### Storing secrets with `secrets.json`
160
+
161
+
At the root of the repository, place the file named `secrets.json`.
0 commit comments