Skip to content

Add additionalEnvironmentVariables documentation to README #2

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

Open
remote-swe-user wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add additionalEnvironmentVariables documentation to README #2

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
08ff260
docs: add additionalEnvironmentVariables feature documentation to Tip…
Apr 3, 2025
6c5b127
docs: change Japanese comments to English
Apr 3, 2025
f383829
docs: simplify additionalEnvironmentVariables examples
Apr 3, 2025
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
31 changes: 31 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,37 @@ To deploy on a closed network, please follow the steps below:
6. After the deployment, please configure Bedrock in Dify with the same AWS region as your VPC (see [setup section](#setup-dify-to-use-bedrock))
* This is **only required** if Bedrock API in other regions are not accessible from your vpc subnets.

### Additional Environment Variables

You can configure additional environment variables for Dify containers by using the `additionalEnvironmentVariables` property:

```typescript
new DifySelfHostedOnAwsStack(app, 'DifySelfHostedOnAwsStack', {
additionalEnvironmentVariables: [
{
// Example of applying environment variable to all containers
key: 'GLOBAL_SETTING',
value: 'value',
// Omitting targets applies to all containers
},
{
// Example of referencing Systems Manager parameter
key: 'CONFIG_PARAM',
value: { parameterName: 'my-parameter' },
targets: ['web', 'api'],
},
{
// Example of referencing a specific field in Secrets Manager
key: 'API_KEY',
value: { secretName: 'my-secret', field: 'apiKey' },
targets: ['worker'],
},
],
});
```

This feature allows you to inject custom environment variables into Dify containers. The container types that can be specified in `targets` are `'web'`, `'api'`, `'worker'`, and `'sandbox'`.

### Connect to Notion

You can connect to [Notion](https://www.notion.com/) data by the following steps:
Expand Down