Skip to content

Commit 15a9619

Browse files
committed
Review protocol list order.
1 parent afd65aa commit 15a9619

16 files changed

+40
-38
lines changed

cli/index.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ Paths can either denote a remote file `ftps://[email protected]/resource` or fold
157157

158158
### Connection Profiles
159159

160-
You can install additional [connection profiles](../protocols/profiles.md) in the [application support directory](#profiles). Use the `--profile` option to reference a [connection profile](../protocols/index.md#connection-profiles) file to use not installed in the standard location.
160+
You can install additional [connection profiles](../protocols/profiles/index.md) in the [application support directory](#profiles). Use the `--profile` option to reference a [connection profile](../protocols/index.md#connection-profiles) file to use not installed in the standard location.
161161

162162
### URI
163163

@@ -280,7 +280,7 @@ You can use the tilde to abbreviate the remote path pointing to the remote home
280280

281281
#### Custom configuration options for uploads to S3
282282

283-
Add default metadata for uploads using the [preferences option to read from the environment](#preferences). The property is documented in [Default metadata](../../s3/index.md#default-metadata).
283+
Add default metadata for uploads using the [preferences option to read from the environment](#preferences). The property is documented in [Default metadata](../protocols/s3/index.md#default-metadata).
284284

285285
env "s3.metadata.default=Content-Type=application/xml" duck --upload …
286286

@@ -356,7 +356,7 @@ The directory location is printed with `--help` following the list of supported
356356
`````{tabs}
357357
````{group-tab} macOS
358358
359-
The support directory is `~/Library/Group Containers/G69SCX94XU.duck/Library/Application Support/duck/` on Mac. You can install third party [profiles](../protocols/profiles.md) in `~/Library/Group Containers/G69SCX94XU.duck/Library/Application Support/duck/Profiles`.
359+
The support directory is `~/Library/Group Containers/G69SCX94XU.duck/Library/Application Support/duck/` on Mac. You can install third party [profiles](../protocols/profiles/index.md) in `~/Library/Group Containers/G69SCX94XU.duck/Library/Application Support/duck/Profiles`.
360360
361361
````
362362
````{group-tab} Windows
@@ -366,7 +366,7 @@ Install additional profiles in `%AppData%\Cyberduck\Profiles` on Windows.
366366
````
367367
````{group-tab} Linux
368368
369-
The support directory is `~/.duck/` on Linux. You can install third party [profiles](../protocols/profiles.md) in `~/.duck/profiles/`.
369+
The support directory is `~/.duck/` on Linux. You can install third party [profiles](../protocols/profiles/index.md) in `~/.duck/profiles/`.
370370
371371
````
372372
`````

cli/support.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The directory location is printed with `--help` following the list of supported
3030
`````{tabs}
3131
````{group-tab} macOS
3232
33-
You can install third party [profiles](../protocols/profiles.md) in `~/Library/Group Containers/G69SCX94XU.duck/Library/Application Support/duck/Profiles`.
33+
You can install third party [profiles](../protocols/profiles/index.md) in `~/Library/Group Containers/G69SCX94XU.duck/Library/Application Support/duck/Profiles`.
3434
3535
````
3636
````{group-tab} Windows
@@ -40,7 +40,7 @@ Install additional profiles in `%AppData%\Cyberduck\Profiles` on Windows.
4040
````
4141
````{group-tab} Linux
4242
43-
You can install third party [profiles](../protocols/profiles.md) in `~/.duck/profiles/`.
43+
You can install third party [profiles](../protocols/profiles/index.md) in `~/.duck/profiles/`.
4444
4545
````
4646
`````

cyberduck/connection.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -234,4 +234,4 @@ Connection profiles (`.cyberduckprofile`) are plugins describing specific connec
234234

235235
### File Format
236236

237-
Refer to the [technical documentation](../protocols/profiles.md).
237+
Refer to the [technical documentation](../protocols/profiles/index.md).

cyberduck/faq.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ There is also a [Chocolatey](http://chocolatey.org/packages?q=cyberduck) package
134134
`````{tabs}
135135
````{group-tab} macOS
136136
137-
Preferences are saved in `~/Library/Preferences/ch.sudo.cyberduck.plist`. Bookmarks, history, and [connection profiles](../protocols/profiles.md) are saved in the application support directory. These settings are shared with [Cyberduck CLI](../cli/index.md) and [Mountain Duck](../mountainduck/index.md).
137+
Preferences are saved in `~/Library/Preferences/ch.sudo.cyberduck.plist`. Bookmarks, history, and [connection profiles](../protocols/profiles/index.md) are saved in the application support directory. These settings are shared with [Cyberduck CLI](../cli/index.md) and [Mountain Duck](../mountainduck/index.md).
138138
139139
- `~/Library/Group Containers/G69SCX94XU.duck/Library/Application Support/duck/`
140140
@@ -143,7 +143,7 @@ Navigate to the *Library* folder using `⌘⇧-L` or use *Go → Go to Folder...
143143
````
144144
````{group-tab} Windows
145145
146-
Bookmarks, history, [connection profiles](../protocols/profiles.md), and workspace information are saved in the application data directory. You can navigate to the `AppData` folder by opening a *File Explorer* window and paste `%AppData%\Cyberduck` in the Quick access location field.
146+
Bookmarks, history, [connection profiles](../protocols/profiles/index.md), and workspace information are saved in the application data directory. You can navigate to the `AppData` folder by opening a *File Explorer* window and paste `%AppData%\Cyberduck` in the Quick access location field.
147147
148148
- `%AppData%\Cyberduck`
149149

index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ mountainduck/index
2929
:titlesonly:
3030
:caption: Supported Protocols
3131
protocols/index
32-
protocols/profiles
32+
protocols/profiles/index
3333
```
3434

3535
```{toctree}

protocols/google_cloud_storage.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Alternatively, you can reset the OAuth token by deleting the entries related to
4343

4444
#### Custom OAuth Client ID
4545

46-
You can register a [custom OAuth 2.0 client ID](google_client_id.md) with Google to operate independently of our registered client ID.
46+
You can register a [custom OAuth 2.0 client ID](profiles/google_client_id.md) with Google to operate independently of our registered client ID.
4747

4848
## Cyberduck CLI
4949

protocols/google_drive.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Alternatively, you can reset the OAuth token by deleting the entries related to
4242

4343
### Custom OAuth Client ID
4444

45-
You can register a [custom OAuth 2.0 client ID](google_client_id.md) with Google to operate independently of our registered client ID.
45+
You can register a [custom OAuth 2.0 client ID](profiles/google_client_id.md) with Google to operate independently of our registered client ID.
4646

4747
## Cyberduck CLI
4848
You can list the root contents of your Google Drive with [Cyberduck CLI](https://duck.sh/) using

protocols/index.md

+12-13
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,27 @@ Protocols
44
```{toctree}
55
:hidden:
66
:titlesonly:
7-
profiles
8-
openstack/index
9-
s3/index
7+
profiles/index
8+
ftp
9+
sftp
1010
webdav/index
11+
s3/index
12+
google_cloud_storage
13+
openstack/index
1114
azure
1215
b2
13-
dracoon
1416
dropbox
15-
files.com
16-
ftp
17-
google_client_id
18-
google_cloud_storage
1917
google_drive
20-
box
21-
irods
2218
onedrive
23-
sftp
2419
sharepoint
20+
box
21+
files.com
22+
dracoon
23+
irods
2524
spectra
2625
```
2726

28-
All major server and cloud storage protocols are supported to connect to just about any server or cloud storage. Support for the listed protocols and [connection profiles](profiles.md) is available in [Cyberduck](../cyberduck/index.md), [Cyberduck CLI](../cli/index.md) and [Mountain Duck](../mountainduck/index.md).
27+
All major server and cloud storage protocols are supported to connect to just about any server or cloud storage. Support for the listed protocols and [connection profiles](profiles/index.md) is available in [Cyberduck](../cyberduck/index.md), [Cyberduck CLI](../cli/index.md) and [Mountain Duck](../mountainduck/index.md).
2928

3029
### [FTP](ftp.md)
3130
With support for secure TLS connections and custom origin [Amazon CloudFront (Content Delivery Network) distribution](../cdn/cloudfront) option.
@@ -90,7 +89,7 @@ Open a window to browse your local hard disk to drag files for download or uploa
9089

9190
## Connection Profiles
9291

93-
[Connection profiles](profiles.md) (`.cyberduckprofile`) are plugins describing specific connection settings for a hosting provider to make it easier to setup a connection to your provider. A connection profile is installed and adds a provider option in the protocol selection drop down menu in the *Connection* and *Bookmark* panels. No need to enter the connection details manually other than credentials.
92+
[Connection profiles](profiles/index.md) (`.cyberduckprofile`) are plugins describing specific connection settings for a hosting provider to make it easier to setup a connection to your provider. A connection profile is installed and adds a provider option in the protocol selection drop down menu in the *Connection* and *Bookmark* panels. No need to enter the connection details manually other than credentials.
9493

9594
### Preferences → Profiles
9695

protocols/openstack/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ You can set the [hidden option](../../cyberduck/preferences.md#hidden-configurat
145145

146146
### Multiple OpenStack Swift Containers in Different Regions with the Same Name
147147

148-
Browsing containers will be erratic. As a workaround, browse a region by using a [connection profile](../profiles.md) limited to a single region as with [Rackspace Cloudfiles region profiles](cloudfiles.md#profile-for-a-single-region).
148+
Browsing containers will be erratic. As a workaround, browse a region by using a [connection profile](../profiles/index.md) limited to a single region as with [Rackspace Cloudfiles region profiles](cloudfiles.md#profile-for-a-single-region).
149149

150150
### In Finder.app, Creating a new top-level Folder in OpenStack Swift will not Allow to Rename it from `untitled folder`
151151

protocols/google_client_id.md renamed to protocols/profiles/google_client_id.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Custom OAtuh 2.0 Client ID for Google Cloud Storage and Google Drive
1+
Custom OAuth 2.0 Client ID for Google Cloud Storage and Google Drive
22
====
33

44
> To use OAuth 2.0 in your application, you need an OAuth 2.0 client ID, which your application uses when requesting an OAuth 2.0 access token.
@@ -11,7 +11,7 @@ Login using OAuth is currently failing with the default OAuth Client ID applicat
1111
Sign in with Google temporarily disabled for this app. This app has not been verified yet by Google in order to use Google Sign In.
1212
```
1313

14-
As a workaround, you can register your own OAuth Client ID to connect to [Google Drive](google_drive.md). For [Google Storage](google_cloud_storage.md) you can use [Interoperable Access](google_cloud_storage.md#interoperable-access) as a workaround.
14+
As a workaround, you can register your own OAuth Client ID to connect to [Google Drive](../google_drive.md). For [Google Storage](../google_cloud_storage.md) you can use [Interoperable Access](../google_cloud_storage.md#interoperable-access) as a workaround.
1515

1616
## Register Client ID
1717

@@ -30,15 +30,15 @@ Follow the steps in [Setting up OAuth 2.0](https://support.google.com/googleapi/
3030

3131
## Edit Custom Connection Profile
3232

33-
Create a custom [connection profile](profiles.md) with the following properties.
33+
Create a custom [connection profile](index.md) with the following properties.
3434

3535
- `OAuth Client ID`. Override the registered application client id.
3636
- `OAuth Client Secret`. Override the registered application client secret.
3737

3838
### Sample Google Drive with Custom OAuth Client ID Connection Profile
3939

40-
- {download}`Google Drive Custom OAuth Client ID.cyberduckprofile<_static/Ressources/Google Drive Custom OAuth Client ID.cyberduckprofile>`
40+
- {download}`Google Drive Custom OAuth Client ID.cyberduckprofile<_static/Google Drive Custom OAuth Client ID.cyberduckprofile>`
4141

4242
### Sample Google Cloud Storage with Custom OAuth Client ID Connection Profile
4343

44-
- {download}`Google Storage Custom OAuth Client ID.cyberduckprofile<_static/Ressources/Google Storage Custom OAuth Client ID.cyberduckprofile>`
44+
- {download}`Google Storage Custom OAuth Client ID.cyberduckprofile<_static/Google Storage Custom OAuth Client ID.cyberduckprofile>`

protocols/profiles.md renamed to protocols/profiles/index.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
Connection Profiles
22
====
33

4-
[Connection profiles](../cyberduck/connection.md#connection-profiles) (`.cyberduckprofile`) are documents describing connection settings for a hosting provider.
4+
[Connection profiles](../../cyberduck/connection.md#connection-profiles) (`.cyberduckprofile`) are documents describing connection settings for a hosting provider.
55

66
```{note}
77
All connection profiles are available through the *Preferences → Profiles* tab.
88
```
99

10-
- [Third-Party S3 providers](s3/index.md#third-party-providers)
11-
- [OpenStack Providers](openstack/index.md#third-party-providers)
10+
- [Third-Party S3 providers](../s3/index.md#third-party-providers)
11+
- [OpenStack Providers](../openstack/index.md#third-party-providers)
1212

1313
## Installation
1414
Connection profiles can be activated by either installing the file by double clicking a `.cyberduckprofile` file to open and register or enabling in _Preferences → Profiles_.
@@ -43,12 +43,15 @@ The value of `Vendor` must be unique among all installed connection profiles.
4343
- `Anonymous Configurable` Boolean if anonymous access is configurable.
4444
- `Path Configurable` Boolean if default path is configurable.
4545
- `Certificate Configurable` Boolean if client certificate is configurable.
46-
- `Region` Region name to limit listing containers of a specific region only for [OpenStack Swift](openstack/index.md) and [S3](s3/index.md) profiles. For S3, this value is used for AWS4 signatures when no location can be deferred from the URI for third-party S3 providers.
47-
- `Regions` List of regions supported by the provider. This will populate options in the *Regions* dropdown when creating a new [top level folder](s3/index.md#creating-a-bucket) for [S3](s3/index.md) and [OpenStack Swift](openstack/swiftstack.md) connections.
46+
- `Region` Region name to limit listing containers of a specific region only for [OpenStack Swift](../openstack/index.md) and [S3](../s3/index.md) profiles. For S3, this value is used for AWS4 signatures when no location can be deferred from the URI for third-party S3 providers.
47+
- `Regions` List of regions supported by the provider. This will populate options in the *Regions* dropdown when creating a new [top level folder](../s3/index.md#creating-a-bucket) for [S3](../s3/index.md) and [OpenStack Swift](../openstack/swiftstack.md) connections.
4848
- `OAuth Client ID` For protocols using OAuth 2.0 you can override the registered application client ID with the provider.
4949
- `OAuth Client Secret` For protocols using OAuth 2.0 you can override the registered application client secret with the provider.
50+
```{note}
51+
Refer to [Custom OAuth 2.0 Client ID for Google Cloud Storage and Google Drive](google_client_id.md).
52+
```
5053
- `Authorization` Set to `AWS2` to default to AWS2 signature authentication for S3. Default is `AWS4HMACSHA256`.
51-
- `Properties` List of custom protocol-specific properties. You can set [hidden configuration options](../cyberduck/preferences.md#hidden-configuration-options) for a specific connection profile. Example usages can be found in:
54+
- `Properties` List of custom protocol-specific properties. You can set [hidden configuration options](../../cyberduck/preferences.md#hidden-configuration-options) for a specific connection profile. Example usages can be found in:
5255
* [FTP (Compatibility Mode).cyberduckprofile](https://github.com/iterate-ch/cyberduck/blob/master/profiles/FTP%20(Compatibility%20Mode).cyberduckprofile)
5356
* [FTP-SSL (Compatibility Mode).cyberduckprofile](https://github.com/iterate-ch/cyberduck/blob/master/profiles/FTP-SSL%20(Compatibility%20Mode).cyberduckprofile)
5457
* [S3 (Deprecated path style requests).cyberduckprofile](https://github.com/iterate-ch/cyberduck/blob/master/profiles/S3%20(Deprecated%20path%20style%20requests).cyberduckprofile)

protocols/s3/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -595,7 +595,7 @@ Make sure to enable the modification date preservation within *Preferences → T
595595

596596
### Disable use of Virtual Host Style Requests
597597

598-
Set the [hidden preference](../../cyberduck/preferences.md#hidden-configuration-options) `s3.bucket.virtualhost.disable` to `true` if your S3 compatible storage does only support path style requests to reference buckets. Alternatively a custom connection [profile](../profiles.md) with the property set in `Properties`.
598+
Set the [hidden preference](../../cyberduck/preferences.md#hidden-configuration-options) `s3.bucket.virtualhost.disable` to `true` if your S3 compatible storage does only support path style requests to reference buckets. Alternatively a custom connection [profile](../profiles/index.md) with the property set in `Properties`.
599599

600600
- {download}`Download<https://github.com/iterate-ch/cyberduck/raw/master/profiles/S3%20(Deprecated%20path%20style%20requests).cyberduckprofile>` the *S3 (Deprecated path style requests) profile* for preconfigured settings.
601601

0 commit comments

Comments
 (0)