Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,5 @@ defang
samples
/docs/samples.md
/static/samples-v2.json
.envrc
.direnv
4 changes: 2 additions & 2 deletions blog/2024-02-12-announcing-defang-public-beta.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ Ever since we shipped our Private Beta in the summer of 2023, we have been worki

And so, today with our Public Beta, we are addressing this request. With today’s release of [Defang BYOC](/docs/concepts/defang-byoc) (Bring-your-own-Cloud), you can now enjoy all the benefits of Defang **and** deploy applications to your own AWS account! Our Private Beta experience is still available as [Defang Playground](/docs/concepts/defang-playground) for you to quickly and easily prototype applications and deploy them to our hosted environment.

You can learn more about Defang [here](/docs/intro). Also check out our [tutorials](/docs/category/tutorials), [samples](https://defang.io/samples), and [FAQ](/docs/category/faq) to know more.
You can learn more about Defang [here](/docs/intro). Also check out our [tutorials](/docs/tutorials), [samples](https://defang.io/samples), and [FAQ](/docs/category/faq) to know more.

{/* truncate */}

**Try the Public Beta!**

To try the Public Beta, please go to [defang.io](http://defang.io) and click on [Download](https://github.com/DefangLabs/defang/releases/latest) to download the CLI and [get started](/docs/getting-started). We would love to have you kick the tires and give us your feedback! Once you sign up you’ll receive an invitation to our Slack support channel in email. You are also welcome to file [GitHub issues here](https://github.com/DefangLabs/defang/issues).
To try the Public Beta, please go to [defang.io](http://defang.io) and click on [Download](https://github.com/DefangLabs/defang/releases/latest) to download the CLI and [get started](/docs/intro/getting-started). We would love to have you kick the tires and give us your feedback! Once you sign up you’ll receive an invitation to our Slack support channel in email. You are also welcome to file [GitHub issues here](https://github.com/DefangLabs/defang/issues).

**Stay Tuned for More**

Expand Down
2 changes: 1 addition & 1 deletion blog/2024-03-28-slackbot-sample.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Hey folks! Today, I'm going to share one of our code samples that will show you

Before we dive into the details, let's make sure you have everything you need to get started:

1. **Install Defang CLI:** Simplify your deployment process by installing the Defang CLI tool. Follow the instructions [here](/docs/getting-started#install-the-defang-cli) to get it up and running quickly.
1. **Install Defang CLI:** Simplify your deployment process by installing the Defang CLI tool. Follow the instructions [here](/docs/intro/getting-started#install-the-defang-cli) to get it up and running quickly.

2. **Slack API Token:** Create a Slack App at https://api.slack.com/apps, granting it the necessary permissions, including the bot `chat:write` scope.
![screenshot of the slack admin UI showing the bot scopes](/img/slackbot-sample/scopes.png)
Expand Down
2 changes: 1 addition & 1 deletion blog/2025-02-18-model-context-protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ Here we can see what changes if we deploy to the cloud:
1. Service 1 and Service 2 are now deployed to the cloud, not on the local machine anymore.
2. The only part on the local machine is the browser.

Using the same `compose.yaml` file as shown earlier, we can deploy the containers to the cloud with the [Defang CLI](/docs/getting-started). Once we’ve authenticated and logged in, we can [choose a cloud provider (i.e. AWS, GCP, or DigitalOcean)](/docs/tutorials/deploy-to-your-cloud) and use our own cloud account for deployment. Then, we can set a configuration variable for the Anthropic API key:
Using the same `compose.yaml` file as shown earlier, we can deploy the containers to the cloud with the [Defang CLI](/docs/intro/getting-started). Once we’ve authenticated and logged in, we can [choose a cloud provider (i.e. AWS, GCP, or DigitalOcean)](/docs/tutorials/deploy-to-your-cloud) and use our own cloud account for deployment. Then, we can set a configuration variable for the Anthropic API key:

```bash
defang config set ANTHROPIC_API=<your-api-key-value>
Expand Down
2 changes: 1 addition & 1 deletion blog/2025-04-10-easiest-way-to-deploy-django.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Once deployed, your app is accessible via a public URL provided by Defang, which

### Deploying to Your Own Cloud

To deploy directly into your AWS account (or other [supported providers](/docs/category/providers)):
To deploy directly into your AWS account (or other [supported providers](/docs/providers)):

1. Set your cloud provider:
> In my case, I use an AWS Profile, but you should be able to use [any methods supported by the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html)
Expand Down
42 changes: 42 additions & 0 deletions cli-index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
sidebar_position: 1
title: Defang CLI Reference
description: Learn about the Defang CLI
---

import DocCardList from "@docusaurus/theme-classic/lib/theme/DocCardList";

The Defang CLI takes your app from Docker Compose to a secure and scalable deployment on your favorite cloud in minutes.

# Featured Commands

<DocCardList
items={[
{
type: "link",
href: "/docs/cli/compose-up",
label: "defang compose up",
description: "Learn how to deploy your application",
},
{
type: "link",
href: "/docs/cli/config-set",
label: "defang config set",
description: "Learn how to set configuration values for your deployment",
},
{
type: "link",
href: "/docs/cli/compose-logs",
label: "defang compose logs",
description: "Learn how to view your application logs",
},
{
type: "link",
href: "/docs/cli/compose-services",
label: "defang compose services",
description: "Learn how to view your deployed services",
},
]}
/>

For a complete list of commands, check out the sidebar.
3 changes: 1 addition & 2 deletions docs/cli/_category_.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
{
"label": "CLI",
"position": 500,
"link": {
"slug": "cli",
"type": "generated-index",
"description": "Documentation of the Defang CLI (command line interface) commands."
}
}

2 changes: 1 addition & 1 deletion docs/concepts/_category_.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"label": "Concepts",
"position": 500,
"link": {
"slug": "concepts",
"type": "generated-index",
"description": "Some concepts to help explain how the Defang system is organized and tooling that will help you manage your applications."
}
Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Authenticating with Defang.

# Authentication

To do pretty much anything with Defang, you'll need to authenticate with the system. You can do this by running the following command in the [CLI](/docs/getting-started):
To do pretty much anything with Defang, you'll need to authenticate with the system. You can do this by running the following command in the [CLI](/docs/intro/getting-started):

```bash
defang login
Expand Down
6 changes: 3 additions & 3 deletions docs/concepts/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,9 +95,9 @@ If you have created a service before a secret you can connect it by running the

Here are the different ways sensitive config values are stored depending on the provider you are using:

* [AWS](../providers/aws/aws.md#secrets)
* [DigitalOcean](../providers/digitalocean#secrets)
* [GCP](../providers/gcp#secrets)
* [AWS](/docs/providers/aws#secrets)
* [DigitalOcean](/docs/providers/digitalocean#secrets)
* [GCP](/docs/providers/gcp#secrets)

:::info
Please note that while Defang supports setting sensitive config, it does not support the [`secrets`](https://docs.docker.com/reference/compose-file/secrets/) top-level element as seen in the Compose specification. Please see our [Compose](/docs/concepts/compose) page for more details.
Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/debug.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Defang has another AI-driven tool called [`generate`](/docs/concepts/generate).

## How It Works

Here is a typical workflow in the [Defang CLI](/docs/getting-started) that will automatically run the AI debugger tool:
Here is a typical workflow in the [Defang CLI](/docs/intro/getting-started) that will automatically run the AI debugger tool:

1. When you deploy a project with Defang (i.e. `defang compose up`), the CLI will wait for all services' statuses to switch to healthy.

Expand Down
6 changes: 3 additions & 3 deletions docs/concepts/defang-byoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ $ export DEFANG_PROVIDER=digitalocean

## AWS

Please read the [AWS Provider](../providers/aws/aws.md) documentation for more details about how the AWS provider works and how to get started.
Please read the [AWS Provider](/docs/providers/aws) documentation for more details about how the AWS provider works and how to get started.

:::tip[AWS Free Tier & Credits]
You can use the AWS Free Tier to try out Defang. Learn more about it [here](https://aws.amazon.com/free/?all-free-tier.sort-by=item.additionalFields.SortRank&all-free-tier.sort-order=asc&awsf.Free%20Tier%20Types=*all&awsf.Free%20Tier%20Categories=*all). If you're an eligible startup, you can sign up for credits [here](https://aws.amazon.com/startups/sign-up?referrer_url_path=%2Fstartups).
Expand All @@ -41,7 +41,7 @@ You can use the AWS Free Tier to try out Defang. Learn more about it [here](http
The Defang DigitalOcean Provider is available for Public Preview as of October 2024.
:::

Please read the [DigitalOcean Provider](../providers/digitalocean/digitalocean.md) documentation for more details about how the DigitalOcean provider works and how to get started.
Please read the [DigitalOcean Provider](/docs/providers/digitalocean) documentation for more details about how the DigitalOcean provider works and how to get started.

:::tip[DigitalOcean Credits]
You can get DigitalOcean credits to try out Defang. Learn more about it on their [pricing page](https://www.digitalocean.com/pricing). If you're an eligible startup, you can sign up for credits [here](https://www.digitalocean.com/hatch).
Expand All @@ -53,7 +53,7 @@ You can get DigitalOcean credits to try out Defang. Learn more about it on their
The Defang GCP Provider is available for Public Preview as of December 2024.
:::

Please check out the [GCP Provider](../providers/gcp/) page for more details.
Please check out the [GCP Provider](/docs/providers/gcp/) page for more details.

:::tip[GCP Free Tier & Credits]
You can use the GCP Free Tier to try out Defang. Learn more about it [here](https://cloud.google.com/free). If you're an eligible startup, you can sign up for credits [here](https://cloud.google.com/developers/startups).
Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/generate.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Defang uses AI to help you generate a starting point for your cloud

# Generate

Defang includes an AI-driven agent that translates natural language prompts to an outline for your project that you can then refine. The AI agent is available through the [Defang CLI](/docs/getting-started#install-the-defang-cli).
Defang includes an AI-driven agent that translates natural language prompts to an outline for your project that you can then refine. The AI agent is available through the [Defang CLI](/docs/intro/getting-started#install-the-defang-cli).

We are working on expanding the range of supported prompts and improving the accuracy of the AI agent. If you have any feedback or suggestions, please let us know by [opening an issue](https://github.com/DefangLabs/defang/issues/new).

Expand Down
40 changes: 40 additions & 0 deletions docs/concepts/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
sidebar_position: 1
title: Defang Concepts
description: Learn about Defang concepts
---

import DocCardList from "@docusaurus/theme-classic/lib/theme/DocCardList";

# Featured Concepts

<DocCardList
items={[
{
type: "link",
href: "/docs/concepts/managed-llms",
label: "Managed LLMs",
description: "Learn about how Defang makes it easy to use Managed LLMs",
},
{
type: "link",
href: "/docs/concepts/deployment-modes",
label: "Deployment Modes",
description: "Learn about the different Defang deployment modes",
},
{
type: "link",
href: "/docs/concepts/configuration",
label: "Configuration",
description: "Learn how to configure your Defang applications",
},
{
type: "link",
href: "/docs/concepts/compose",
label: "Compose",
description: "Learn about how Defang leverages Docker Compose",
},
]}
/>

For a complete list of concepts, check out the sidebar.
6 changes: 3 additions & 3 deletions docs/concepts/mcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ This page is a guide to the Defang MCP Server detailing its installation, tools,

## Installation

Ensure that you have the [Defang CLI](/docs/getting-started.mdx#install-the-defang-cli) installed.
Ensure that you have the [Defang CLI](/docs/intro/getting-started.mdx#install-the-defang-cli) installed.

Run the setup command in your terminal for your IDE of choice from the [Supported IDEs](#supported-ides) section. This will connect the Defang MCP Server to your IDE. The general format of the command is as follows:

:::tip[Recommended Installation]
Install the [Defang CLI](/docs/getting-started.mdx#install-the-defang-cli) using [Curl](https://curl.se/) or [Homebrew](https://brew.sh/)
Install the [Defang CLI](/docs/intro/getting-started.mdx#install-the-defang-cli) using [Curl](https://curl.se/) or [Homebrew](https://brew.sh/)

```bash
defang mcp setup --client=<claude-code|claude-desktop|cursor|kiro|rovo|vscode|vscode-insiders|windsurf>
Expand Down Expand Up @@ -279,7 +279,7 @@ Feel free to try any of these prompts or create your own!

## Manual Setup

If you prefer to set up the Defang MCP Server manually without using the setup command and without installing the [Defang CLI](/docs/getting-started.mdx#install-the-defang-cli), you can copy this MCP configuration into your IDE's MCP file:
If you prefer to set up the Defang MCP Server manually without using the setup command and without installing the [Defang CLI](/docs/intro/getting-started.mdx#install-the-defang-cli), you can copy this MCP configuration into your IDE's MCP file:

```json
{
Expand Down
5 changes: 0 additions & 5 deletions docs/intro/_category_.json

This file was deleted.

File renamed without changes.
8 changes: 4 additions & 4 deletions docs/faq/questions.md → docs/intro/faq/questions.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import {Button, ButtonGroup, FormGroup, FormLabel} from "@mui/material"

### Which cloud/region is the app being deployed to?

- In the [Defang Playground](/docs/concepts/defang-playground), the app is deployed to AWS `us-west-2`. In the [Defang BYOC](/docs/concepts/defang-byoc) model, the region is determined by your Defang BYOC [Provider](/docs/category/providers) settings.
- In the [Defang Playground](/docs/concepts/defang-playground), the app is deployed to AWS `us-west-2`. In the [Defang BYOC](/docs/concepts/defang-byoc) model, the region is determined by your Defang BYOC [Provider](/docs/providers) settings.

### Can I bring my own AWS or other cloud account?

Expand Down Expand Up @@ -66,13 +66,13 @@ import {Button, ButtonGroup, FormGroup, FormLabel} from "@mui/material"
## Feature Comparisons

### Is Defang a run-time platform?
- No. Defang is not a run-time platform. Instead, it lets you host and run your application on a [cloud provider](/docs/category/providers) of your choice. You can think of it as a tool that makes it way easier to deploy to that cloud provider. We do provide [Defang Playground](/docs/concepts/defang-playground), but it is meant to be used as a testing environment only.
- No. Defang is not a run-time platform. Instead, it lets you host and run your application on a [cloud provider](/docs/providers) of your choice. You can think of it as a tool that makes it way easier to deploy to that cloud provider. We do provide [Defang Playground](/docs/concepts/defang-playground), but it is meant to be used as a testing environment only.

### What is the difference between Defang and platforms such as Vercel, fly.io, Railway, Render, or Heroku?
- Defang is a tool that helps you get your application deployed to a [cloud provider](/docs/category/providers) of your choice, and it is not a platform. Unlike platforms, Defang does not host your application. We do provide [Defang Playground](/docs/concepts/defang-playground), but it is meant to be used as a testing environment only.
- Defang is a tool that helps you get your application deployed to a [cloud provider](/docs/providers) of your choice, and it is not a platform. Unlike platforms, Defang does not host your application. We do provide [Defang Playground](/docs/concepts/defang-playground), but it is meant to be used as a testing environment only.

### What is the difference between Defang and tools such as SST?
- Defang is cloud-agnostic and language-agnostic, meaning that it is designed to work with different [cloud providers](/docs/category/providers), and programming languages. Since Defang is not tied to just one cloud or language, this allows for greater flexibility in a wide range of cases. Another difference is that Defang follows the [Compose specification](https://docs.docker.com/compose/compose-file/), allowing it to work smoothly with various container platforms such as Docker.
- Defang is cloud-agnostic and language-agnostic, meaning that it is designed to work with different [cloud providers](/docs/providers), and programming languages. Since Defang is not tied to just one cloud or language, this allows for greater flexibility in a wide range of cases. Another difference is that Defang follows the [Compose specification](https://docs.docker.com/compose/compose-file/), allowing it to work smoothly with various container platforms such as Docker.

## Troubleshooting

Expand Down
File renamed without changes.
4 changes: 2 additions & 2 deletions docs/intro/features.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ Defang provides a streamlined experience to develop, deploy, and debug your clou
- Ability to express your project configuration using a [Docker Compose YAML](/docs/concepts/compose) file

### Effortless Deployment
- [One-command deployments](/docs/getting-started#install-the-defang-cli)
- [One-command deployments](/docs/intro/getting-started#install-the-defang-cli)
- Support for [GPUs](/docs/concepts/resources) and [managed storage options](/docs/concepts/managed-storage)
- Support for Infra-as-Code via the [Defang Pulumi provider](/docs/concepts/pulumi)

### Security and Configuration
- Ability to manage [encrypted configuration values](/docs/concepts/configuration)
- Pre-configured environments with built-in [security](/docs/concepts/security), [networking](/docs/concepts/networking), and [observability](/docs/concepts/observability)
- Pre-configured environments with built-in [security](/docs/concepts/security), [networking](/docs/concepts/networking), and [observability](/docs/concepts/observability)
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ Defang supports various ways of creating and deploying services to the cloud. Th
},
{
type: "link",
href: "/docs/category/cli",
href: "/docs/cli",
label: "Explore the Defang CLI",
description: "Learn more about the Defang CLI",
},
Expand Down
2 changes: 1 addition & 1 deletion docs/intro/how-it-works.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The first time you deploy with Defang, a new `CD` service will be created in you

Our architecture and AWS implementation has passed a ["well-architected"](https://docs.aws.amazon.com/wellarchitected/latest/framework/welcome.html) review. We are in the process for obtaining similar qualifications with Digital Ocean and Google Cloud.

You can learn more about the specifics by visiting our [provider docs](/docs/category/providers).
You can learn more about the specifics by visiting our [provider docs](/docs/providers).

:::info
The `CD` service does not run all the time. It is only used when you deploy a new service or update an existing service. Once it has finished deploying your service, it will shut itself down.
Expand Down
2 changes: 1 addition & 1 deletion docs/intro/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import DocCardList from "@docusaurus/theme-classic/lib/theme/DocCardList";
},
{
type: "link",
href: "/docs/category/cli",
href: "/docs/cli",
label: "CLI Reference",
description: "Use the Defang CLI to deploy your app",
},
Expand Down
File renamed without changes.
Loading