From 927721ebb82b5a71bdf50b4addc69f1e7f0dc787 Mon Sep 17 00:00:00 2001 From: tatze96 Date: Fri, 16 Aug 2024 12:33:13 +0200 Subject: [PATCH 1/2] Replaced ``` with :::, adjusted formatting --- Formatting_Cheat-Sheet.md | 25 +- cli/index.md | 183 ++++----- cli/support.md | 32 +- cryptomator/index.md | 127 +++--- cyberduck/bookmarks.md | 109 +++--- cyberduck/browser.md | 110 +++--- cyberduck/connection.md | 80 ++-- cyberduck/copy.md | 4 +- cyberduck/download.md | 24 +- cyberduck/edit.md | 41 +- cyberduck/faq.md | 20 +- cyberduck/index.md | 12 +- cyberduck/info.md | 165 ++++---- cyberduck/installation.md | 38 +- cyberduck/notifications.md | 22 +- cyberduck/preferences.md | 37 +- cyberduck/share.md | 156 ++++---- cyberduck/spotlight.md | 12 +- cyberduck/support.md | 56 +-- cyberduck/sync.md | 8 +- cyberduck/transfer.md | 73 ++-- cyberduck/upload.md | 41 +- index.md | 20 +- mountainduck/connect/index.md | 22 +- mountainduck/connect/online.md | 22 +- mountainduck/connect/sync.md | 98 +++-- mountainduck/index.md | 4 +- mountainduck/info.md | 4 +- mountainduck/installation/index.md | 80 ++-- mountainduck/installation/licensing.md | 12 +- mountainduck/interface.md | 121 +++--- mountainduck/issues/index.md | 127 +++--- mountainduck/locking.md | 57 +-- mountainduck/preferences.md | 119 +++--- mountainduck/share.md | 4 +- mountainduck/support.md | 42 +- mountainduck/versions.md | 17 +- protocols/azure.md | 29 +- protocols/b2.md | 34 +- protocols/box.md | 20 +- protocols/cdn/akamai.md | 4 +- protocols/cdn/cloudfront.md | 18 +- protocols/cdn/index.md | 4 +- protocols/dracoon.md | 8 +- protocols/dropbox.md | 29 +- protocols/ftp.md | 64 +-- protocols/googlecloudstorage.md | 29 +- protocols/googledrive.md | 35 +- protocols/index.md | 59 ++- protocols/irods.md | 21 +- protocols/onedrive.md | 25 +- protocols/openstack/auro.md | 4 +- protocols/openstack/cloudfiles.md | 12 +- protocols/openstack/index.md | 20 +- protocols/openstack/infomaniak.md | 14 +- protocols/openstack/memset.md | 5 +- protocols/openstack/ovh.md | 17 +- protocols/openstack/selectel.md | 4 +- protocols/openstack/swiftstack.md | 4 +- protocols/profiles/aws_oidc.md | 4 +- protocols/profiles/google_client_id.md | 13 +- protocols/profiles/index.md | 54 +-- protocols/s3/alibaba.md | 8 +- protocols/s3/digitalocean.md | 8 +- protocols/s3/dreamobjects.md | 8 +- protocols/s3/dunkel.md | 4 +- protocols/s3/garage.md | 4 +- protocols/s3/iam.md | 44 ++- protocols/s3/ibmcos.md | 4 +- protocols/s3/index.md | 514 ++++++++++--------------- protocols/s3/ionos.md | 4 +- protocols/s3/linode.md | 8 +- protocols/s3/minio.md | 4 +- protocols/s3/oraclecloud.md | 14 +- protocols/s3/scaleway.md | 4 +- protocols/s3/seagate.md | 8 +- protocols/s3/spectra.md | 8 +- protocols/s3/synology.md | 7 +- protocols/s3/vitanium.md | 4 +- protocols/s3/wasabi.md | 12 +- protocols/s3/z1.md | 4 +- protocols/sftp/index.md | 223 ++++++----- protocols/sharepoint.md | 21 +- protocols/smb.md | 8 +- protocols/webdav/index.md | 44 ++- protocols/webdav/nextcloud.md | 65 ++-- protocols/webdav/pcloud.md | 12 +- 87 files changed, 1890 insertions(+), 1808 deletions(-) diff --git a/Formatting_Cheat-Sheet.md b/Formatting_Cheat-Sheet.md index c9924e9d..03abe549 100644 --- a/Formatting_Cheat-Sheet.md +++ b/Formatting_Cheat-Sheet.md @@ -5,6 +5,18 @@ orphan: true Formatting Cheat Sheet ==== +## General Formatting Guidelines + +Add an empty line... +- ...after a heading +- ...before and after an admonition or codeblock +- ...after the admonition class for custom admonitions +- ...after a tab opening and before a tab closing as shown in the [Tabs Section](#tabs) +- ...before and after tables +- ...before and after image inserts with custom properties + +Don't add an empty line around admonitions within lists + ## Footnotes - This is a manually-numbered footnote reference.[^3] @@ -28,19 +40,18 @@ that are not separated by a blank line ## Tabs -````{tabs} - -```{group-tab} macOS +::::{tabs} +:::{group-tab} macOS test -``` -```{group-tab} Windows +::: +:::{group-tab} Windows test -``` -```` +::: +:::: --- diff --git a/cli/index.md b/cli/index.md index 2f08fac1..278c386c 100644 --- a/cli/index.md +++ b/cli/index.md @@ -1,43 +1,47 @@ Command Line Interface (CLI) ==== -```{toctree} +:::{toctree} :hidden: :titlesonly: support -``` +::: [Cyberduck with a command-line interface (CLI)](https://duck.sh/) is available for Mac, Windows & Linux. It is installed as `duck`. -```{contents} Content +:::{contents} Content :depth: 2 :local: -``` +::: ## Installation -`````{tabs} -````{group-tab} macOS +:::::{tabs} +::::{group-tab} macOS **Homebrew** Available as a [Homebrew](http://brew.sh/) package. Use -```{code-block} + +``` brew install duck ``` -to install. +to install. **MacPorts** The port is maintained by a third party. Use -```{code-block} + +``` sudo port install duck ``` + to install. **Snapshot Builds** -```{code-block} + +``` brew install iterate-ch/cyberduck/duck ``` @@ -45,35 +49,34 @@ brew install iterate-ch/cyberduck/duck [Download](https://dist.duck.sh) the latest installer package. -```` -````{group-tab} Windows +:::: +::::{group-tab} Windows **Chocolatey** Available as a [Chocolatey](https://chocolatey.org) package. Use -```{code-block} + +``` choco install duck ``` -to install. - +to install. **MSI Installer** [Download](https://dist.duck.sh) the latest setup. - **Snapshot Builds** Not currently available. -```{image} _images/CLI_Setup.png +:::{image} _images/CLI_Setup.png :alt: CLI Setup :width: 500px -``` +::: -```` -````{group-tab} Linux +:::: +:::::{group-tab} Linux **RPM Package Repository** @@ -83,7 +86,7 @@ To add the `duck` repository to your system you need to put a file `duck.repo` w Copy and paste -```{code-block} +``` echo -e "[duck-nightly]\n\ name=duck-nightly\n\ baseurl=https://repo.cyberduck.io/nightly/\$basearch/\n\ @@ -95,7 +98,7 @@ to add the configuration. **Stable Builds** -```{code-block} +``` echo -e "[duck-stable]\n\ name=duck-stable\n\ baseurl=https://repo.cyberduck.io/stable/\$basearch/\n\ @@ -109,44 +112,41 @@ To install *Cyberduck CLI* use **DEB Package Repository** 1. Add the nightly or stable `duck` repository to your `/etc/apt/sources.list` manually: -```{code-block} +``` deb https://s3.amazonaws.com/repo.deb.cyberduck.io nightly main deb https://s3.amazonaws.com/repo.deb.cyberduck.io stable main ``` or using -```{code-block} +``` echo -e "deb https://s3.amazonaws.com/repo.deb.cyberduck.io stable main" | sudo tee /etc/apt/sources.list.d/cyberduck.list > /dev/null ``` 2. You need to download the GPG public key from `keyserver.ubuntu.com` to verify the integrity of the packages: -```{code-block} +``` sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys FE7097963FEFBE72 ``` - 3. Synchronize the repository using -```{code-block} +``` sudo apt-get update ``` - 4. To install or upgrade *Cyberduck CLI* use -```{code-block} +``` sudo apt-get install duck ``` -```{warning} +:::{warning} You may get a conflict with another package named `duck`. As a workaround, install with a specific version number like `sudo apt-get install duck=6.7.1.28683`. -``` +::: **Arch Linux Package** - [Package Details](https://aur.archlinux.org/packages/duck/). *Note*: This is maintained by a third party. - **Manual Installation** Packages can also be found for [download](https://dist.duck.sh/). -```` -````` +:::: +::::: ## Usage @@ -156,9 +156,9 @@ Run `--help` to get the option screen. URLs in arguments must be fully qualified. You can reference files relative to your home directory with `/~ftps://user@example.net/~/`. -```{attention} +:::{attention} Paths can either denote a remote file `ftps://user@example.net/resource` or folder `ftps://user@example.net/directory/` with a trailing `/`. -``` +::: ### Connection Profiles @@ -174,15 +174,15 @@ The `` argument for `--copy`, `--download`, `--upload`, and `--synchronize` - For all protocols where a default hostname is set, but you are allowed to change it (e.g. S3) you may use fully qualified URIs or *Absolute paths:* `s3:/bucket/path`, *Relative paths:* `s3:user@path` or `s3:user@/path`. - ```{note} + :::{note} Omitting the first slash in a relative path uses the default home directory for this protocol. - ``` + ::: - For all protocols where a default hostname is set and you are not allowed to change it (e.g. `OneDrive`, `Dropbox`, `Google Drive`) you may use any combination of the above with the following rules: Fully Qualified URIs are parsed as relative paths. `onedrive://Some/Folder/` is parsed as `onedrive:Some/Folder`. - For all protocols where a default path is set and you are not allowed to change it (e.g. accessing a prebuilt `NextCloud` profile with a path set to `/remote.php/webdav`). You are allowed to change the path but it will be appended to the default path. Making nextcloud:/path really `nextcloud:/remote.php/webdav/path`. -```{note} +:::{note} Spaces and other special-characters are not required to be percent-encoded (e.g. `%20` for space) as long as the path is quoted `duck --upload "scheme://hostname/path with/spaces" "/Path/To/Local/File With/Spaces"`. -``` +::: | Protocol | Fully Qualified URI required | Absolute Path | Relative Path | |----------------------------------------|----------------------------------------------------|---------------------------------------------------------|--------------------------------------------------------| @@ -208,25 +208,26 @@ Spaces and other special-characters are not required to be percent-encoded (e.g. #### Examples -```{admonition} Home Directory +:::{admonition} Home Directory :class: tip + You can use the `~` character to abbreviate the remote path pointing to the home folder on the server as in `duck --list sftp://duck.sh/~/`. -``` +::: - List all buckets in S3 with -```{code-block} +``` duck --username --list s3:/ ``` - List all objects in a S3 bucket with -```{code-block} +``` duck --username --list s3:// ``` - List a vault on OneDrive without using the `--vault` option -```{code-block} +``` duck --list "onedrive:/My Files//" ``` - Download a single file from a vault on OneDrive -```{code-block} +``` duck --download "onedrive:/My Files//" ~/Downloads/ --vault "/My Files//" ``` @@ -266,20 +267,20 @@ When connecting with `OpenStack Swift` you can set the tenant name (*OpenStack I ### Downloads with `--download` -* Download file `` to directory `` on disk using -```{code-block} +- Download file `` to directory `` on disk using +``` duck --download protocol:/ / ``` - -* Download file `` as `` to directory `` on disk using -```{code-block} +- Download file `` as `` to directory `` on disk using +``` duck --download protocol:/ / ``` #### Glob Pattern Support for Selecting Files to Transfer You can transfer multiple files with a single command using a glob pattern for filename inclusion such as -```{code-block} + +``` duck --download protocol:///directory/*.css ``` @@ -287,32 +288,31 @@ duck --download protocol:///directory/*.css Note the inclusion or absence of a trailing `/` delimiter character to denote a file or directory on the server. -* Upload the `` on disk to remote directory `/` using -```{code-block} +- Upload the `` on disk to remote directory `/` using +``` duck --upload protocol:// / ``` - -* Upload file `` to remote directory `` using -```{code-block} +- Upload file `` to remote directory `` using +``` duck --upload protocol:// ``` - -* Upload file `` as `` to remote directory `` using -```{code-block} +- Upload file `` as `` to remote directory `` using +``` duck --upload protocol:// ``` #### Glob Pattern Support for Selecting Files to Transfer If your shell supports glob expansion you can use a wildcard pattern to select files for upload like -```{code-block} + +``` duck --upload protocol:///directory/ ~/*.jpg ``` ### Synchronize Folders with `--synchronize` -* Synchronize directory `` with directory `folder` on disk using -```{code-block} +- Synchronize directory `` with directory `folder` on disk using +``` duck --synchronize protocol:// folder/ ``` @@ -320,12 +320,15 @@ duck --synchronize protocol:// folder/ 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). - env "s3.metadata.default=Content-Type=application/xml" duck --upload … +``` +env "s3.metadata.default=Content-Type=application/xml" duck --upload … +``` Set a default ACL for the upload with - env "s3.acl.default=public-read" duck --upload … - +``` +env "s3.acl.default=public-read" duck --upload … +``` ### Remote Directory Listing with `--list` @@ -338,7 +341,8 @@ You can edit remote files with your preferred editor on your local system using ### Purge Files in CDN with `--purge` Purge files in CloudFront or Akamai CDN for Amazon S3 or Rackspace CloudFiles connections. For example to invalidate all contents in a bucket run -```{code-block} + +``` duck --username AKIAIWQ7UM47TA3ONE7Q --purge s3:/github-cyberduck-docs/ ``` @@ -358,7 +362,7 @@ Use `--vault ` in conjunction with `--upload` to unlock a Vault. This allo `fswatch` is a file change monitor; an application to watch for file system changes. Refer to their [documentation](https://github.com/emcrisostomo/fswatch/wiki). -```{code-block} +``` fswatch -0 ~/Sites/mywebsite/ | xargs -0 -I {} -t sh -c 'f="{}"; duck --upload ftps:///sandbox`basename "${f}"` "${f}" -existing overwrite' ``` @@ -366,22 +370,25 @@ fswatch -0 ~/Sites/mywebsite/ | xargs -0 -I {} -t sh -c 'f="{}"; duck --upload f use a post [build script action](https://plugins.jenkins.io/postbuildscript/). -```{code-block} +``` cd ${WORKSPACE}; find build -name '*.tar' -print0 | xargs -0 -I {} -t sh -c 'f="{}"; duck --quiet --retry --existing skip --region DFW --upload rackspace:/// "${f}"' ``` ### Upload Files Matching Glob Pattern to Windows Azure -```{code-block} + +``` duck --username kahy9boj3eix --upload azure://kahy9boj3eix.blob.core.windows.net// *.zip ``` ### Download Files Matching Glob Pattern from S3 -```{code-block} + +``` duck --user anonymous --verbose --download s3:/profiles.cyberduck.io/Wasabi* ~/Downloads/ ``` ### Download File from Amazon S3 Public Bucket -```{code-block} + +``` duck --user anonymous --download s3:/repo.maven.cyberduck.io/releases/ch/cyberduck/s3/6.1.0/s3-6.1.0.jar ~/Downloads/ ``` @@ -391,49 +398,49 @@ duck --user anonymous --download s3:/repo.maven.cyberduck.io/releases/ch/cyberdu The directory location is printed with `--help` following the list of supported protocols. -`````{tabs} -````{group-tab} macOS +::::{tabs} +:::{group-tab} macOS 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`. -```` -````{group-tab} Windows +::: +:::{group-tab} Windows Install additional profiles in `%AppData%\Cyberduck\Profiles` on Windows. -```` -````{group-tab} Linux +::: +:::{group-tab} Linux The support directory is `~/.duck/` on Linux. You can install third party [profiles](../protocols/profiles/index.md) in `~/.duck/profiles/`. -```` -````` +::: +:::: ## Preferences -`````{tabs} -````{group-tab} macOS +::::{tabs} +:::{group-tab} macOS You can override default [preferences](../cyberduck/preferences.md#hidden-configuration-options) by setting environment variables in your shell. `env "property.name=value" duck` -```` -````{group-tab} Windows +::: +:::{group-tab} Windows You can override default [preferences](../cyberduck/preferences.md#hidden-configuration-options) by setting environment variables in your shell. `set "property.name=value" & duck` -```` -````{group-tab} Linux +::: +:::{group-tab} Linux You can override default [preferences](../cyberduck/preferences.md#hidden-configuration-options) by setting environment variables in your shell. `env "property.name=value" duck` -```` -````` +::: +:::: ## Known Issues diff --git a/cli/support.md b/cli/support.md index d24b5719..06a8cb54 100644 --- a/cli/support.md +++ b/cli/support.md @@ -3,47 +3,47 @@ Support ## Application Support Directory -`````{tabs} -````{group-tab} macOS +::::{tabs} +:::{group-tab} macOS You can reach the application support folder by choosing `Go → Go to folder` within the *Finder* menu, copying the path below into the appearing window, and clicking on the *Open* button afterward. `~/Library/Group Containers/G69SCX94XU.duck/Library/Application Support/duck/` -```` -````{group-tab} Windows +::: +:::{group-tab} Windows You can reach the application support folder by navigating to `%AppData%\Cyberduck` by copying the path into the address bar of the Explorer and press *Return* afterward. -```` -````{group-tab} Linux +::: +:::{group-tab} Linux The support directory is `~/.duck/`. -```` -````` +::: +:::: ### Profiles The directory location is printed with `--help` following the list of supported protocols. -`````{tabs} -````{group-tab} macOS +::::{tabs} +:::{group-tab} macOS You can install third party [profiles](../protocols/profiles/index.md) in `~/Library/Group Containers/G69SCX94XU.duck/Library/Application Support/duck/Profiles`. -```` -````{group-tab} Windows +::: +:::{group-tab} Windows Install additional profiles in `%AppData%\Cyberduck\Profiles` on Windows. -```` -````{group-tab} Linux +::: +:::{group-tab} Linux You can install third party [profiles](../protocols/profiles/index.md) in `~/.duck/profiles/`. -```` -````` +::: +:::: ## Logging Output diff --git a/cryptomator/index.md b/cryptomator/index.md index 6630572b..3f97e482 100644 --- a/cryptomator/index.md +++ b/cryptomator/index.md @@ -1,72 +1,72 @@ Cryptomator ==== -```{toctree} +:::{toctree} :hidden: :titlesonly: architecture/index.md -``` +::: -```{image} _images/cryptomator.png +:::{image} _images/cryptomator.png :alt: Cryptomator :width: 400px -``` +::: Support for client-side encryption with [Cryptomator](https://cryptomator.org/) interoperable vaults to secure your data on any server or cloud storage. -```{image} _images/Browse_Cryptomator_Vault.gif +:::{image} _images/Browse_Cryptomator_Vault.gif :alt: Browse Cryptomator Vault :width: 600px -``` +::: The client-side encryption feature in Cyberduck and Mountain Duck is based on the excellent concepts and work of [Cryptomator](https://cryptomator.org/). Cryptomator is free and open-source software. Since Cyberduck is also open-source software anyone is able to audit the source code. That means no security by obscurity, no hidden backdoors from third parties, no need to trust anyone except yourself. -```{tip} +:::{tip} Compared to other client-side-encryption solutions, the Cryptomator based approach yields a few crucial advantages: - In addition to file content encryption, file and directory names are encrypted and directory structures obfuscated. - No online services, no subscriptions, no accounts. - No need to share your cloud storage provider credentials. -``` +::: ## Create new Vault You can create a new vault directory anywhere on your remote storage. This will initialize the vault with a `masterkey.cryptomator`. A backup of the master key file (`masterkey.cryptomator`) is saved in user defaults. The encrypted keys in `masterkey.cryptomator` are not more sensitive than the encrypted files in the vault. For technical aspects, refer to [Masterkey Derivation](https://docs.cryptomator.org/en/latest/security/architecture/#masterkey-derivation). -`````{tabs} -````{group-tab} Cyberduck +:::::{tabs} +::::{group-tab} Cyberduck Choose *File → New Vault…* to create a new vault. -```{image} _images/New_Encrypted_Vault_File_Menu_Option.png +:::{image} _images/New_Encrypted_Vault_File_Menu_Option.png :alt: New Encrypted Vault File Menu Option :width: 400px -``` +::: -```` -````{group-tab} Mountain Duck +:::: +::::{group-tab} Mountain Duck - Choose *New Vault…* from the Finder Extension toolbar or context menu using right-click in Finder or Windows Explorer. -```{image} _images/Mountain_Duck_Create_New_Vault_Finder_Extension.png +:::{image} _images/Mountain_Duck_Create_New_Vault_Finder_Extension.png :alt: Mountain Duck Create New Vault (Finder Extension) :width: 400px -``` +::: -```{image} _images/Mountain_Duck_Create_New_Vault_Windows_Explorer.png +:::{image} _images/Mountain_Duck_Create_New_Vault_Windows_Explorer.png :alt: Mountain Duck Create New Vault (Windows Explorer) :width: 400px -``` +::: - Choose a name for the Vault folder and a passphrase to secure the Vault. -```{image} _images/Create_New_Vault.png +:::{image} _images/Create_New_Vault.png :alt: Create New Vault :width: 400px -``` +::: -```` -````` +:::: +::::: ## Unlock Vault @@ -74,68 +74,68 @@ Choose *File → New Vault…* to create a new vault. When _Preferences → Cryptomator → Auto detect and open vault in browser_ is enabled, opening a directory in the browser that is a Cryptomator Vault, a prompt is displayed to unlock the vault using the provided passphrase and decrypt the directory and filenames. If you cancel the prompt, the encrypted vault content is displayed. -`````{tabs} -````{group-tab} macOS +:::::{tabs} +::::{group-tab} macOS -```{image} _images/Mountain_Duck_Unlock_Vault.png +:::{image} _images/Mountain_Duck_Unlock_Vault.png :alt: Mountain Duck Unlock Vault :width: 400px -``` +::: -```` -````{group-tab} Windows +:::: +::::{group-tab} Windows -```{image} _images/Mountain_Duck_Unlock_Vault_Windows.png +:::{image} _images/Mountain_Duck_Unlock_Vault_Windows.png :alt: Mountain Duck Unlock Vault (Windows) :width: 400px -``` +::: -```` -````` +:::: +::::: ### Manual -````{tabs} -```{group-tab} Cyberduck +::::{tabs} +:::{group-tab} Cyberduck Choose the *Cryptomator* button in the toolbar or *File → Unlock Vault* and *File →Lock Vault* menu to unlock or lock a vault respectively. -``` -```{group-tab} Mountain Duck +::: +:::{group-tab} Mountain Duck Lock and unlock vaults within the Finder or Windows Explorer using the context menu: `Mountain Duck → Cryptomator → Lock Vault` `Mountain Duck → Cryptomator → Unlock Vault` -``` -```` +::: +:::: -```{attention} +:::{attention} The menu option is disabled if you have set Preferences → Cryptomator → Auto detect and open vault in browser -``` +::: ### Save Passphrase You can check *Add to Keychain* to save the passphrase to open the vault with the master key file in your login keychain. The checkbox is disabled by default. Another application that wants to access the vault passphrase from the login keychain will trigger a permission prompt. -```{image} _images/Keychain_Access_Crpytomator_Passphrase.png +:::{image} _images/Keychain_Access_Crpytomator_Passphrase.png :alt: Keychain Access Cryptomator Passphrase :width: 400px -``` +::: -`````{tabs} -````{group-tab} macOS +::::{tabs} +:::{group-tab} macOS Manage your passwords with *Keychain Access.app* on Mac. Refer to [Keychain for Mac: Keychain Access overview](https://support.apple.com/kb/PH20093?locale=en_US). -```` -````{group-tab} Windows +::: +:::{group-tab} Windows Passwords are saved in the *Credential Manager*. You can view and delete your saved login information in *Control Panel → User Accounts → Credential Manager → Windows Credentials*. -```` -````` +::: +:::: ### File Transfers @@ -151,50 +151,47 @@ When renaming a vault the behaviour depends on whether the vault is locked or un You can open and browse multiple vaults on a server in a single browser window. For each vault to be opened you will be prompted to enter your passphrase to decrypt the filenames. Decrypted filenames when browsing a vault will show a padlock overlay icon. -```{image} _images/Cryptomator_Vault_Browser.png +:::{image} _images/Cryptomator_Vault_Browser.png :alt: Cryptomator Vault Browser :width: 400px -``` +::: ### Moving Files Into Vault You can move files from and to the vault. Because files need to be encrypted or decrypted respectively they pass through your local computer and cannot be moved on the server-side. -```{attention} +:::{attention} The vault must be unlocked before you move files to it, otherwise the files won't be encrypted. -``` +::: ### Access Vaults on Local Disk Both [Cyberduck](https://cyberduck.io/) and [Mountain Duck](https://mountainduck.io/) support browsing your local disk to access vaults created on your computer. Create a new [bookmark](../cyberduck/bookmarks) to connect to your local disk. -```{image} _images/local_disk_connection.png +:::{image} _images/local_disk_connection.png :alt: Local Disk Connection :width: 400px -``` +::: In your local disk connection, you can access all directories which are saved on your local disk. This includes for example your local synchronized [Dropbox](../protocols/dropbox), [Google Drive](../protocols/googledrive) and [OneDrive](../protocols/onedrive) directories. -````{admonition} Access a Cryptomator Vault on local disk on the example of Dropbox +::::{admonition} Access a Cryptomator Vault on local disk on the example of Dropbox :class: note 1. Navigate to the Dropbox directory and open the subdirectories until you reach your vault. 2. Double click your vault. 3. Type your set password in the password box. If you want you can save the password for easier access to this directory for further usage. - -```{image} _images/access_Cryptomator_vault_Mountain_Duck.png +:::{image} _images/access_Cryptomator_vault_Mountain_Duck.png :alt: Mountain Duck Cryptomator Vault :width: 400px -``` - -```{image} _images/access_Cryptomator_vault_Cyberduck.png +::: +:::{image} _images/access_Cryptomator_vault_Cyberduck.png :alt: Cyberduck Access Cryptomator Vault :width: 400px -``` - +::: 4. Click the Continue button and your vault should open. -```` +:::: ## Known Limitations @@ -214,9 +211,9 @@ Uncheck *Preferences → Cryptomator → Auto detect and open Vault in browser* Save the password in Keychain or Credential Manager to unlock vaults automatically upon connecting. -```{note} +:::{note} Without saving the vaults passwords using keychain, you will receive passwords prompts for the vaults after reconnecting to the server or cloud storage. -``` +::: ## References diff --git a/cyberduck/bookmarks.md b/cyberduck/bookmarks.md index ae8765a0..105f0216 100644 --- a/cyberduck/bookmarks.md +++ b/cyberduck/bookmarks.md @@ -1,25 +1,25 @@ Bookmarks ==== -```{contents} Content +:::{contents} Content :depth: 2 :local: -``` +::: ## Toggle Bookmarks -`````{tabs} -````{group-tab} macOS +::::{tabs} +:::{group-tab} macOS You can toggle between the bookmarks and the browser using *Bookmarks → Toggle Bookmarks (`⌘B`)* or by clicking the bookmarks icon in the navigation toolbar. Depending on the bookmark icon size chosen in *Cyberduck → Preferences → General → Bookmarks*, the nickname, URL, username, and comment are shown per bookmark. -```` -````{group-tab} Windows +::: +:::{group-tab} Windows You can toggle between the bookmarks and the browser using *Bookmarks → Toggle Bookmarks (`Strg+B`)* or by clicking the bookmarks icon in the navigation toolbar. Depending on the bookmark icon size chosen in *Edit → Preferences → General → Bookmarks*, the nickname, URL, username, and comment are shown per bookmark. -```` -````` +::: +:::: ## Sorting @@ -31,63 +31,63 @@ Use the search field *(macOS `⌘/` Windows `Strg+F`)* to filter bookmarks by ni ## Labels & Groups -```{admonition} macOS only +:::{admonition} macOS only :class: tip Only supported in Cyberduck for macOS. -``` +::: ### Edit Labels for Bookmarks Assign multiple labels to a bookmark to group them in folders in the menu. -```{image} _images/Edit_Labels_for_Bookmark.png +:::{image} _images/Edit_Labels_for_Bookmark.png :alt: Edit Labels for Bookmark :width: 500px -``` +::: ### Groups in Bookmarks Menu Bookmarks are grouped in folders in the menu by their assigned labels. Groups in bookmark view forthcoming. -```{image} _images/Groups_in_Bookmarks_Menu.png +:::{image} _images/Groups_in_Bookmarks_Menu.png :alt: Groups in Bookmarks Menu :width: 400px -``` +::: ## Add new Bookmark ### From Current Connection -`````{tabs} -````{group-tab} macOS +:::::{tabs} +::::{group-tab} macOS Select *Bookmarks → Toggle Bookmarks (`⌘B`)*. Click the + button in lower left corner to add the server that's currently connected to this browser window to the Bookmarks. An editor window will open where you can adjust the bookmark properties (i.e. nickname) further. -```{image} _images/Add_Bookmark.png +:::{image} _images/Add_Bookmark.png :alt: Add Bookmark :width: 400px -``` +::: Drag the proxy icon in the browser window title bar to the bookmark drawer or to the *Finder.app*. You can double-click this file in the *Finder.app* to open a new connection. -```{image} _images/Proxy_Icon.png +:::{image} _images/Proxy_Icon.png :alt: Proxy Icon :width: 400px -``` +::: -```` -````{group-tab} Windows +:::: +::::{group-tab} Windows Select *Bookmarks → Toggle Bookmarks (`Strg+B`)*. Click the + button in lower left corner to add the server that's currently connected to this browser window to the Bookmarks. An editor window will open where you can adjust the bookmark properties (i.e. nickname) further. -```{image} _images/Add_Bookmark.png +:::{image} _images/Add_Bookmark.png :alt: Add Bookmark :width: 400px -``` +::: -```` -````` +:::: +::::: ### From a Third-Party Application @@ -97,10 +97,10 @@ Drag an URL from a third-party application to the bookmark table to create a new Select *Bookmark → Edit Bookmark (macOS `⌘E` Windows `Strg+E`)*. A panel where you can edit the bookmark's properties will appear. If the server configured is not reachable, an alert icon is displayed next to the URL. Clicking it opens *Network Diagnostics*. -```{image} _images/WebDAV_Bookmark_Client_Certificate.png +:::{image} _images/WebDAV_Bookmark_Client_Certificate.png :alt: WebDAV Bookmark Client Certificate :width: 600px -``` +::: ### Bookmark Options @@ -121,18 +121,18 @@ Select *Bookmark → Edit Bookmark (macOS `⌘E` Windows `Strg+E`)*. A panel whe ### Passwords -`````{tabs} -````{group-tab} macOS +::::{tabs} +:::{group-tab} macOS Manage your passwords with *Keychain Access.app*. Refer to [Keychain for Mac: Kexchain Access overview](https://support.apple.com/kb/PH20093?locale=en_US). -```` -````{group-tab} Windows +::: +:::{group-tab} Windows Passwords are saved in the *Credential Manager*. You can view and delete your saved login information in *Control Panel → User Accounts → Credential Manager → Windows Credentials*. -```` -````` +::: +:::: ## HTTP URL @@ -148,28 +148,27 @@ Example configuration: | Selected File | `/home/dkocher/public_html/stylsheet.css` | *A file selected in the browser* | | HTTP URL | [http://sudo.ch/stylesheet.css](http://sudo.ch/stylesheet.css) | *Accessible in the web browser* | -```{image} _images/HTTP_URL.png +:::{image} _images/HTTP_URL.png :alt: HTTP URL :width: 600px -``` +::: Web URLs are supported for [FTP](../protocols/ftp.md), [SFTP](../protocols/sftp/index.md) and [WebDAV](../protocols/webdav/index.md). See also [Open or copy HTTP URL](browser.md#open-or-copy-http-url). - ## Exporting Bookmarks Drag the bookmark from the Bookmark Drawer anywhere to the *Finder.app/ Explorer* (e.g. the Desktop). You can double-click the document in the file browser to open a new connection to the server specified in the bookmark. To back up all bookmarks, refer to [this FAQ entry](faq.md#preferences-and-application-support-files-location). -```{image} _images/Drag_Bookmark.png +:::{image} _images/Drag_Bookmark.png :alt: Drag Bookmark :width: 300px -``` +::: -```{note} +:::{note} You can share bookmarks between Mac & Windows as the file format is the same on both platforms. -``` +::: ## Importing Bookmarks @@ -204,22 +203,22 @@ You are asked if you want to import bookmarks from the following list of applica - *Total Commander* - *Cloud Mounter* from `~/Library/Preferences/com.eltima.cloudmounter.plist` -```{image} _images/Filezilla_Import.png +:::{image} _images/Filezilla_Import.png :alt: FileZilla Import :width: 600px -``` +::: ## Sharing Bookmarks Between Different Computers You can share bookmarks between different computers and users by uploading the *Bookmarks* and *Profiles* folder to a Cloud Storage of your liking and creating a symbolic link to it. -```{warning} +:::{warning} This only works properly while using the standalone version of Cyberduck or Mountain Duck. The App Store version is unable to list the existing bookmarks from the symbolic link. -``` +::: **Step by Step Instructions Using Dropbox as an Example:**
-`````{tabs} -````{group-tab} macOS +::::{tabs} +:::{group-tab} macOS 1. Install the Dropbox app, log into your Dropbox account and synchronize the folder where you want to have the bookmarks to the local disk. 2. Quit *Cyberduck* and/or *Mountain Duck*. @@ -227,8 +226,8 @@ This only works properly while using the standalone version of Cyberduck or Moun 4. Open *Terminal.app* and execute the command `ln -s ` to create the symbolic link. e.g.: `ln -s ~/Dropbox/Bookmarks ~/Library/Group\ Containers/G69SCX94XU.duck/Library/Application\ Support/duck/Bookmarks` -```` -````{group-tab} Windows +::: +:::{group-tab} Windows 1. Install the Dropbox app, log into your Dropbox account and synchronize the folder where you want to have the bookmarks to the local disk. 2. Quit *Cyberduck* and/or *Mountain Duck*. @@ -237,8 +236,8 @@ e.g.: `ln -s ~/Dropbox/Bookmarks ~/Library/Group\ Containers/G69SCX94XU.duck/Lib - Open *CMD* and execute the command `mklink /J `. - Open *PowerShell* and execute the command `New-Item -Type Junction -Target -Path ` -```` -````` +::: +:::: ## Preferences @@ -250,10 +249,14 @@ Choose a default bookmark to open after opening the application. Choose *Prefere A [hidden configuration option](preferences.md#hidden-configuration-options). Displayed in the bookmark edit window. - defaults write ch.sudo.cyberduck bookmark.favicon.download false +``` +defaults write ch.sudo.cyberduck bookmark.favicon.download false +``` ### Open Bookmark View after Disconnecting A [hidden configuration option](preferences.md#hidden-configuration-options). - defaults write ch.sudo.cyberduck browser.disconnect.bookmarks.show true +``` +defaults write ch.sudo.cyberduck browser.disconnect.bookmarks.show true +``` \ No newline at end of file diff --git a/cyberduck/browser.md b/cyberduck/browser.md index 0c58c812..5ffe6d3b 100644 --- a/cyberduck/browser.md +++ b/cyberduck/browser.md @@ -1,40 +1,39 @@ Browser ==== -```{contents} Content +:::{contents} Content :depth: 2 :local: -``` +::: ## Navigation ### List and Outline View -`````{tabs} -````{group-tab} macOS +::::{tabs} +:::{group-tab} macOS Select *View → as List (`⌘1`)* or *View → as Outline (`⌘2`)* for expandable folders. You can expand and collapse folders using the right and left arrow keys in the outline view. Navigate into a folder with a double-click *(`⌘↓`)* or one level up by using the ▲ button next to the path-field *(`⌘↑`)*. -```` -````{group-tab} Windows +::: +:::{group-tab} Windows You can expand and collapse folders using the right and left arrow keys in the outline view. Navigate into a folder with a doubl-click *(`Ctrl+Down`)* or one level up by using the ▲ button next to the path-field *(`Ctrl+Up`)*. -```` -````` +::: +:::: ### Tabs -```{admonition} macOS only +:::{admonition} macOS only :class: tip Enable tabs by default when choosing *File → New Browser (`⌘N`)* by selecting in System Preferences the checkbox *Dock → Prefer tabs when opening documents: Always*. New browser windows and the transfer window will then be displayed in a single window frame with a tab bar. You can merge windows with *View → Show Tab Bar and Window → Merge all Windows* - -``` +::: ### Spring-Loaded Folders @@ -44,9 +43,9 @@ Spring-loaded folders are a feature that allows you to move a file or even anoth Use the search field (macOS `⌘/` Windows `Ctrl+F`) to display only files that match the search string in the browser. To search recursively, hit the return key (`⏎`). Only files matching the search or folders with containing files matching the pattern will be displayed in the browser. -```{note} +:::{note} Search is case-insensitive and does look for matching sequences in the filename supporting glob patterns `*` and `?`. -``` +::: The following protocols have a server-side index that is used to give fast results without recursively descending into folders. @@ -56,9 +55,9 @@ The following protocols have a server-side index that is used to give fast resul - [Backblaze B2](../protocols/b2.md) - [Microsoft OneDrive](../protocols/onedrive.md) -```{tip} +:::{tip} You can also search for files by _Version_ where applicable. -``` +::: #### Supported Wildcards @@ -117,25 +116,27 @@ The following protocols support server-sided copying without intermediate downlo You can copy files between arbitrary servers when connected to with two open browser windows. Drag files from one browser to the other to transfer files between servers. -```{image} _images/Copy.png +:::{image} _images/Copy.png :alt: Copy :width: 700px -``` +::: ### Rename a File or Folder Select the file in the browser and press the *Return key*. Type the new name and press *Return* again to exit the editing mode. You can also rename files by choosing *File → Info (macOS `⌘I` Windows `Alt+Return`)* or press the *Get [Info](info.md)* toolbar button. Simply enter the new name in the very top field. The field must lose focus (e.g. by hitting Return or Tab) to commit the filename change. -```{image} _images/Inline_Rename.png +:::{image} _images/Inline_Rename.png :alt: Inline Rename :width: 300px -``` +::: ### Deleting Files and Folders Some protocols support the trashing of files instead of permanently deleting them. This feature is enabled by default. It can be disabled using a [hidden configuration option](preferences.md#hidden-configuration-options). - browser.delete.trash=false +``` +browser.delete.trash=false +``` This is supported for the following protocols: - [Google Drive](../protocols/googledrive.md) @@ -150,17 +151,16 @@ Select the file in the browser and choose *File → Info (macOS `⌘I` Windows ` ### Quick Look -```{admonition} macOS only +:::{admonition} macOS only :class: tip You can toggle Quick Look in a Cyberduck browser for any file using *Space Bar*. A preview is rendered depending on a Quick Look Plugin available on your system for the given file type. Many file types like different image formats can be previewed with the bundled plugins in OS X and HTML is even rendered in the Quick Look preview panel. +::: -``` - -```{image} _images/quicklook.png +:::{image} _images/quicklook.png :alt: Quicklook :width: 500px -``` +::: ### Open or Copy HTTP URL @@ -185,22 +185,22 @@ Use the *File → Print* option where you can open a PDF from the browser listin Folder icons are badged for particular access permissions. -```{image} _images/privatefolderbadge.png +:::{image} _images/privatefolderbadge.png :alt: Private Folder Badge :width: 50px -``` +::: Folder with no permission to access. -```{image} _images/readonlyfolderbadge.png +:::{image} _images/readonlyfolderbadge.png :alt: Read Only Folder Badge :width: 50px -``` +::: Folder with read-only permissions. Uploading or editing files to this folder is not possible. -```{image} _images/dropfolderbadge.png +:::{image} _images/dropfolderbadge.png :alt: Drop folder Badge :width: 50px -``` +::: Drop Folder where you can only upload files to but are not allowed to view its content. ### Versions @@ -215,10 +215,10 @@ To revert to a previous version and make it the current, choose *File → Revert Use *Window → Activity (macOS `⌘0` Windows `Ctrl+0`)* to toggle the activity window. It lists the currently running background tasks at the top and all queued activities subsequently. -```{image} _images/Activity.png +:::{image} _images/Activity.png :alt: Activity :width: 500px -``` +::: ## Problems @@ -242,17 +242,17 @@ Open new browser window after application launch. ### Browser → General -### Browser → General → Show Hidden Files +#### Browser → General → Show Hidden Files Display files in the browser that start with `.` and [previous revisions (S3)](../protocols/s3/index.md#versions). Use *View → Show Hidden Files* to toggle the mode of a current browser window. -### Browser → General → Double click opens file in external editor +#### Browser → General → Double click opens file in external editor Open files in a external editor by double-clicking -### Browser → General → Return key selects folder or file to rename +#### Browser → General → Return key selects folder or file to rename Use ⏎ key to select a file or folder for renaming -### Browser → General → Info window always shows current selection +#### Browser → General → Info window always shows current selection Use only one *Info* window which updates with the selection change in the browser. If unchecked, open multiple Info windows to compare files. @@ -262,13 +262,17 @@ Use only one *Info* window which updates with the selection change in the browse A [hidden configuration option](preferences.md#hidden-configuration-options). - defaults write ch.sudo.cyberduck browser.font.size 18 +``` +defaults write ch.sudo.cyberduck browser.font.size 18 +``` ### Duplicate Filename Format A [hidden configuration option](preferences.md#hidden-configuration-options). Define a different format using - defaults write ch.sudo.cyberduck browser.duplicate.format "{0} ({1}){2}" +``` +defaults write ch.sudo.cyberduck browser.duplicate.format "{0} ({1}){2}" +``` where the plaseholders will be replaced with @@ -280,30 +284,38 @@ where the plaseholders will be replaced with A [hidden configuration option](preferences.md#hidden-configuration-options). A confirmation is shown before renaming or moving files. - defaults write ch.sudo.cyberduck browser.move.confirm true +``` +defaults write ch.sudo.cyberduck browser.move.confirm true +``` ### Re-Enable File Listing Limit Prompt A [hidden configuration option](preferences.md#hidden-configuration-options) can re-enable the file listing limit prompt after dismissing it with enabled *Always* checkbox. -````{tabs} - -```{group-tab} macOS +::::{tabs} +:::{group-tab} macOS Open *Terminal.app* and execute the command - defaults delete ch.sudo.cyberduck browser.list.limit.directory +``` +defaults delete ch.sudo.cyberduck browser.list.limit.directory +``` + and the command - defaults delete ch.sudo.cyberduck browser.list.limit.container +``` +defaults delete ch.sudo.cyberduck browser.list.limit.container ``` -```{group-tab} Windows +::: +:::{group-tab} Windows Navigate to `%AppData%\Cyberduck` and search within the existing `Cyberduck.exe_Url_` folders after the folder that is named after your currently used Cyberduck version. Open the file *user.config* that is located within that folder and delete the lines -