Skip to content

Commit dc508a6

Browse files
committed
Add 1-Click Deploy docs
1 parent 69a0b16 commit dc508a6

File tree

3 files changed

+43
-1
lines changed

3 files changed

+43
-1
lines changed

docs/concepts/configuration.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,10 @@ Use the `defang config` command of the Defang CLI to manage the values.
4444
You can find a sample of how to set sensitive config values [here](https://github.com/DefangLabs/samples/tree/main/samples/nodejs-openai).
4545
:::
4646

47+
:::info
48+
Note that if you are using the [1-Click Deploy](/docs/tutorials/using-one-click-deploy) option, you can set sensitive config values as secrets in your GitHub repository and the action will automatically deploy them for you.
49+
:::
50+
4751
## Interpolation
4852

4953
Environment variables are set within the `environment` section of a service in a `compose.yaml` file. Any variables declared here will become available within the service container.

docs/providers/playground.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: The Defang Playground is a free tier that allows you to experiment
44
sidebar_position: 0000
55
---
66

7-
The Defang Playground is a free tier that allows you to experiment with Defang. The Playground is a shared environment that should not be used to run production workloads. The Playground is a great way to get started with Defang using "1-click deploy" or to experiment with the Defang CLI.
7+
The Defang Playground is a free tier that allows you to experiment with Defang. The Playground is a shared environment that should not be used to run production workloads. The Playground is a great way to get started with Defang using [1-Click Deploy](/docs/tutorials/using-one-click-deploy) or to experiment with the [Defang CLI](/docs/getting-started).
88

99
This page highlights architectural considerations when deploying to the Playground and any differences you might encounter when deploying to the Playground versus deploying to your own cloud account.
1010

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: Using 1-Click Deploy
3+
sidebar_position: 800
4+
description: Use 1-Click Deploy to easily deploy a sample to the Defang Playground.
5+
---
6+
7+
# Using 1-Click Deploy
8+
9+
This tutorial will show you how to use Defang 1-Click Deploy to deploy a sample.
10+
11+
The 1-Click Deploy button is intended to be a quickstart way for new users to deploy to the [Defang Playground](/docs/concepts/defang-playground) with no prior installation needed.
12+
13+
:::info
14+
If this is not your first time, we recommend using the [Defang CLI](/docs/getting-started) to get a full experience of deploying with Defang.
15+
:::
16+
17+
## Step 1 - Choose a Sample
18+
Head to our [list of samples](https://defang.io/#samples) and click a sample you want to deploy. Then, click on the button that says "1-Click Deploy".
19+
20+
Alterntively, you can find the "1-Click Deploy" button located in the `README.md` file of each sample's repository.
21+
22+
## Step 2 - Allow Permissions
23+
24+
After you've clicked, you will be prompted to use GitHub to log in. Once you see a "Create a Repository" page appear, allow the sample repository to get cloned into your GitHub account.
25+
26+
## Step 3 - Wait for Deployment to Complete
27+
28+
A Github action workflow will automatically start running to install Defang and deploy the sample to the Defang Playground. If you wish to, you can see this by going into the "Actions" tab in your GitHub repository.
29+
30+
You can view the status of your deployment in the [Defang Portal](https://portal.defang.dev/), or by downloading the [Defang CLI](/docs/getting-started).
31+
32+
:::tip
33+
Defang has a tutorial on how you can [monitor your services](/docs/tutorials/monitoring-your-services).
34+
:::
35+
36+
:::info
37+
If you decide to make a commit later to a repository created from 1-Click Deploy, then the project will automatically get deployed again to Defang Playground.
38+
:::

0 commit comments

Comments
 (0)