Skip to content

Commit e325158

Browse files
committed
fix: sync READMEs
1 parent 97542d5 commit e325158

File tree

3 files changed

+23
-4
lines changed

3 files changed

+23
-4
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@ Install the Defang CLI from one of the following sources:
8888
## Support
8989
9090
- File any issues [here](https://github.com/DefangLabs/defang/issues)
91+
- Join our [Discord community](https://s.defang.io/discord) for real-time help and discussions
9192
9293
## Command completion
9394
@@ -148,6 +149,7 @@ The Defang CLI recognizes the following environment variables:
148149
- `DEFANG_PULUMI_BACKEND` - The Pulumi backend URL or `"pulumi-cloud"`; defaults to a self-hosted backend
149150
- `DEFANG_PULUMI_DIR` - Run Pulumi from this folder, instead of spawning a cloud task; requires `--debug` (BYOC only)
150151
- `DEFANG_PULUMI_VERSION` - Override the version of the Pulumi image to use (`aws` provider only)
152+
- `DEFANG_TENANT` - The name of the tenant to use.
151153
- `NO_COLOR` - If set to any value, disables color output; by default, color output is enabled depending on the terminal
152154
- `PULUMI_ACCESS_TOKEN` - The Pulumi access token to use for authentication to Pulumi Cloud; see `DEFANG_PULUMI_BACKEND`
153155
- `PULUMI_CONFIG_PASSPHRASE` - Passphrase used to generate a unique key for your stack, and configuration and encrypted state values

pkgs/npm/README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ![Defang](https://raw.githubusercontent.com/DefangLabs/defang-assets/main/Logos/Element_Wordmark_Slogan/JPG/Dark_Colour_Glow.jpg)
22

3-
Develop Anything, Deploy Anywhere. Take your app from Docker Compose to a secure and scalable deployment on your favorite cloud in minutes.
3+
Develop Once, Deploy Anywhere. Take your app from Docker Compose to a secure and scalable deployment on your favorite cloud in minutes.
44

55
- Public releases of the Defang CLI; [click here](https://github.com/DefangLabs/defang/releases/latest/) for the latest version
66
- Sample projects in Golang, Python, Node.js, and many more languages and frameworks, that show you how to accomplish various tasks and deploy them to the DOP using a Docker Compose file and the Defang CLI.
@@ -17,26 +17,43 @@ Develop Anything, Deploy Anywhere. Take your app from Docker Compose to a secure
1717
## Support
1818

1919
- File any issues [right here on GitHub](https://github.com/DefangLabs/defang/issues)
20+
- Join our [Discord community](https://s.defang.io/discord) for real-time help and discussions
2021

2122
## Environment Variables
2223

2324
The Defang CLI recognizes the following environment variables:
2425

2526
- `COMPOSE_PROJECT_NAME` - The name of the project to use; overrides the name in the `compose.yaml` file
2627
- `DEFANG_ACCESS_TOKEN` - The access token to use for authentication; if not specified, uses token from `defang login`
28+
- `DEFANG_BUILD_CONTEXT_LIMIT` - The maximum size of the build context when building container images; defaults to `100MiB`
2729
- `DEFANG_CD_BUCKET` - The S3 bucket to use for the BYOC CD pipeline; defaults to `defang-cd-bucket-…`
2830
- `DEFANG_CD_IMAGE` - The image to use for the Continuous Deployment (CD) pipeline; defaults to `public.ecr.aws/defang-io/cd:public-beta`
2931
- `DEFANG_DEBUG` - set this to `1` or `true` to enable debug logging
3032
- `DEFANG_DISABLE_ANALYTICS` - If set to `true`, disables sending analytics to Defang; defaults to `false`
33+
- `DEFANG_EDITOR` - The editor to launch after new project generation; defaults to `code` (VS Code)
3134
- `DEFANG_FABRIC` - The address of the Defang Fabric to use; defaults to `fabric-prod1.defang.dev`
35+
- `DEFANG_JSON` - If set to `true`, outputs JSON instead of human-readable output; defaults to `false`
3236
- `DEFANG_HIDE_HINTS` - If set to `true`, hides hints in the CLI output; defaults to `false`
3337
- `DEFANG_HIDE_UPDATE` - If set to `true`, hides the update notification; defaults to `false`
34-
- `DEFANG_PROVIDER` - The name of the cloud provider to use, `auto` (default), `aws`, `digitalocean`, or `defang`
38+
- `DEFANG_ISSUER` - The OAuth2 issuer to use for authentication; defaults to `https://auth.defang.io`
39+
- `DEFANG_MODEL_ID` - The model ID of the LLM to use for the generate/debug AI integration (Pro users only)
40+
- `DEFANG_NO_CACHE` - If set to `true`, disables pull-through caching of container images; defaults to `false`
41+
- `DEFANG_ORG` - The name of the organization to use; defaults to the user's GitHub name
42+
- `DEFANG_PREFIX` - The prefix to use for all BYOC resources; defaults to `Defang`
43+
- `DEFANG_PROVIDER` - The name of the cloud provider to use, `auto` (default), `aws`, `digitalocean`, `gcp`, or `defang`
44+
- `DEFANG_PULUMI_BACKEND` - The Pulumi backend URL or `"pulumi-cloud"`; defaults to a self-hosted backend
45+
- `DEFANG_PULUMI_DIR` - Run Pulumi from this folder, instead of spawning a cloud task; requires `--debug` (BYOC only)
46+
- `DEFANG_PULUMI_VERSION` - Override the version of the Pulumi image to use (`aws` provider only)
3547
- `DEFANG_TENANT` - The name of the tenant to use.
3648
- `NO_COLOR` - If set to any value, disables color output; by default, color output is enabled depending on the terminal
49+
- `PULUMI_ACCESS_TOKEN` - The Pulumi access token to use for authentication to Pulumi Cloud; see `DEFANG_PULUMI_BACKEND`
50+
- `PULUMI_CONFIG_PASSPHRASE` - Passphrase used to generate a unique key for your stack, and configuration and encrypted state values
3751
- `TZ` - The timezone to use for log timestamps: an IANA TZ name like `UTC` or `Europe/Amsterdam`; defaults to `Local`
3852
- `XDG_STATE_HOME` - The directory to use for storing state; defaults to `~/.local/state`
3953

54+
Environment variables will be loaded from a `.defangrc` file in the current directory, if it exists. This file follows
55+
the same format as a `.env` file: `KEY=VALUE` pairs on each line, lines starting with `#` are treated as comments and ignored.
56+
4057
---
4158

42-
Made by [Defang Labs](https://defang.io)
59+
Made by [Defang Labs](https://defang.io)

src/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ The Defang Command-Line Interface [(CLI)](https://docs.defang.io/docs/getting-st
1717
## Support
1818

1919
- File any issues [here](https://github.com/DefangLabs/defang/issues)
20+
- Join our [Discord community](https://s.defang.io/discord) for real-time help and discussions
2021

2122
## Environment Variables
2223

@@ -52,4 +53,3 @@ The Defang CLI recognizes the following environment variables:
5253

5354
Environment variables will be loaded from a `.defangrc` file in the current directory, if it exists. This file follows
5455
the same format as a `.env` file: `KEY=VALUE` pairs on each line, lines starting with `#` are treated as comments and ignored.
55-

0 commit comments

Comments
 (0)