From 791b7c0a087d5c85f93ceb2dc25ea31c70eba539 Mon Sep 17 00:00:00 2001 From: tatze96 Date: Fri, 16 Aug 2024 13:18:37 +0200 Subject: [PATCH] Resolved formatting errors; corrected wiki reference on minio page --- Formatting_Cheat-Sheet.md | 46 ++++++++++++++++++----------------- cli/index.md | 32 ++++++++++++------------ cyberduck/support.md | 2 +- mountainduck/connect/sync.md | 10 ++++---- protocols/dropbox.md | 4 +-- protocols/index.md | 38 ++++++++++++++--------------- protocols/openstack/clouda.md | 4 +-- protocols/profiles/index.md | 24 +++++++++--------- protocols/s3/minio.md | 2 +- protocols/s3/polycloud.md | 4 +-- protocols/sftp/index.md | 12 ++++----- protocols/smb.md | 20 +++++++-------- protocols/webdav/kdrive.md | 8 +++--- 13 files changed, 104 insertions(+), 102 deletions(-) diff --git a/Formatting_Cheat-Sheet.md b/Formatting_Cheat-Sheet.md index 03abe549..ee8f4f14 100644 --- a/Formatting_Cheat-Sheet.md +++ b/Formatting_Cheat-Sheet.md @@ -17,6 +17,8 @@ Add an empty line... Don't add an empty line around admonitions within lists +Indent codeblocks within numbered lists, as the numbers aren't rendered correctly otherwise. + ## Footnotes - This is a manually-numbered footnote reference.[^3] @@ -75,47 +77,47 @@ test ## Admonitions -```{note} +:::{note} Here is a note! -``` +::: -```{warning} +:::{warning} Here is a warning! -``` +::: -```{tip} +:::{tip} Here is a tip! -``` +::: -```{caution} +:::{caution} Caution! -``` +::: -```{attention} +:::{attention} Attention! -``` +::: -```{danger} +:::{danger} Here is a danger! -``` +::: -```{error} +:::{error} Here is an error! -``` +::: -```{hint} +:::{hint} Here is a hint! -``` +::: -```{important} +:::{important} This is important! -``` +::: -```{seealso} +:::{seealso} See also here! -``` +::: -```{admonition} Custom +:::{admonition} Custom :class: tip Custom content -``` \ No newline at end of file +::: \ No newline at end of file diff --git a/cli/index.md b/cli/index.md index 278c386c..87ca8c69 100644 --- a/cli/index.md +++ b/cli/index.md @@ -112,26 +112,26 @@ To install *Cyberduck CLI* use **DEB Package Repository** 1. Add the nightly or stable `duck` repository to your `/etc/apt/sources.list` manually: -``` -deb https://s3.amazonaws.com/repo.deb.cyberduck.io nightly main -deb https://s3.amazonaws.com/repo.deb.cyberduck.io stable main -``` + ``` + deb https://s3.amazonaws.com/repo.deb.cyberduck.io nightly main + deb https://s3.amazonaws.com/repo.deb.cyberduck.io stable main + ``` or using -``` -echo -e "deb https://s3.amazonaws.com/repo.deb.cyberduck.io stable main" | sudo tee /etc/apt/sources.list.d/cyberduck.list > /dev/null -``` + ``` + 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: -``` -sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys FE7097963FEFBE72 -``` + ``` + sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys FE7097963FEFBE72 + ``` 3. Synchronize the repository using -``` -sudo apt-get update -``` + ``` + sudo apt-get update + ``` 4. To install or upgrade *Cyberduck CLI* use -``` -sudo apt-get install duck -``` + ``` + sudo apt-get install duck + ``` :::{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`. diff --git a/cyberduck/support.md b/cyberduck/support.md index 944d13b3..ccce6460 100644 --- a/cyberduck/support.md +++ b/cyberduck/support.md @@ -35,7 +35,7 @@ Log output can be found in the `cyberduck.log` file in`~/Library/Logs/Cyberduck` :width: 600px ::: -### Transcript +**Transcript** You can access the transcript which will log protocol request and responses from the command line particularly useful for protocols using HTTP. Open a *Terminal.app* window and enter diff --git a/mountainduck/connect/sync.md b/mountainduck/connect/sync.md index 5f6a5ff8..0d620e6f 100644 --- a/mountainduck/connect/sync.md +++ b/mountainduck/connect/sync.md @@ -201,23 +201,23 @@ The *Recent Files* area shows the last 20 changes to files by you or on the serv :width: 600px ::: -#### ![Delete](../_images/delete.png) Delete +### ![Delete](../_images/delete.png) Delete A file or folder has been deleted either *by you* or *on the server* -#### ![Create](../_images/plus.png) Create +### ![Create](../_images/plus.png) Create A file or folder was created or updated *on the server*. -#### ![Upload](../_images/transfer_upload.png) Upload +### ![Upload](../_images/transfer_upload.png) Upload A file or folder was added or changed *by you* and uploaded to the server. -#### ![Download](../_images/transfer_download.png) Download +### ![Download](../_images/transfer_download.png) Download A file is downloaded to the local cache to be available for offline use. This state also occurs if a file that is marked as *Keep offline* has updated on the server. -#### ![Error](../_images/alert.png) Error +### ![Error](../_images/alert.png) Error The sync operation failed for the file. A file may show up with an error state indicating an issue while synchronizing. Further details are available through the [sync option menu item](../interface.md#context-menu-in-finder-and-windows-file-explorer). diff --git a/protocols/dropbox.md b/protocols/dropbox.md index 6075a2a6..b4d924b9 100644 --- a/protocols/dropbox.md +++ b/protocols/dropbox.md @@ -16,11 +16,11 @@ Access your [Dropbox](https://db.tt/49NiK95I) without syncing to your computer. ![Dropbox Link](_images/Dropbox_Link.png) -3. Log in to Dropbox and grant permissions to *Cyberduck*. +2. Log in to Dropbox and grant permissions to *Cyberduck*. ![Dropbox Permissions](_images/Dropbox_Permissions.png) -4. The authorization code will be submitted to Cyberduck automatically. +3. The authorization code will be submitted to Cyberduck automatically. :::{admonition} Multiple Accounts :class: tip diff --git a/protocols/index.md b/protocols/index.md index d0ece2a5..59dd7359 100644 --- a/protocols/index.md +++ b/protocols/index.md @@ -29,83 +29,83 @@ spectra 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). -### [FTP](ftp.md) +## [FTP](ftp.md) With support for secure TLS connections and custom origin [Amazon CloudFront (Content Delivery Network) distribution](../protocols/cdn/cloudfront) option. -### [Amazon S3](s3/index.md) +## [Amazon S3](s3/index.md) Transfer files to your S3 account and browse the S3 buckets and files in a hierarchical way. Supports Amazon Web Services (AWS) and many third party providers. - [S3 providers](s3/index.md#third-party-providers) -### [Google Cloud Storage](googlecloudstorage.md) +## [Google Cloud Storage](googlecloudstorage.md) Transfer files to your Google Storage account and browse files, manage ACLs and bucket configurations. -### [Backblaze B2](b2.md) +## [Backblaze B2](b2.md) Backblaze B2 Cloud Storage is ΒΌ of the price of Amazon S3 -### [WebDAV](webdav/index.md) +## [WebDAV](webdav/index.md) Connect to any WebDAV compliant server using both HTTP and HTTP/SSL and custom origin [Amazon CloudFront (Content Delivery Network) distribution](cdn/cloudfront.md) option. - [WebDAV providers](webdav/index.md#providers) -### [SSH/SFTP](sftp/index.md) +## [SSH/SFTP](sftp/index.md) Advanced configuration for SSH connections using public key authentication and custom origin [Amazon CloudFront (Content Delivery Network) distribution](cdn/cloudfront.md) option. -### [SMB](smb.md) +## [SMB](smb.md) SMB (Server Message Block) is used to access Windows File Shares. -### [OpenStack Object Storage](openstack/index.md) +## [OpenStack Object Storage](openstack/index.md) Connect to cloud storage providers using OpenStack Swift for the storage protocol. Includes support for [Rackspace Cloud Files](openstack/cloudfiles). - [OpenStack Providers](openstack/index.md#third-party-providers) -### [Windows Azure](azure.md) +## [Windows Azure](azure.md) Massively scalable object storage for unstructured data. -### [Microsoft OneDrive](onedrive.md) +## [Microsoft OneDrive](onedrive.md) Access OneDrive without syncing to your computer. -### [Microsoft SharePoint](sharepoint.md) +## [Microsoft SharePoint](sharepoint.md) Connect to SharePoint Server and SharePoint Online. -### [Google Drive](googledrive.md) +## [Google Drive](googledrive.md) Access all your documents and upload files of any type to use your Google Drive account for storage. -### [Box](box.md) +## [Box](box.md) Simple, secure file sharing and collaboration from anywhere. -### [Dropbox](dropbox.md) +## [Dropbox](dropbox.md) Access Dropbox without syncing to your computer. -### [DRACOON](dracoon.md) +## [DRACOON](dracoon.md) A highly secure, platform-independent enterprise filesharing solution -### [Files.com](files.com.md) +## [Files.com](files.com.md) Files.com is Smart Cloud Storage for modern teams -### [iRODS](irods.md) +## [iRODS](irods.md) The Integrated Rule-Oriented Data System (iRODS) is an open source data management software used by research organizations and government agencies worldwide. -### [Spectra BlackPearl Deep Storage Gateway](spectra.md) +## [Spectra BlackPearl Deep Storage Gateway](spectra.md) -### Local Disk +## Local Disk Open a window to browse your local hard disk to drag files for download or upload to a remote server from within the application. You can browse [Cryptomator Vaults](../cryptomator/index.md#access-vaults-on-local-disk) stored on your computer. :::{warning} diff --git a/protocols/openstack/clouda.md b/protocols/openstack/clouda.md index b7a9a639..51ed8dc1 100644 --- a/protocols/openstack/clouda.md +++ b/protocols/openstack/clouda.md @@ -1,10 +1,10 @@ Cloud A ==== -```{image} _images/cropped-cloudA_transparent_temp_oldsite1.png +:::{image} _images/cropped-cloudA_transparent_temp_oldsite1.png :alt: Cloud A Logo :height: 128px -``` +::: > [Cloud-A](https://www.clouda.ca/cloud-infrastructure#cloud_servers) is a leading provider of public cloud Infrastructure based in Canada. Our products automate & simplify the installation and management of the hardware and software that provides the infrastructure for large-scale environments having hundreds or thousands of servers supporting high-performance compute applications. diff --git a/protocols/profiles/index.md b/protocols/profiles/index.md index d7b29b69..eee4292f 100644 --- a/protocols/profiles/index.md +++ b/protocols/profiles/index.md @@ -154,18 +154,18 @@ All additional schemes are registered as a scheme handler when opening [Mountain Create a *multi-TIFF* containing the needed icon sizes: 1. Create a high-resolution *.png* file based on the PSD template 2. Use the following script to generate the different resolutions and the multi-TIFF *disk.tiff* file: -``` -png=[LOCATION_OF_HIGH_RESOLUTION_PNG] -tmp=$TMPDIR -target=[TARGET_FOLDER] -/usr/bin/sips -s format png -z 128 128 -s dpiHeight 144.0 -s dpiWidth 144.0 ${png} --out ${tmp}/icon_64x64@2x.png -/usr/bin/sips -s format png -z 64 64 -s dpiHeight 72.0 -s dpiWidth 72.0 ${png} --out ${tmp}/icon_64x64.png -/usr/bin/sips -s format png -z 96 96 -s dpiHeight 144.0 -s dpiWidth 144.0 ${png} --out ${tmp}/icon_96@2x.png -/usr/bin/sips -s format png -z 48 48 -s dpiHeight 72.0 -s dpiWidth 72.0 ${png} --out ${tmp}/icon_96.png -/usr/bin/sips -s format png -z 256 256 -s dpiHeight 144.0 -s dpiWidth 144.0 ${png} --out ${tmp}/icon_256@2x.png -/usr/bin/sips -s format png -z 128 128 -s dpiHeight 72.0 -s dpiWidth 72.0 ${png} --out ${tmp}/icon_256.png -/usr/bin/tiffutil -cathidpicheck ${tmp}/icon_64x64@2x.png ${tmp}/icon_64x64.png ${tmp}/icon_96.png ${tmp}/icon_96@2x.png ${tmp}/icon_256.png ${tmp}/icon_256@2x.png -out ${target}/disk.tiff -``` + ``` + png=[LOCATION_OF_HIGH_RESOLUTION_PNG] + tmp=$TMPDIR + target=[TARGET_FOLDER] + /usr/bin/sips -s format png -z 128 128 -s dpiHeight 144.0 -s dpiWidth 144.0 ${png} --out ${tmp}/icon_64x64@2x.png + /usr/bin/sips -s format png -z 64 64 -s dpiHeight 72.0 -s dpiWidth 72.0 ${png} --out ${tmp}/icon_64x64.png + /usr/bin/sips -s format png -z 96 96 -s dpiHeight 144.0 -s dpiWidth 144.0 ${png} --out ${tmp}/icon_96@2x.png + /usr/bin/sips -s format png -z 48 48 -s dpiHeight 72.0 -s dpiWidth 72.0 ${png} --out ${tmp}/icon_96.png + /usr/bin/sips -s format png -z 256 256 -s dpiHeight 144.0 -s dpiWidth 144.0 ${png} --out ${tmp}/icon_256@2x.png + /usr/bin/sips -s format png -z 128 128 -s dpiHeight 72.0 -s dpiWidth 72.0 ${png} --out ${tmp}/icon_256.png + /usr/bin/tiffutil -cathidpicheck ${tmp}/icon_64x64@2x.png ${tmp}/icon_64x64.png ${tmp}/icon_96.png ${tmp}/icon_96@2x.png ${tmp}/icon_256.png ${tmp}/icon_256@2x.png -out ${target}/ disk.tiff + ``` 3. Use the command ``` base64 ./disk.tiff -b 70 ``` to generate the base64 version of the multi-TIFF file. This final version will be used for the connection profile. ## Sample Connection Profiles diff --git a/protocols/s3/minio.md b/protocols/s3/minio.md index 1dbdf95f..a5da7b6a 100644 --- a/protocols/s3/minio.md +++ b/protocols/s3/minio.md @@ -14,4 +14,4 @@ Download and install the [generic S3 profile](index.md#generic-s3-profiles). ### Virtual Host Style Requests -Make sure to enable [virtual-host-style requests](https://github.com/minio/minio/tree/master/docs/config#domain) in your MinIO configuration. Alternatively, refer to [Disable use of Virtual Host Style Requests](index.md#disable-use-of-virtual-host-style-requests). +Make sure to enable [virtual-host-style requests](https://github.com/minio/minio/tree/master/docs/config#domain) in your MinIO configuration. Alternatively, refer to [Connecting using Deprecated Path Style Requests](index.md#connecting-using-deprecated-path-style-requests). diff --git a/protocols/s3/polycloud.md b/protocols/s3/polycloud.md index fdae4039..ffc75f4a 100644 --- a/protocols/s3/polycloud.md +++ b/protocols/s3/polycloud.md @@ -19,9 +19,9 @@ Double-click on the downloaded file to activate the connection profile. Enter th 3. Select *Generate* to confirm that you want to generate an access key. 4. A window will show up containing the key information (Access Key ID, Secret Access Key) -```{note} +:::{note} The key information will only be shown once and can't be recovered. If you do lose them you can generate new keys, but you will then need to update all of your 3rd party applications with the new credentials. -``` +::: ## References diff --git a/protocols/sftp/index.md b/protocols/sftp/index.md index b4870b60..ae720423 100644 --- a/protocols/sftp/index.md +++ b/protocols/sftp/index.md @@ -108,13 +108,13 @@ OpenSSH private keys of type `rsa`, `dsa`, `ecdsa` and `ed25519` (in OpenSSL `PE #### Configure Public Key Authentication 1. Run the command `ssh-keygen` from the Terminal.app (macOS) or console (Windows) to generate a public/private pair of keys. They will be put in your directory `~/.ssh`, though you will probably be asked to approve or change this location. When you generate the keys you will be asked for a 'passphrase'. If you use a *passphrase* then you will have to enter it each time you use the keys for authentication. That is, you will have to type in the passphrase every time you log in, just as you would with a password. If you don't enter a passphrase (just press the return key) then you will be allowed to log in without having to enter a passphrase. This can be more convenient, but it is less secure. -``` -ssh-keygen -m PEM -t rsa -``` + ``` + ssh-keygen -m PEM -t rsa + ``` 2. Copy the public key to the remote host you wish to access and add it to the file `authorized_keys` in your `~/.ssh` directory. (If that file does not exist then you should create it.) Anybody listed in the authorized_keys file (via their public key) is allowed to log-in, provided that they can prove that they possess the corresponding private key. Thus, if you have the private key in your .ssh directory on your home machine you'll be allowed in. -``` -ssh hostname < ~/.ssh/id_rsa.pub 'cat >> .ssh/authorized_keys' -``` + ``` + ssh hostname < ~/.ssh/id_rsa.pub 'cat >> .ssh/authorized_keys' + ``` 3. In the Connection Dialog or the Bookmark editor in Cyberduck select *Use Public Key Authentication* and select the private key in your `.ssh` directory. ##### OpenSSH User Certificate Authentication diff --git a/protocols/smb.md b/protocols/smb.md index dc0487db..33631e66 100644 --- a/protocols/smb.md +++ b/protocols/smb.md @@ -1,31 +1,31 @@ SMB ==== -```{image} _images/ftp.png +:::{image} _images/ftp.png :alt: FTP Drive Icon :width: 128px -``` +::: -```{contents} Content +:::{contents} Content :depth: 2 :local: -``` +::: > [SMB (Server Message Block)](https://en.wikipedia.org/wiki/Server_Message_Block) is used to access Windows File Shares or a Samba Linux Server. ## Connecting -```{important} +:::{important} * Cyberduck [8.7.0](https://cyberduck.io/changelog/) or later required * Mountain Duck [5.0.0](https://mountainduck.io/changelog/) or later required -``` +::: To connect to a SMB server, choose _SMB (Server Message Block)_. -```{image} _images/SMB_Connection.png +:::{image} _images/SMB_Connection.png :alt: SMB Connection :width: 700px -``` +::: ### Authentication @@ -37,10 +37,10 @@ Username and password must be provided for authentication using NTLM. The option To connect to a specific share, you can configure a _Path_ in the bookmark. When omitted an attempt is made to list all available shares from the server. On failure retrieving share names from the server, a prompt is displayed to enter the share name when connecting. -```{image} _images/SMB_Share.png +:::{image} _images/SMB_Share.png :alt: SMB Share Input :width: 700px -``` +::: ### Interoperability diff --git a/protocols/webdav/kdrive.md b/protocols/webdav/kdrive.md index 164c6b28..02cd5d64 100644 --- a/protocols/webdav/kdrive.md +++ b/protocols/webdav/kdrive.md @@ -3,7 +3,7 @@ Infomaniak kDrive > kDrive is an online platform which enables you to retain a copy of your files and share them with employees. -### Connecting +## Connecting Enter the following information in the [bookmark](../../cyberduck/bookmarks.md): @@ -14,12 +14,12 @@ Enter the following information in the [bookmark](../../cyberduck/bookmarks.md): - If two-step authentication is not activated, use the password for your Infomaniak account - If two-step authentication is activated, generate an [application password](https://manager.infomaniak.com/v3/profile/application-password) -### Known Issues +## Known Issues -#### Can't Upload Files (Mountain Duck) +### Can't Upload Files (Mountain Duck) kDrive doesn't accept uploads with unknown file sizes. Because of this files can't be uploaded within the *Online* mode as the actual file size can't be reported at the beginning of the upload. The *Smart Synchronization* mode can be used instead as a workaround. -### References +## References - [kDrive: logging in to your Drive via WebDAV](https://www.infomaniak.com/en/support/faq/2409/kdrive-logging-in-to-your-drive-via-webdav)