diff --git a/src/content/docs/cloudflare-one/connections/connect-devices/warp/configure-warp/route-traffic/warp-architecture.mdx b/src/content/docs/cloudflare-one/connections/connect-devices/warp/configure-warp/route-traffic/warp-architecture.mdx index 001569637248e8..a376764f9e5be2 100644 --- a/src/content/docs/cloudflare-one/connections/connect-devices/warp/configure-warp/route-traffic/warp-architecture.mdx +++ b/src/content/docs/cloudflare-one/connections/connect-devices/warp/configure-warp/route-traffic/warp-architecture.mdx @@ -111,10 +111,10 @@ resolver #2 On Windows, open a PowerShell window and run `ipconfig`. The DNS servers should be set to WARP's local DNS proxy IPs. ```powershell -PS C:\> ipconfig +ipconfig ``` -```powershell {15-16} output +```txt {15-16} output Windows IP Configuration Unknown adapter CloudflareWARP: @@ -200,11 +200,10 @@ utun3: flags=8051 mtu 1280 On Windows, run `ipconfig`. When WARP is turned on, you will see an adapter called `CloudflareWARP` with IP address `172.16.0.2`. ```powershell -PS C:\> ipconfig +ipconfig ``` -```powershell {12} output - +```txt {12} output Windows IP Configuration Unknown adapter CloudflareWARP: @@ -299,11 +298,10 @@ To view the entire routing table on Windows, run `netstat -r`. You can also search the routing table for an IP address. In this example, we see that traffic to `1.1.1.1` is sent through the WARP virtual interface: ```powershell -PS C:\> Find-NetRoute -RemoteIPAddress "1.1.1.1" | Select-Object InterfaceAlias -Last 1 +Find-NetRoute -RemoteIPAddress "1.1.1.1" | Select-Object InterfaceAlias -Last 1 ``` -```powershell output - +```txt output InterfaceAlias -------------- CloudflareWARP @@ -312,11 +310,10 @@ CloudflareWARP In contrast, this DHCP address is excluded from WARP and uses the default interface: ```powershell -PS C:\> Find-NetRoute -RemoteIPAddress "169.254.0.0" | Select-Object InterfaceAlias -Last 1 +Find-NetRoute -RemoteIPAddress "169.254.0.0" | Select-Object InterfaceAlias -Last 1 ``` -```powershell output - +```txt output InterfaceAlias -------------- Wi-Fi diff --git a/src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/index.mdx b/src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/index.mdx index 11a1133ec5ae4a..7156492c979ab8 100644 --- a/src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/index.mdx +++ b/src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/index.mdx @@ -42,8 +42,10 @@ To uninstall the WARP client: 1. First, locate the `.msi` package with the following PowerShell command: ```powershell -PS C:\Users\JohnDoe> Get-WmiObject Win32_Product | Where-Object { $_.Name -match "WARP" } | Sort-Object -Property Name | Format-Table IdentifyingNumber, Name, LocalPackage -AutoSize +Get-WmiObject Win32_Product | Where-Object { $_.Name -match "WARP" } | Sort-Object -Property Name | Format-Table IdentifyingNumber, Name, LocalPackage -AutoSize +``` +```txt output IdentifyingNumber Name LocalPackage ----------------- ---- ------------ {5RA4DJWK-13D8-2NSX-QRF8-UANLODWD6D90} Cloudflare WARP C:\WINDOWS\Installer\3f476db.msi @@ -51,7 +53,7 @@ IdentifyingNumber Name LocalPackage 2. You can then use the LocalPackage output in the uninstall command. For example, -```bash +```powershell msiexec /x C:\WINDOWS\Installer\.msi /quiet ``` diff --git a/src/content/docs/cloudflare-one/connections/connect-devices/warp/troubleshooting/known-limitations.mdx b/src/content/docs/cloudflare-one/connections/connect-devices/warp/troubleshooting/known-limitations.mdx index 77a1fde921566f..951660834016e0 100644 --- a/src/content/docs/cloudflare-one/connections/connect-devices/warp/troubleshooting/known-limitations.mdx +++ b/src/content/docs/cloudflare-one/connections/connect-devices/warp/troubleshooting/known-limitations.mdx @@ -40,10 +40,10 @@ To work around the issue, specify the IPv4 address of the [WARP local DNS proxy] C:\Users\JohnDoe>nslookup google.com 127.0.2.2 ``` -Alternatively, use Powershell: +Alternatively, use PowerShell: ```powershell -PS C:\Users\JohnDoe> Resolve-DnsName -Name google.com +Resolve-DnsName -Name google.com ``` ## 4G/5G embedded modules diff --git a/src/content/docs/cloudflare-one/connections/connect-networks/deploy-tunnels/tunnel-with-firewall.mdx b/src/content/docs/cloudflare-one/connections/connect-networks/deploy-tunnels/tunnel-with-firewall.mdx index 28dd4c7abb444d..686ddf230740c5 100644 --- a/src/content/docs/cloudflare-one/connections/connect-networks/deploy-tunnels/tunnel-with-firewall.mdx +++ b/src/content/docs/cloudflare-one/connections/connect-networks/deploy-tunnels/tunnel-with-firewall.mdx @@ -182,8 +182,10 @@ On Windows, you can use PowerShell commands if `dig` is not available. To test DNS: ```powershell -PS C:\Windows\system32> Resolve-DnsName -Name _v2-origintunneld._tcp.argotunnel.com SRV +Resolve-DnsName -Name _v2-origintunneld._tcp.argotunnel.com SRV +``` +```txt output Name Type TTL Section NameTarget Priority Weight Port ---- ---- --- ------- ---------- -------- ------ ---- _v2-origintunneld._tcp.argotunnel.com SRV 112 Answer region2.v2.argotunnel.com 2 1 7844 @@ -193,8 +195,10 @@ _v2-origintunneld._tcp.argotunnel.com SRV 112 Answer region1.v2.a To test ports: ```powershell -PS C:\Cloudflared\bin> tnc region1.v2.argotunnel.com -port 443 +tnc region1.v2.argotunnel.com -port 443 +``` +```txt output ComputerName : region1.v2.argotunnel.com RemoteAddress : 198.41.192.227 RemotePort : 443 @@ -204,8 +208,10 @@ TcpTestSucceeded : True ``` ```powershell -PS C:\Cloudflared\bin> tnc region1.v2.argotunnel.com -port 7844 +tnc region1.v2.argotunnel.com -port 7844 +``` +```txt output ComputerName : region1.v2.argotunnel.com RemoteAddress : 198.41.192.227 RemotePort : 7844 diff --git a/src/content/docs/cloudflare-one/connections/connect-networks/downloads/update-cloudflared.mdx b/src/content/docs/cloudflare-one/connections/connect-networks/downloads/update-cloudflared.mdx index d12cd571b026a3..a5e1b82cab76a1 100644 --- a/src/content/docs/cloudflare-one/connections/connect-networks/downloads/update-cloudflared.mdx +++ b/src/content/docs/cloudflare-one/connections/connect-networks/downloads/update-cloudflared.mdx @@ -18,7 +18,7 @@ To update `cloudflared` for a tunnel [created through the dashboard](/cloudflare Run the following command: ```powershell -PS C:\> cloudflared update +cloudflared update ``` This updates `cloudflared` and automatically restarts the service. @@ -139,7 +139,7 @@ Windows systems require services to have a unique name and display name. You can 1. Install and configure `cloudflared`. 2. Next, create a service with a unique name and point to the `cloudflared` executable and configuration file. -```bash +```powershell sc.exe create binPath='' --config '' displayname="Unique Name" ``` @@ -147,6 +147,6 @@ sc.exe create binPath='' --config '' 4. You can now start each unique service. -```bash +```powershell sc.exe start ``` diff --git a/src/content/docs/cloudflare-one/identity/devices/warp-client-checks/application-check.mdx b/src/content/docs/cloudflare-one/identity/devices/warp-client-checks/application-check.mdx index 9b0e35dc226239..86beb5193c5843 100644 --- a/src/content/docs/cloudflare-one/identity/devices/warp-client-checks/application-check.mdx +++ b/src/content/docs/cloudflare-one/identity/devices/warp-client-checks/application-check.mdx @@ -86,7 +86,7 @@ When setting up new device posture checks, we recommend first testing them witho 2. Use the `Get-AuthenticodeSignature` command to find the thumbprint. For example: ```powershell - PS C:\Users\JohnDoe> Get-AuthenticodeSignature -FilePath c:\myfile.exe + Get-AuthenticodeSignature -FilePath c:\myfile.exe ``` ## Determine the SHA-256 value @@ -108,7 +108,7 @@ The SHA-256 value almost always changes between versions of a file/application. 2. Use the `get-filehash` command to find the SHA256 value of the file. For example: ```powershell - PS C:\Users\JohnDoe> get-filehash -path "C:\myfile.exe" -Algorithm SHA256 | format-list + get-filehash -path "C:\myfile.exe" -Algorithm SHA256 | format-list ``` ## How WARP checks for an application diff --git a/src/content/docs/cloudflare-one/identity/devices/warp-client-checks/client-certificate.mdx b/src/content/docs/cloudflare-one/identity/devices/warp-client-checks/client-certificate.mdx index 3a9ab493d5b747..af477a0f4621b0 100644 --- a/src/content/docs/cloudflare-one/identity/devices/warp-client-checks/client-certificate.mdx +++ b/src/content/docs/cloudflare-one/identity/devices/warp-client-checks/client-certificate.mdx @@ -91,13 +91,13 @@ You can use the following commands to check if a client certificate is properly 2. To search the local machine trust store for a certificate with a specific common name, run the following command: ```powershell -PS C:\Users\JohnDoe> Get-ChildItem Cert:\LocalMachine\My\ | where{$_.Subject -like "**"} +Get-ChildItem Cert:\LocalMachine\My\ | where{$_.Subject -like "**"} ``` 3. To search the user trust store for a certificate with a specific common name, run the following command: ```powershell -PS C:\Users\JohnDoe> Get-ChildItem Cert:\CurrentUser\My\ | where{$_.Subject -like "**"} +Get-ChildItem Cert:\CurrentUser\My\ | where{$_.Subject -like "**"} ``` diff --git a/src/content/docs/cloudflare-one/identity/devices/warp-client-checks/firewall.mdx b/src/content/docs/cloudflare-one/identity/devices/warp-client-checks/firewall.mdx index 1434dc0b4b29c4..7e3a894e996f84 100644 --- a/src/content/docs/cloudflare-one/identity/devices/warp-client-checks/firewall.mdx +++ b/src/content/docs/cloudflare-one/identity/devices/warp-client-checks/firewall.mdx @@ -62,7 +62,7 @@ macOS has two firewalls: an application-based firewall and a port-based firewall 1. Open PowerShell and run: ```powershell - PS C:\Users\JohnDoe> Get-NetFirewallProfile -PolicyStore ActiveStore -Name Public + Get-NetFirewallProfile -PolicyStore ActiveStore -Name Public ``` 2. Verify that **Enabled** is `True`. diff --git a/src/content/docs/email-security/deployment/inline/setup/office-365-area1-mx/index.mdx b/src/content/docs/email-security/deployment/inline/setup/office-365-area1-mx/index.mdx index d47080b9df70b2..2b3fcd5440c80c 100644 --- a/src/content/docs/email-security/deployment/inline/setup/office-365-area1-mx/index.mdx +++ b/src/content/docs/email-security/deployment/inline/setup/office-365-area1-mx/index.mdx @@ -6,19 +6,17 @@ sidebar: order: 1 head: - tag: title - content: Deploy and configure Microsoft Office 365 with Email Security (formerly + content: + Deploy and configure Microsoft Office 365 with Email Security (formerly Area 1) as the MX Record - --- -import { GlossaryTooltip, Render } from "~/components" +import { GlossaryTooltip, Render } from "~/components"; :::caution[Area 1 has been renamed] - - ::: ![A schematic showing where Email Security is in the life cycle of an email received](~/assets/images/email-security/deployment/inline-setup/o365-area1-mx/office365-mx.png) @@ -91,8 +89,8 @@ For the purposes of this guide, Office 365 and Microsoft 365 are equivalent. This option will allow Office 365 to properly identify the original connecting IP before the message was received by Email Security (formerly Area 1). This helps with SPF analysis. This has two steps: -* Creating an inbound connector. -* Enabling the enhanced filtering configuration of the connector. +- Creating an inbound connector. +- Enabling the enhanced filtering configuration of the connector. ### Create an inbound connector @@ -114,8 +112,8 @@ This option will allow Office 365 to properly identify the original connecting I 6. Set the following options: - * **Name** - `Email Security Inbound Connector` - * **Description** - `Inbound connector for Enhanced Filtering` + - **Name** - `Email Security Inbound Connector` + - **Description** - `Inbound connector for Enhanced Filtering`
@@ -209,23 +207,23 @@ When Email Security is deployed as the MX record and protecting Office 365, `MAL There may be scenarios where use of the Office 365 (O365) email quarantine or a combination with Email Security is preferred. The following are the best practices for using the O365 quarantine [by disposition](/email-security/reference/dispositions-and-attributes/): -| Disposition | Action | -| -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `MALICIOUS` | Should always be quarantined. If the user requires notification, they should require administrator approval to release messages. Users should never have the ability to self remediate `MALICIOUS` emails without approval from an administrator. Emails should be body and subject tagged. | -| `SUSPICIOUS` | Should not be quarantined. Emails should be body and subject tagged, and delivered to the user’s inbox or junk mail folder. Advantage customers should use [`URL defang`](/email-security/email-configuration/email-policies/link-actions/) with this disposition, while all Enterprise customers should always enable [Email Link Isolation](/email-security/email-configuration/email-policies/link-actions/#email-link-isolation). | -| `SPAM` | Should always be quarantined. If the user requires notification, they may or may not require administrator approval to release emails. Emails should be subject tagged. | -| `BULK` | Should not be quarantined. Emails should be subject tagged and delivered to the inbox or junk mail folder. | -| `SPOOF` | If `SPOOF` detections are clean and well managed [in the Allow List](/email-security/email-configuration/lists/), emails should always be quarantined. If the `SPOOF` detections are not clean, they should have the same treatment as `SPAM` dispositions if you have [Enhanced Detections](/email-security/email-configuration/enhanced-detections/) configured. If not, `SPOOF` detections should be treated as `BULK`. Emails should be body and subject tagged. | +| Disposition | Action | +| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `MALICIOUS` | Should always be quarantined. If the user requires notification, they should require administrator approval to release messages. Users should never have the ability to self remediate `MALICIOUS` emails without approval from an administrator. Emails should be body and subject tagged. | +| `SUSPICIOUS` | Should not be quarantined. Emails should be body and subject tagged, and delivered to the user’s inbox or junk mail folder. Advantage customers should use [`URL defang`](/email-security/email-configuration/email-policies/link-actions/) with this disposition, while all Enterprise customers should always enable [Email Link Isolation](/email-security/email-configuration/email-policies/link-actions/#email-link-isolation). | +| `SPAM` | Should always be quarantined. If the user requires notification, they may or may not require administrator approval to release emails. Emails should be subject tagged. | +| `BULK` | Should not be quarantined. Emails should be subject tagged and delivered to the inbox or junk mail folder. | +| `SPOOF` | If `SPOOF` detections are clean and well managed [in the Allow List](/email-security/email-configuration/lists/), emails should always be quarantined. If the `SPOOF` detections are not clean, they should have the same treatment as `SPAM` dispositions if you have [Enhanced Detections](/email-security/email-configuration/enhanced-detections/) configured. If not, `SPOOF` detections should be treated as `BULK`. Emails should be body and subject tagged. | Office 365 (O365) has various options, as well as limitations, as to how quarantine email messages. Refer to [Office 365 use cases](/email-security/deployment/inline/setup/office-365-area1-mx/use-cases/) for more information. The Email Security dashboard has an [Admin quarantine](/email-security/email-configuration/admin-quarantine/), and you can also use the Office 365 quarantine for when a user quarantine is needed. While there are many quarantine options, the following are the primary use cases the Office 365 [example tutorials](/email-security/deployment/inline/setup/office-365-area1-mx/use-cases/) will cover: -* **Use case 1**: Deliver emails to Office 365 junk email folder and Admin Quarantine in Email Security (Recommended) -* **Use case 2**: Deliver emails to junk email folder and user managed quarantine (this use case requires that `MALICIOUS` emails be quarantined within the Email Security dashboard) -* **Use case 3**: Deliver emails to junk email and administrative quarantine -* **Use case 4**: Deliver emails to the user managed quarantine and administrative quarantine -* **Use case 5**: Deliver emails to the user junk email folder and administrative quarantine +- **Use case 1**: Deliver emails to Office 365 junk email folder and Admin Quarantine in Email Security (Recommended) +- **Use case 2**: Deliver emails to junk email folder and user managed quarantine (this use case requires that `MALICIOUS` emails be quarantined within the Email Security dashboard) +- **Use case 3**: Deliver emails to junk email and administrative quarantine +- **Use case 4**: Deliver emails to the user managed quarantine and administrative quarantine +- **Use case 5**: Deliver emails to the user junk email folder and administrative quarantine ## 5. Update your domain MX records @@ -240,8 +238,7 @@ DNS changes will reach the major DNS servers in about an hour or follow the TTL One method of DNS attacks is to search for old MX records and send phishing emails directly to the mail server. To secure the email flow, you will want to enforce an email flow where inbound messages are accepted by Office 365 only when they originate from Email Security. This can be done by adding a connector to only allow email from Email Security with TLS encryption. This step is optional but recommended. :::caution[Important] - -This step should not be performed until 24 hours after all domains (excluding your `` domain) in your Office 365 organization have been onboarded to Email Security, and Email Security is their MX record. If a domain has not been onboarded or DNS is still propagating, you will impact production email flow for that domain. +This step should not be performed until 24 hours after all domains (excluding your `` domain) in your Office 365 organization have been onboarded to Email Security, and Email Security is their MX record. If a domain has not been onboarded or DNS is still propagating, you will impact production email flow for that domain. ::: #### Configure domains @@ -253,12 +250,12 @@ This step should not be performed until 24 hours after all domains (excluding yo 3. In **Email Configuration** > **Domains**, make sure each domain you are onboarding has been added. 4. Set the following options for each domain: - * **Domain**: `` - * **Configured as**: `MX Records` - * **Forwarding to**: This should match the expected MX record for each domain in the [Domains section](https://admin.microsoft.com/#/Domains/) of Office 365 - * **IP Restrictions**: Leave empty - * **Outbound TLS**: `Forward all messages over TLS` - * **Quarantine Policy**: Varies by deployment. + - **Domain**: `` + - **Configured as**: `MX Records` + - **Forwarding to**: This should match the expected MX record for each domain in the [Domains section](https://admin.microsoft.com/#/Domains/) of Office 365 + - **IP Restrictions**: Leave empty + - **Outbound TLS**: `Forward all messages over TLS` + - **Quarantine Policy**: Varies by deployment. #### Create Connector @@ -273,8 +270,9 @@ This step should not be performed until 24 hours after all domains (excluding yo 5. Select **Next**. 6. Set the following options: - * **Name** - `Secure O365 Inbound` - * **Description** - `Only accept inbound email from Email Security (formerly Area 1)` + + - **Name** - `Secure O365 Inbound` + - **Description** - `Only accept inbound email from Email Security (formerly Area 1)` 7. Select **Next**. @@ -311,7 +309,7 @@ The following steps are only required if you have not previously customized your 1. Run PowerShell as administrator, and execute the following command. Reply `Yes` when prompted: ```powershell -PS C:\Windows\system32> Install-Module ExchangeOnlineManagement +Install-Module ExchangeOnlineManagement ``` ![Run the install-module command in PowerShell](~/assets/images/email-security/deployment/inline-setup/o365-area1-mx/step1-install-module.png) @@ -323,19 +321,19 @@ This module is a Microsoft module. 2. Run the following commands to execute the policy change and connect to the Office 365 instance: ```powershell - PS C:\Windows\system32> set-executionpolicy remotesigned + set-executionpolicy remotesigned ``` Confirm that you want to execute the policy change, and then run the following command: ```powershell - PS C:\Windows\system32> Import-Module ExchangeOnlineManagement + Import-Module ExchangeOnlineManagement ``` Finally, run the following to authenticate against your Office 365 instance: ```powershell - PS C:\Windows\system32> Connect-ExchangeOnline + Connect-ExchangeOnline ``` ![Run the commands to execute the policy change](~/assets/images/email-security/deployment/inline-setup/o365-area1-mx/step2-set-executionpolicy.png) @@ -347,7 +345,7 @@ This module is a Microsoft module. 4. You can verify that the `OrganizationCustomization` is enabled by running the command: ```powershell -PS C:\Windows\system32> Get-OrganizationConfig | FL isDehydrated +Get-OrganizationConfig | FL isDehydrated ``` ![Run the get-organizationconfig command](~/assets/images/email-security/deployment/inline-setup/o365-area1-mx/step4-get-organizationconfig.png) @@ -355,7 +353,7 @@ PS C:\Windows\system32> Get-OrganizationConfig | FL isDehydrated If the result is `false`, `OrganizationCustomization` is already enabled and no further actions are required. If it is true, you need to enable it: ```powershell -PS C:\> Enable-OrganizationCustomization +Enable-OrganizationCustomization ``` ![If the previous result is true, enable the organization customization mode](~/assets/images/email-security/deployment/inline-setup/o365-area1-mx/step4-enable-organizationcustomization.png) diff --git a/src/content/docs/fundamentals/api/how-to/make-api-calls.mdx b/src/content/docs/fundamentals/api/how-to/make-api-calls.mdx index 6ab0a92073f614..525288289e38ee 100644 --- a/src/content/docs/fundamentals/api/how-to/make-api-calls.mdx +++ b/src/content/docs/fundamentals/api/how-to/make-api-calls.mdx @@ -110,7 +110,7 @@ PowerShell has specific cmdlets (`Invoke-RestMethod` and `ConvertFrom-Json`) for The following example uses the `Invoke-RestMethod` cmdlet: ```powershell -PS C:\> Invoke-RestMethod -URI 'https://api.cloudflare.com/client/v4/zones/{zone_id}/ssl/certificate_packs?ssl_status=all' -Method 'GET' -ContentType 'application/json' -Headers @{'X-Auth-Email'='';'X-Auth-Key'=''} +Invoke-RestMethod -URI 'https://api.cloudflare.com/client/v4/zones/{zone_id}/ssl/certificate_packs?ssl_status=all' -Method 'GET' -ContentType 'application/json' -Headers @{'X-Auth-Email'='';'X-Auth-Key'=''} ``` ```txt title="Example output" @@ -127,7 +127,7 @@ messages : {} By default, the output will only contain the first level of the JSON object hierarchy (in the above example, the content of objects such as `hosts` and `certificates` is not shown). To show additional levels and format the output like the `jq` tool, you can use the `ConvertFrom-Json` cmdlet specifying the desired maximum depth (by default, `2`): ```powershell -PS C:\> Invoke-RestMethod -URI 'https://api.cloudflare.com/client/v4/zones/{zone_id}/ssl/certificate_packs?ssl_status=all' -Method 'GET' -ContentType 'application/json' -Headers @{'X-Auth-Email'='';'X-Auth-Key'=''} | ConvertTo-Json -Depth 5 +Invoke-RestMethod -URI 'https://api.cloudflare.com/client/v4/zones/{zone_id}/ssl/certificate_packs?ssl_status=all' -Method 'GET' -ContentType 'application/json' -Headers @{'X-Auth-Email'='';'X-Auth-Key'=''} | ConvertTo-Json -Depth 5 ``` ```json title="Example output" @@ -174,7 +174,7 @@ You can also use the curl tool in PowerShell. However, in PowerShell `curl` is a A typical `PATCH` request with curl will be similar to the following: ```powershell -PS C:\> curl.exe --request PATCH "https://api.cloudflare.com/client/v4/user/invites/{id}" --header "Authorization: Bearer " --data '{\"status\": \"accepted\"}' +curl.exe --request PATCH "https://api.cloudflare.com/client/v4/user/invites/{id}" --header "Authorization: Bearer " --data '{\"status\": \"accepted\"}' ``` To escape a double quote (`"`) character in a request body (specified with `-d` or `--data`), prepend it with another double quote (`"`) or a backslash (`\`). You must escape double quotes even when using single quotes (`'`) as string delimiters. @@ -182,7 +182,7 @@ To escape a double quote (`"`) character in a request body (specified with `-d` To break a single command in two or more lines, use a backtick (`` ` ``) character as the line continuation character at the end of a line: ```powershell -PS C:\> curl.exe --request PATCH ` +curl.exe --request PATCH ` "https://api.cloudflare.com/client/v4/user/invites/{id}" ` --header "X-Auth-Email: " ` --header "X-Auth-Key: " ` diff --git a/src/content/docs/magic-wan/configuration/manually/third-party/azure.mdx b/src/content/docs/magic-wan/configuration/manually/third-party/azure.mdx index 19bac0e1422dde..6bf03a6bc853fc 100644 --- a/src/content/docs/magic-wan/configuration/manually/third-party/azure.mdx +++ b/src/content/docs/magic-wan/configuration/manually/third-party/azure.mdx @@ -177,8 +177,10 @@ Once you have determined that connectivity has been established, Cloudflare reco 1. Determine the API token via PowerShell: ```powershell -PS C:\home\user_name> Get-AzAccessToken +Get-AzAccessToken +``` +```txt output Token: eyJ0eAH-PdSPg ExpiresOn : 04/08/2024 23:32:47 +00:00 Type : Bearer diff --git a/src/content/docs/style-guide/components/code.mdx b/src/content/docs/style-guide/components/code.mdx index 5ad1dcc41f7b19..dbfbb37ae71665 100644 --- a/src/content/docs/style-guide/components/code.mdx +++ b/src/content/docs/style-guide/components/code.mdx @@ -6,22 +6,22 @@ Code blocks are powered by [Expressive Code](https://expressive-code.com/), a pr This is just a small showcase of functionality, it has a lot of options! ````mdx live -```powershell title="PowerShell terminal example" +```powershell title="PowerShell" Write-Output "This one has a title!" ``` ```js wrap // Example with wrap function getLongString() { - return 'This is a very long string that will most probably not fit into the available space unless the container is extremely wide' + return "This is a very long string that will most probably not fit into the available space unless the container is extremely wide"; } ``` ```js "return true;" ins="inserted" del="deleted" function demo() { - console.log('These are inserted and deleted marker types'); - // The return statement uses the default marker type - return true; + console.log("These are inserted and deleted marker types"); + // The return statement uses the default marker type + return true; } ``` @@ -76,18 +76,18 @@ add a "Run Worker in Playground" link that will take the user to the [Worker's p ```js playground export default { - fetch() { - return new Response("Test!") - } -} + fetch() { + return new Response("Test!"); + }, +}; ``` ````mdx ```js playground export default { - fetch() { - return new Response("Test!") - } -} + fetch() { + return new Response("Test!"); + }, +}; ``` -```` \ No newline at end of file +```` diff --git a/src/content/docs/style-guide/formatting/code-block-guidelines.mdx b/src/content/docs/style-guide/formatting/code-block-guidelines.mdx index 480e8a97b793eb..6c0eadcd3bacf0 100644 --- a/src/content/docs/style-guide/formatting/code-block-guidelines.mdx +++ b/src/content/docs/style-guide/formatting/code-block-guidelines.mdx @@ -72,7 +72,9 @@ Blocks containing **Linux/macOS/generic** commands: ### For "powershell" blocks -Use "**PS FOLDER_NAME>** " (the `>` is part of the prompt, and there is a space after it). +By default, do not use any prompt prefixes for PowerShell commands. If you need to establish context (for example, you must be in a specific folder before running a command), using the following prompt: + +- "**PS FOLDER_NAME>** " (the `>` is part of the prompt, and there is a space after it). Examples: