Add new article to fix #551 (#562)

* Add new article to fix #551 * fix tabs and correct text * Change from plaintext to output * Change alert
dotnet · Apr 3, 2024 · e156eba · e156eba
1 parent dc31ad0
commit e156eba
Show file tree

Hide file tree

Showing 4 changed files with 102 additions and 1 deletion.
diff --git a/docs/deployment/manifest-format.md b/docs/deployment/manifest-format.md
@@ -1,7 +1,7 @@
 ---
 title: .NET Aspire manifest format for deployment tool builders
 description: Learn about the .NET Aspire manifest format in this comprehensive deployment tool builder guide.
-ms.date: 03/13/2024
+ms.date: 03/29/2024
 ms.topic: reference
 ---
 
@@ -44,6 +44,23 @@ info: Aspire.Hosting.Publishing.ManifestPublisher[0]
 
 The file generated is the .NET Aspire manifest and is used by tools to support deploying into target cloud environments.
 
+> [!NOTE]
+> You can also generate a manifest as part of the launch profile. Consider the following _launchSettings.json_:
+>
+> ```json
+> {
+>   "$schema": "http://json.schemastore.org/launchsettings.json",
+>   "profiles": {
+>     "generate-manifest": {
+>       "commandName": "Project",
+>       "launchBrowser": false,
+>       "dotnetRunMessages": true,
+>       "commandLineArgs": "--publisher manifest --output-path aspire-manifest.json"
+>     }
+>   }
+> }
+> ```
+
 ## Basic manifest format
 
 Publishing the manifest from the default starter template for .NET Aspire produces the following JSON output:

diff --git a/docs/index.yml b/docs/index.yml
@@ -124,6 +124,9 @@ conceptualContent:
         - itemType: how-to-guide
           text: RabbitMQ client .NET Aspire component
           url: messaging/rabbitmq-client-component.md
+        - itemType: how-to-guide
+          text: Apache Kafka
+          url: messaging/kafka-component.md
 
     - title: Caching
       links:

diff --git a/docs/toc.yml b/docs/toc.yml
@@ -154,6 +154,12 @@ items:
       - name: Reference - Tool-builder manifest schemas
         href: deployment/manifest-format.md
 
+  - name: Troubleshooting
+    items:
+      - name: Allow unsecure transport
+        displayName: unsecure transport,http,non-tls
+        href: troubleshooting/allow-unsecure-transport.md
+
   - name: Resources
     items:
       - name: .NET Aspire

diff --git a/docs/troubleshooting/allow-unsecure-transport.md b/docs/troubleshooting/allow-unsecure-transport.md
@@ -0,0 +1,75 @@
+---
+title: Allow unsecure transport in .NET Aspire
+description: Learn how to allow unsecure transport in .NET Aspire applications.
+ms.date: 03/29/2024
+---
+
+# Allow unsecure transport in .NET Aspire
+
+Starting with .NET Aspire preview 5, the app host will crash if an `applicationUrl` is configured with an insecure transport (non-TLS `http`) protocol. This is a security feature to prevent accidental exposure of sensitive data. However, there are scenarios where you might need to allow unsecure transport. This article explains how to allow unsecure transport in .NET Aspire applications.
+
+## Symptoms
+
+When you run a .NET Aspire application with an `applicationUrl` configured with an insecure transport protocol, you might see the following error message:
+
+```Output
+The 'applicationUrl' setting must be an https address unless the
+'ASPIRE_ALLOW_UNSECURED_TRANSPORT' environment variable is set to true.
+
+This configuration is commonly set in the launch profile.
+```
+
+## How to allow unsecure transport
+
+To allow an unsecure transport in .NET Aspire, set the `ASPIRE_ALLOW_UNSECURED_TRANSPORT` environment variable to `true`. This environment variable is used to control the behavior of the app host when an `applicationUrl` is configured with an insecure transport protocol:
+
+## [Unix](#tab/unix)
+
+```bash
+export ASPIRE_ALLOW_UNSECURED_TRANSPORT=true
+```
+
+## [Windows](#tab/windows)
+
+```powershell
+$env:ASPIRE_ALLOW_UNSECURED_TRANSPORT = "true"
+```
+
+---
+
+Alternatively, you can control this via the launch profile as it exposes the ability to configure environment variables per profile. To do this, consider the following example settings in the `launchSettings.json` file:
+
+```json
+{
+  "$schema": "http://json.schemastore.org/launchsettings.json",
+  "profiles": {
+    "https": {
+      "commandName": "Project",
+      "dotnetRunMessages": true,
+      "launchBrowser": true,
+      "applicationUrl": "https://localhost:15015;http://localhost:15016",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development",
+        "DOTNET_ENVIRONMENT": "Development",
+        "DOTNET_DASHBOARD_OTLP_ENDPOINT_URL": "https://localhost:16099",
+        "DOTNET_RESOURCE_SERVICE_ENDPOINT_URL": "https://localhost:17037"
+      }
+    },
+    "http": {
+      "commandName": "Project",
+      "dotnetRunMessages": true,
+      "launchBrowser": true,
+      "applicationUrl": "http://localhost:15016",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development",
+        "DOTNET_ENVIRONMENT": "Development",
+        "DOTNET_DASHBOARD_OTLP_ENDPOINT_URL": "http://localhost:16099",
+        "DOTNET_RESOURCE_SERVICE_ENDPOINT_URL": "http://localhost:17038",
+        "ASPIRE_ALLOW_UNSECURED_TRANSPORT": "true"
+      }
+    }
+  }
+}
+```
+
+The preceding example shows two profiles, `https` and `http`. The `https` profile is configured with a secure transport protocol, while the `http` profile is configured with an insecure transport protocol. The `ASPIRE_ALLOW_UNSECURED_TRANSPORT` environment variable is set to `true` in the `http` profile to allow unsecure transport.