From 94a129a18ee2254a3a593f19a4bdadcb423b928a Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Fri, 20 Sep 2024 23:42:09 +0000 Subject: [PATCH] ci: apply automated fixes --- docs/agent/config/v3.mdx | 38 ++++++++++++++++++-------------------- 1 file changed, 18 insertions(+), 20 deletions(-) diff --git a/docs/agent/config/v3.mdx b/docs/agent/config/v3.mdx index af163c139..58dfc4ef1 100644 --- a/docs/agent/config/v3.mdx +++ b/docs/agent/config/v3.mdx @@ -4,7 +4,7 @@ title: Version 3 # Agent Config Version 3 -The ngrok agent supports an optional, YAML configuration file which enables you to configure advanced settings and run multiple endpoints simultaneously. +The ngrok agent supports an optional, YAML configuration file which enables you to configure advanced settings and run multiple endpoints simultaneously. The agent configuration file location depends on your system. You can check the location of your configuration file by running `ngrok config check` or edit the file in your terminal by running `ngrok config edit`. @@ -57,7 +57,7 @@ agent: #### `api_key` -:::note +:::note This option is only required when you want to make requests using the `ngrok api` command and should not be confused with the `authtoken` option. @@ -72,7 +72,6 @@ agent: api_key: 24yRd5U3DestCQapJrrVHLOqiAC_7RviwRqpd3wc9dKLujQZN ``` - #### `connect_interface` Sets the specific network interface that the ngrok agent should use. This is only supported on Linux platforms. @@ -144,12 +143,12 @@ This is the format of written log records. This is the destination where ngrok should write the logs. -| Parameter | Default | Description | -| ------------ | ------- | -------------------------------------- | -| `stdout` | | write to standard out | -| `stderr` | | write to standard error | -| `false` | default | disable logging | -| `` | | write log records to file path on disk | +| Parameter | Default | Description | +| --------- | ------- | -------------------------------------- | +| `stdout` | | write to standard out | +| `stderr` | | write to standard error | +| `false` | default | disable logging | +| `` | | write log records to file path on disk | ```yaml {2,2} agent: @@ -235,17 +234,16 @@ agent: - example.com ``` - ## Endpoint Definitions -The `endpoints` field enables you to define and configure multiple endpoints. +The `endpoints` field enables you to define and configure multiple endpoints. -Defining multiple endpoints this way enables you to start pre-configured endpoints -by name without having to memorize the right arguments every time through the -`ngrok start` command. You can also use this field to start multiple endpoints at +Defining multiple endpoints this way enables you to start pre-configured endpoints +by name without having to memorize the right arguments every time through the +`ngrok start` command. You can also use this field to start multiple endpoints at the same time from a single agent using the `ngrok start --all` flag. -The endpoints field accepts a list of endpoint configurations, the list of available +The endpoints field accepts a list of endpoint configurations, the list of available endpoint configuration options can be found here. ### Example @@ -284,12 +282,12 @@ Below are a collection of different agent configurations to serve as examples fo ### Basic -Here is a basic example configuration file, in this example we are authenticating -using our authtoken and defining a single HTTPS endpoint named `basic` with a +Here is a basic example configuration file, in this example we are authenticating +using our authtoken and defining a single HTTPS endpoint named `basic` with a endpoint url `basic.ngrok.app` and an upstream url of `localhost:8080`. ```yaml -# Version of the ngrok Agent Configuration file. Required. +# Version of the ngrok Agent Configuration file. Required. version: 3 # Agent Configuration @@ -306,7 +304,7 @@ endpoints: #### Starting the `basic` endpoint -Run the following command to start the basic endpoint. Make sure you update the +Run the following command to start the basic endpoint. Make sure you update the authtoken in the example to your own before running the following command: ``` @@ -371,4 +369,4 @@ endpoints: upstream: url: 8080 protocol: http2 -``` \ No newline at end of file +```