Skip to content

Commit b349051

Browse files
committed
update config info
1 parent 994401f commit b349051

File tree

2 files changed

+22
-6
lines changed

2 files changed

+22
-6
lines changed

samples/rails/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,14 @@ This template is a member list project developed using Ruby on Rails, offering a
1717
3. Open up a shell in the VS Code terminal and run `docker compose -f compose.dev.yaml up`.
1818

1919

20+
## Configuration
21+
22+
For this sample, you will need to provide the following [configuration](https://docs.defang.io/docs/concepts/configuration). Note that if you are using the 1-click deploy option, you can set these values as secrets in your GitHub repository and the action will automatically deploy them for you.
23+
24+
### `POSTGRES_PASSWORD`
25+
This password will be used to initialize the PostgreSQL database and to connect to it.
26+
27+
2028
## Deployment
2129

2230
> [!NOTE]

starter-sample/README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This is a sample that shows the rough structure of an actual Defang sample. This
66

77
## Prerequisites
88

9-
1. Download [Defang CLI](https://github.com/DefangLabs/defang)
9+
1. [!NOTE] Download [Defang CLI](https://github.com/DefangLabs/defang)
1010
2. (Optional) If you are using [Defang BYOC](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) authenticated with your AWS account
1111
3. (Optional for local development) [Docker CLI](https://docs.docker.com/engine/install/)
1212

@@ -27,13 +27,21 @@ For this sample, you will need to provide the following [configuration](https://
2727
### `API_KEY` #REMOVE_ME_AFTER_EDITING
2828
An explanation of what the env var (`API_KEY`) is, etc.
2929

30+
## Deployment
3031

31-
## Deploying
32+
> [!NOTE]
33+
> Download [Defang CLI](https://github.com/DefangLabs/defang)
3234
33-
1. Open the terminal and type `defang login`
34-
2. Use the [`defang config`](https://docs.defang.io/docs/concepts/compose#configuration) command to setup environment variables. #REMOVE_ME_AFTER_EDITING
35-
3. Type `defang compose up` in the CLI.
36-
4. Your app will be running within a few minutes.
35+
### Defang Playground
36+
37+
Deploy your application to the defang playground by opening up your terminal and typing `defang up`.
38+
39+
### BYOC (AWS)
40+
41+
If you want to deploy to your own cloud account, you can use Defang BYOC:
42+
43+
1. [Authenticate your AWS account](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html), and that you have properly set your environment variables like `AWS_PROFILE`, `AWS_REGION`, `AWS_ACCESS_KEY_ID`, and `AWS_SECRET_ACCESS_KEY`.
44+
2. Run `defang up` in a terminal that has access to your AWS environment variables.
3745

3846
---
3947

0 commit comments

Comments
 (0)