Skip to content

Commit ba1f2c4

Browse files
committed
Documented Wrangler commands for listing, adding, removing, and updating R2 bucket custom domains
1 parent 13d7627 commit ba1f2c4

File tree

1 file changed

+76
-8
lines changed

1 file changed

+76
-8
lines changed

src/content/docs/workers/wrangler/commands.mdx

Lines changed: 76 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -141,10 +141,8 @@ wrangler docs [<COMMAND>]
141141

142142
:::note
143143

144-
145144
The `init` command will be removed in a future version. Please use `npm create cloudflare@latest` instead.
146145

147-
148146
:::
149147

150148
Create a new project via the [create-cloudflare-cli (C3) tool](/workers/get-started/guide/#1-create-a-new-worker-project). A variety of web frameworks are available to choose from as well as templates. Dependencies are installed by default, with the option to deploy your project immediately.
@@ -928,6 +926,74 @@ List R2 bucket in the current account.
928926
wrangler r2 bucket list
929927
```
930928

929+
### `domain add`
930+
931+
Connect a [custom domain](/r2/buckets/public-buckets/#custom-domains) to an R2 bucket.
932+
933+
```txt
934+
wrangler r2 bucket domain add <NAME> [OPTIONS]
935+
```
936+
937+
- `NAME` <Type text="string" /> <MetaInfo text="required" />
938+
- The name of the R2 bucket to connect a custom domain to.
939+
- `--domain` <Type text="string" /> <MetaInfo text="required" />
940+
- The custom domain to connect to the R2 bucket.
941+
- `--zone-id` <Type text="string" /> <MetaInfo text="required" />
942+
- The [zone ID](/fundamentals/setup/find-account-and-zone-ids/) associated with the custom domain.
943+
- `--enabled` <Type text="boolean" /> <MetaInfo text="optional" />
944+
- Whether to enable public access at the custom domain (default is enabled).
945+
- `--min-tls` <Type text="'1.0'|'1.1'|'1.2'|'1.3'" /> <MetaInfo text="optional" />
946+
- Set the minimum TLS version for the custom domain (defaults to 1.0 if not set).
947+
- `--jurisdiction` <Type text="string" /> <MetaInfo text="optional" />
948+
- The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions).
949+
950+
### `domain remove`
951+
952+
Remove a [custom domain](/r2/buckets/public-buckets/#custom-domains) from an R2 bucket.
953+
954+
```txt
955+
wrangler r2 bucket domain remove <NAME> [OPTIONS]
956+
```
957+
958+
- `NAME` <Type text="string" /> <MetaInfo text="required" />
959+
- The name of the R2 bucket to remove the custom domain from.
960+
- `--domain` <Type text="string" /> <MetaInfo text="required" />
961+
- The custom domain to remove from the R2 bucket.
962+
- `--jurisdiction` <Type text="string" /> <MetaInfo text="optional" />
963+
- The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions).
964+
965+
### `domain update`
966+
967+
Update settings for a [custom domain](/r2/buckets/public-buckets/#custom-domains) connected to an R2 bucket.
968+
969+
```txt
970+
wrangler r2 bucket domain update <NAME> [OPTIONS]
971+
```
972+
973+
- `NAME` <Type text="string" /> <MetaInfo text="required" />
974+
- The name of the R2 bucket associated with the custom domain to update.
975+
- `--domain` <Type text="string" /> <MetaInfo text="required" />
976+
- The custom domain whose settings will be updated.
977+
- `--enabled` <Type text="boolean" /> <MetaInfo text="optional" />
978+
- Enable or disable public access at the custom domain.
979+
- `--min-tls` <Type text="'1.0'|'1.1'|'1.2'|'1.3'" /> <MetaInfo text="optional" />
980+
- Update the minimum TLS version for the custom domain.
981+
- `--jurisdiction` <Type text="string" /> <MetaInfo text="optional" />
982+
- The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions).
983+
984+
### `domain list`
985+
986+
List [custom domains](/r2/buckets/public-buckets/#custom-domains) for an R2 bucket.
987+
988+
```txt
989+
wrangler r2 bucket domain list <NAME> [OPTIONS]
990+
```
991+
992+
- `NAME` <Type text="string" /> <MetaInfo text="required" />
993+
- The name of the R2 bucket whose connected custom domains will be listed.
994+
- `--jurisdiction` <Type text="string" /> <MetaInfo text="optional" />
995+
- The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions).
996+
931997
### `notification create`
932998

933999
Create an [event notification](/r2/buckets/event-notifications/) rule for an R2 bucket.
@@ -992,7 +1058,7 @@ wrangler r2 bucket sippy enable <NAME> [OPTIONS]
9921058
- `--r2-secret-access-key` <Type text="string" /> <MetaInfo text="required" />
9931059
- Your R2 Secret Access Key. Requires read and write access.
9941060
- `--jurisdiction` <Type text="string" /> <MetaInfo text="optional" />
995-
- The jurisdiction where this R2 bucket is located, if a jurisdiction has been specified. Refer to [Jurisdictional Restrictions](/r2/reference/data-location/#jurisdictional-restrictions).
1061+
- The jurisdiction where the bucket exists. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions).
9961062
- **AWS S3 provider-specific options:**
9971063
- `--key-id` <Type text="string" /> <MetaInfo text="optional" />
9981064
- Your AWS Access Key ID. Requires [read and list access](/r2/data-migration/sippy/#amazon-s3).
@@ -1264,7 +1330,7 @@ wrangler workflows list
12641330
```
12651331

12661332
- `--page` <Type text="number" /> <MetaInfo text="optional" />
1267-
- Show a specific page from the listing. You can configure page size using "per-page".
1333+
- Show a specific page from the listing. You can configure page size using "per-page".
12681334
- `--per-page` <Type text="number" /> <MetaInfo text="optional" />
12691335
- Configure the maximum number of Workflows to show per page.
12701336

@@ -1300,6 +1366,7 @@ wrangler workflows instances describe <WORKFLOW_NAME> <ID> [OPTIONS]
13001366
# Passing `latest` instead of an explicit ID will describe the most recently queued instance
13011367
wrangler workflows instances describe my-workflow latest
13021368
```
1369+
13031370
```sh output
13041371
Workflow Name: my-workflow
13051372
Instance Id: 51c73fc8-7fd5-47d9-bd82-9e301506ee72
@@ -1368,6 +1435,7 @@ wrangler workflows describe <WORKFLOW_NAME> [OPTIONS]
13681435
### `trigger`
13691436

13701437
Trigger (create) a Workflow instance.
1438+
13711439
```sh
13721440
wrangler workflows describe <WORKFLOW_NAME> <PARAMS> [OPTIONS]
13731441
```
@@ -1377,10 +1445,10 @@ wrangler workflows describe <WORKFLOW_NAME> <PARAMS> [OPTIONS]
13771445
- `PARAMS` <Type text="string" /> <MetaInfo text="optional" />
13781446
- The parameters to pass to the Workflow as an event. Must be a JSON-encoded string.
13791447

1380-
```sh
1381-
# Pass optional params to the Workflow.
1382-
wrangler workflows instances trigger my-workflow '{"hello":"world"}'
1383-
```
1448+
```sh
1449+
# Pass optional params to the Workflow.
1450+
wrangler workflows instances trigger my-workflow '{"hello":"world"}'
1451+
```
13841452

13851453
### `delete`
13861454

0 commit comments

Comments
 (0)