diff --git a/Formatting_Cheat-Sheet.md b/Formatting_Cheat-Sheet.md deleted file mode 100644 index ee8f4f14..00000000 --- a/Formatting_Cheat-Sheet.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -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 - -Indent codeblocks within numbered lists, as the numbers aren't rendered correctly otherwise. - -## Footnotes - -- This is a manually-numbered footnote reference.[^3] -- This is an auto-numbered footnote reference.[^myref] - -[^myref]: This is an auto-numbered footnote definition. -[^3]: This is a manually-numbered footnote definition. - -A longer footnote definition.[^mylongdef] - -[^mylongdef]: This is the _**footnote definition**_. - - That continues for all indented lines - - - even other block elements - - Plus any preceding unindented lines, -that are not separated by a blank line - ---- - -## Tabs - -::::{tabs} -:::{group-tab} macOS - -test - -::: -:::{group-tab} Windows - -test - -::: -:::: - ---- - -## Quotes and Codeblocks - - This is a codeblock - -`this is code` - -> this is a single line Quote - -## Links und Downloadlinks - -[Formatting Cheat Sheet](Formatting_Cheat-Sheet) - -``` -{download}`Title` -``` - ---- - -## Admonitions - -:::{note} -Here is a note! -::: - -:::{warning} -Here is a warning! -::: - -:::{tip} -Here is a tip! -::: - -:::{caution} -Caution! -::: - -:::{attention} -Attention! -::: - -:::{danger} -Here is a danger! -::: - -:::{error} -Here is an error! -::: - -:::{hint} -Here is a hint! -::: - -:::{important} -This is important! -::: - -:::{seealso} -See also here! -::: - -:::{admonition} Custom -:class: tip -Custom content -::: \ No newline at end of file diff --git a/README.md b/README.md index 53fe1e4c..abc5dc37 100644 --- a/README.md +++ b/README.md @@ -25,3 +25,114 @@ Output can be found in `_build/html`. ## Contributions Contributions to this documentation are welcome. Please open a pull request. + +--- + +## 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 + +Indent codeblocks and admonitions within numbered lists, as the numbers aren't rendered correctly otherwise. + +### Footnotes + +- This is a manually-numbered footnote reference.[^3] +- This is an auto-numbered footnote reference.[^myref] + +[^myref]: This is an auto-numbered footnote definition. +[^3]: This is a manually-numbered footnote definition. + +A longer footnote definition.[^mylongdef] + +[^mylongdef]: This is the _**footnote definition**_. + + That continues for all indented lines + + - even other block elements + + Plus any preceding unindented lines, +that are not separated by a blank line + +### Tabs +Group tabs allow to select a tab for the whole page. As an example: If a page contains three group tabs with macOS and Windows as options and you select macOS for one section then all the sections on the page will switch to macOS. + +``` +::::{tabs} +:::{group-tab} macOS + +text + +::: +:::{group-tab} Windows + +text + +::: +:::: +``` + +Regular tabs are limited to the section and doesn't affect any other tabs on the page. + +``` +::::{tabs} +:::{tab} Text 1 + +text + +::: +:::{tab} Text 2 + +text + +::: +``` + +### Quotes and Code + +```` +``` +This is a codeblock +``` +```` + +`this is in line code` + +``` +> this is a single line Quote +``` + +### Links und Downloadlinks +Add those inline into the text where needed. + +``` +[Formatting Cheat Sheet](Formatting_Cheat-Sheet) +``` + +``` +{download}`Title` +``` + +### Admonitions +Admonitions are boxes with a colored background that highlight information. Available admonition types are: note, warning, tip, caution, attention, danger, error, hint, important, and seealso + +``` +:::{} +text +::: +``` + +Admonitions can also be used with custom titles by using the format below. + +``` +:::{admonition} Custom Title +:class: tip + +text +::: +``` \ No newline at end of file diff --git a/cli/index.md b/cli/index.md index cae06a67..bc2e1d43 100644 --- a/cli/index.md +++ b/cli/index.md @@ -430,21 +430,21 @@ The support directory is `~/.duck/` on Linux. You can install third party [profi You can override default [preferences](../cyberduck/preferences.md#hidden-configuration-options) by setting environment variables in your shell. -`env "property.name=value" duck` +`env "=" duck` ::: :::{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` +`set "=" & duck` ::: :::{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` +`env "=" duck` ::: :::: diff --git a/cyberduck/bookmarks.md b/cyberduck/bookmarks.md index 105f0216..74f4b5ae 100644 --- a/cyberduck/bookmarks.md +++ b/cyberduck/bookmarks.md @@ -247,16 +247,16 @@ Choose a default bookmark to open after opening the application. Choose *Prefere ### Do not Read favicon.ico from HTTP URL -A [hidden configuration option](preferences.md#hidden-configuration-options). Displayed in the bookmark edit window. +A [hidden configuration option](../tutorials/hidden_properties.md). Displayed in the bookmark edit window. ``` -defaults write ch.sudo.cyberduck bookmark.favicon.download false +bookmark.favicon.download=false ``` ### Open Bookmark View after Disconnecting -A [hidden configuration option](preferences.md#hidden-configuration-options). +A [hidden configuration option](../tutorials/hidden_properties.md). ``` -defaults write ch.sudo.cyberduck browser.disconnect.bookmarks.show true +browser.disconnect.bookmarks.show=true ``` \ No newline at end of file diff --git a/cyberduck/browser.md b/cyberduck/browser.md index 5ffe6d3b..29c049ec 100644 --- a/cyberduck/browser.md +++ b/cyberduck/browser.md @@ -132,7 +132,7 @@ Select the file in the browser and press the *Return key*. Type the new name and ### 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). +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](../tutorials/hidden_properties.md). ``` browser.delete.trash=false @@ -151,17 +151,18 @@ 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 :alt: Quicklook :width: 500px ::: +:::: + ### Open or Copy HTTP URL See bookmark [Web URL configuration](bookmarks.md#http-url) for HTTP URLs. You can select multiple files to open/copy all URLs. @@ -260,18 +261,18 @@ Use only one *Info* window which updates with the selection change in the browse ### Adjust the Browser Font Size -A [hidden configuration option](preferences.md#hidden-configuration-options). +A [hidden configuration option](../tutorials/hidden_properties.md). ``` -defaults write ch.sudo.cyberduck browser.font.size 18 +browser.font.size=18 ``` ### Duplicate Filename Format -A [hidden configuration option](preferences.md#hidden-configuration-options). Define a different format using +A [hidden configuration option](../tutorials/hidden_properties.md). Define a different format using ``` -defaults write ch.sudo.cyberduck browser.duplicate.format "{0} ({1}){2}" +browser.duplicate.format="{0} ({1}){2}" ``` where the plaseholders will be replaced with @@ -282,15 +283,15 @@ where the plaseholders will be replaced with ### Warning Before Renaming or Moving Files -A [hidden configuration option](preferences.md#hidden-configuration-options). A confirmation is shown before renaming or moving files. +A [hidden configuration option](../tutorials/hidden_properties.md). A confirmation is shown before renaming or moving files. ``` -defaults write ch.sudo.cyberduck browser.move.confirm true +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. +A [hidden configuration option](../tutorials/hidden_properties.md) can re-enable the file listing limit prompt after dismissing it with enabled *Always* checkbox. ::::{tabs} :::{group-tab} macOS diff --git a/cyberduck/connection.md b/cyberduck/connection.md index 5346a466..92e43cde 100644 --- a/cyberduck/connection.md +++ b/cyberduck/connection.md @@ -201,26 +201,26 @@ Choose *Cyberduck → Preferences → Connection → Use system proxy settings*. #### Prefer IPv6 Addresses of DNS Lookups -A [hidden configuration option](preferences.md#hidden-configuration-options). +A [hidden configuration option](../tutorials/hidden_properties.md). ``` -defaults write ch.sudo.cyberduck connection.dns.ipv6 true +connection.dns.ipv6=true ``` #### Disable Bonjour Support -A [hidden configuration option](preferences.md#hidden-configuration-options). +A [hidden configuration option](../tutorials/hidden_properties.md). ``` -defaults write ch.sudo.cyberduck rendezvous.enable false +rendezvous.enable=false ``` #### Disable Bonjour Notifications in Notification Center and System Tray -A [hidden configuration option](preferences.md#hidden-configuration-options). By default, the limit is set to allow not more than `30` notifications per minute. +A [hidden configuration option](../tutorials/hidden_properties.md). By default, the limit is set to allow not more than `30` notifications per minute. ``` -defaults write ch.sudo.cyberduck rendezvous.notification.limit 0 +rendezvous.notification.limit=0 ``` ## Default Protocol Handler diff --git a/cyberduck/download.md b/cyberduck/download.md index 5d6f938b..ca3eb417 100644 --- a/cyberduck/download.md +++ b/cyberduck/download.md @@ -55,10 +55,10 @@ Downloaded files have added metadata of its origin URL. *Finder.app* displays th Downloaded files are flagged with the `com.apple.quarantine` attribute. The attributes associate basic information with the file, such as its type, when it was received, and the URL from which it came. When the Finder or any other program uses Launch Services to open a quarantined file, Launch Services inspects the file to see if it appears to be an application, script, or other executable file types. If so, the system displays an alert informing the user that the file is an application and asking for confirmation that it should be executed. The alert lets the user open the URL from which the file was downloaded, launch the program, or cancel. If the user proceeds to open the file, Launch Services removes the quarantine attributes from that file. -A [hidden configuration option](preferences.md#hidden-configuration-options). +A [hidden configuration option](../tutorials/hidden_properties.md). ``` -defaults write ch.sudo.cyberduck queue.download.quarantine false +queue.download.quarantine=false ``` Files downloaded to edit do not have a quarantine flag set by default. @@ -66,8 +66,8 @@ Files downloaded to edit do not have a quarantine flag set by default. ### Temporary Document Icon -Don't change the document icon while downloading. A [hidden configuration option](preferences.md#hidden-configuration-options). +Don't change the document icon while downloading. A [hidden configuration option](../tutorials/hidden_properties.md). ``` -defaults write ch.sudo.cyberduck queue.download.icon.update false +queue.download.icon.update=false ``` \ No newline at end of file diff --git a/cyberduck/edit.md b/cyberduck/edit.md index c6c9fc3d..1b5cb3ee 100644 --- a/cyberduck/edit.md +++ b/cyberduck/edit.md @@ -11,17 +11,18 @@ The default editor opened for a file is selected depending on the file type. If :width: 700px ::: -:::{admonition} macOS only -:class: tip +::::{tabs} +:::{group-tab} macOS To edit file type associations choose *File → Info* for a given file type in the *Finder.app*. -::: -:::{admonition} Windows only -:class: tip +::: +:::{group-tab} Windows To edit file type associations choose *Properties → General → Type of file → Change…* for a given file type in Windows Explorer. + ::: +:::: ## Preferences @@ -45,15 +46,15 @@ Enable the custom versioning option in *Preferences → Editor* to store previou ### Disable Upload of Temporary File on Save -A [hidden configuration option](preferences.md#hidden-configuration-options). +A [hidden configuration option](../tutorials/hidden_properties.md). ``` -defaults write ch.sudo.cyberduck editor.upload.temporary false +editor.upload.temporary=false ``` ### Exclude Files from Versioning -Files can be excluded from versioning by using a [hidden configuration option](preferences.md#hidden-configuration-options). +Files can be excluded from versioning by using a [hidden configuration option](../tutorials/hidden_properties.md). ``` versioning.include.regex=.* @@ -63,7 +64,7 @@ versioning.include.regex=.* Per default, the number of saved versions is limited to 5. The oldest version will be deleted once a new version is uploaded exceeding the limit. -The number of saved versions can be customized by using a [hidden configuration option](preferences.md#hidden-configuration-options). +The number of saved versions can be customized by using a [hidden configuration option](../tutorials/hidden_properties.md). ``` versioning.limit=5 diff --git a/cyberduck/faq.md b/cyberduck/faq.md index a5b8e66e..b41cd6e9 100644 --- a/cyberduck/faq.md +++ b/cyberduck/faq.md @@ -80,7 +80,7 @@ Registration keys can be [recovered](https://cyberduck.io/help#recover) using th ### The Registration Key Received Cannot be Opened -The registration key is sent to you by email automatically after the Paypal transaction has been completed. Make sure the filename of the registration key ends with `.cyberducklicense`. Some email applications change the extension to `.xml` when saving the attachment. If the key is invalid, the file must have been modified when saving it from your email application. Try the following: +The registration key is sent to you by email automatically after the transaction has been completed. Make sure the filename of the registration key ends with `.cyberducklicense`. Some email applications change the extension to `.xml` when saving the attachment. If the key is invalid, the file must have been modified when saving it from your email application. Try the following: - If you are using a webmail provider, try using a different browser or email client application to access your mail. - Contact you hosting service provider how to download attachments. diff --git a/cyberduck/preferences.md b/cyberduck/preferences.md index d5a848ba..6956023b 100644 --- a/cyberduck/preferences.md +++ b/cyberduck/preferences.md @@ -100,34 +100,13 @@ Beta builds are published before a release and include the latest features and h ## Hidden Configuration Options -There are some settings which aren't yet available in the *Preferences* either because they are not considered stable yet or not of general interest. Follow these steps to enable a hidden preference referenced in the wiki: - ::::{tabs} -:::{group-tab} macOS - -Type the `defaults` command given in a *Terminal.app* (in `/Applications/Utilities`) window and restart Cyberduck. - - defaults write ~/Library/Preferences/ch.sudo.cyberduck.plist - -Alternatively you can create a file `default.properties` in the [application support folder](faq.md#preferences-and-application-support-files-location). Add the setting as follows: - -`...`
-`=`
-`...` - -::: -:::{group-tab} Windows - -If not existing yet you need to create the file [%AppData%](faq.md#preferences-and-application-support-files-location)`\Cyberduck\default.properties`. To do that create a new text file within `%AppData%\Cyberduck` and replace the preconfigured name including the file extension by *default.properties*. - -Add the setting as follows: +:::{tab} Cyberduck -`...`
-`=`
-`...` +Refer to [Add Hidden Configuration Options to Mountain Duck and Cyberduck](../tutorials/hidden_properties.md) ::: -:::{group-tab} CLI +:::{tab} CLI Refer to [Preferences](../cli/index.md#preferences) diff --git a/cyberduck/share.md b/cyberduck/share.md index e92e11a2..6aafed21 100644 --- a/cyberduck/share.md +++ b/cyberduck/share.md @@ -133,7 +133,7 @@ Choose *Share…* from the [context menu](../mountainduck/interface.md#share) t For bookmarks configured with [Microsoft OneDrive](../protocols/onedrive.md) & [Microsoft SharePoint](../protocols/sharepoint.md) protocols. ::::{tabs} -::::{group-tab} Cyberduck +:::{group-tab} Cyberduck Choose *File → Share…*. to create an [shared link](../protocols/onedrive.md) for a file or folder. diff --git a/cyberduck/spotlight.md b/cyberduck/spotlight.md index 429e02ae..f700ed15 100644 --- a/cyberduck/spotlight.md +++ b/cyberduck/spotlight.md @@ -11,7 +11,7 @@ Cyberduck includes a custom *Spotlight Importer Plugin* to search the contents o The *Spotlight Menu* does return no results for recently connected servers in Cyberduck because it excludes indexed files located in `~/Library/Application Support/Cyberduck/History`. This is also an issue for Adium. ::: -As a workaround, you have to export all bookmarks to another location such as your *Documents* folder. Select all bookmarks *(⌘A)* in the bookmark list and drag these somewhere in your *Documents* folder in the Finder. You can then search bookmarks in the *Spotlight Menu* by nickname and hostname. Additionally, to display all bookmarks as a result search for `kind:"Cyberduck Bookmark"`. +As a workaround, you have to export all bookmarks to another location such as your *Documents* folder. Select all bookmarks *(`⌘A`)* in the bookmark list and drag these somewhere in your *Documents* folder in the Finder. You can then search bookmarks in the *Spotlight Menu* by nickname and hostname. Additionally, to display all bookmarks as a result search for `kind:"Cyberduck Bookmark"`. ## Create a Smart Folder in Finder to Search Bookmark Files diff --git a/cyberduck/transfer.md b/cyberduck/transfer.md index fd5ffd23..8b14d866 100644 --- a/cyberduck/transfer.md +++ b/cyberduck/transfer.md @@ -227,26 +227,26 @@ Enabling change of modification date slows down the transfer rate when uploading ### Bandwidth Throttle Options -A [hidden configuration option](preferences.md#hidden-configuration-options). Edit the available options (in bytes). +A [hidden configuration option](../tutorials/hidden_properties.md). Edit the available options (in bytes). ``` -defaults write ch.sudo.cyberduck queue.bandwidth.options 102400,1073741824 +queue.bandwidth.options=102400,1073741824 ``` ### Badge Dock Icon -A [hidden configuration option](preferences.md#hidden-configuration-options). Add a badge with the number of currently running transfers to the dock icon. +A [hidden configuration option](../tutorials/hidden_properties.md). Add a badge with the number of currently running transfers to the dock icon. ``` -defaults write ch.sudo.cyberduck queue.dock.badge true +queue.dock.badge=true ``` ### Prioritize Files in Transfers -A [hidden configuration option](preferences.md#hidden-configuration-options). Use `queue.upload.priority.regex` and `queue.download.priority.regex` to determine order of files transferred in folders. For example: +A [hidden configuration option](../tutorials/hidden_properties.md). Use `queue.upload.priority.regex` and `queue.download.priority.regex` to determine order of files transferred in folders. For example: ``` -defaults write ch.sudo.cyberduck queue.upload.priority.regex ".*\.html" +queue.upload.priority.regex=".*\.html" ``` will prioritize files ending with `.html` and transfer before any other files in a folder. \ No newline at end of file diff --git a/cyberduck/upload.md b/cyberduck/upload.md index ae8c91e7..09944be8 100644 --- a/cyberduck/upload.md +++ b/cyberduck/upload.md @@ -86,10 +86,10 @@ Make sure in *System Preferences → Keyboard → Keyboard Shortcuts → Service ### Transfers → General → Uploads → Upload with temporary filename -An option to upload with a temporary name and rename the file after the transfer is complete. An upload that is not complete, will not be renamed. This is useful for uploading to watch folders, that should only pick up a file once the upload is complete. To specify a different temporary filename pattern, use the [hidden configuration option](preferences.md#hidden-configuration-options) +An option to upload with a temporary name and rename the file after the transfer is complete. An upload that is not complete, will not be renamed. This is useful for uploading to watch folders, that should only pick up a file once the upload is complete. To specify a different temporary filename pattern, use the [hidden configuration option](../tutorials/hidden_properties.md) ``` -defaults write ch.sudo.cyberduck queue.upload.file.temporary.format "'{0}-{1}'" +queue.upload.file.temporary.format="'{0}-{1}'" ``` where `{0}` is the original filename and `{1}` is a random UUID. The default setting uses a temporary filename of `filename-uuid`. \ No newline at end of file diff --git a/mountainduck/connect/index.md b/mountainduck/connect/index.md index 5bbfa962..a0b45b07 100644 --- a/mountainduck/connect/index.md +++ b/mountainduck/connect/index.md @@ -11,13 +11,18 @@ online When connecting to a server, you can choose between *[Online](online.md)* and *[Smart Synchronization](sync.md)* connect mode. -:::{admonition} Online +::::{tabs} +:::{tab} Online + In _Online_ connect mode, changes to a file are immediately uploaded and in sync when an application has finished saving a file. + ::: +:::{tab} Smart Synchronization -:::{admonition} Smart Synchronization In _Smart Synchronization_ connect mode, files are copied to a local cache for faster access prior synchronization with the server in the background. + ::: +:::: ## Feature Comparison diff --git a/mountainduck/connect/online.md b/mountainduck/connect/online.md index 1d2e85ef..04840696 100644 --- a/mountainduck/connect/online.md +++ b/mountainduck/connect/online.md @@ -55,4 +55,4 @@ Network problems and quota or authentication failures will cause the mounted vol ### Auto Unmount on Connection Error -To disable the unmount upon failure use a [hidden configuration option](../preferences.md#hidden-configuration-options) `unmount.auto=false`. +To disable the unmount upon failure use a [hidden configuration option](../../tutorials/hidden_properties.md) `unmount.auto=false`. diff --git a/mountainduck/connect/sync.md b/mountainduck/connect/sync.md index 0d620e6f..81163429 100644 --- a/mountainduck/connect/sync.md +++ b/mountainduck/connect/sync.md @@ -257,10 +257,10 @@ A conflict may be caused by two or more users editing the same files at the same | Action | Error Cause | Error State (Overlay Icon) | Remarks | Manual Conflict Resolution | |------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------:| | Indexing folder | Missing permission | Sync Error for files with
pending write | Other files are removed from
local cache | Context menu with options
*Retry* | -| Open placeholder (1) file | Permission failure reading
file on server | - | Status remains *Online* | - | -| Select to keep file offline
placeholder (1) file | Permission failure reading
file on server | Sync Error | - | Context menu with options
*Retry* | +| Open placeholder[^1] file | Permission failure reading
file on server | - | Status remains *Online* | - | +| Select to keep file offline
placeholder[^1] file | Permission failure reading
file on server | Sync Error | - | Context menu with options
*Retry* | | Indexing folder containing
files in write error state | File with write sync error
state not found on server | Sync Error | For error states caused by other Operations
than `write`, the file is removed on local disk | Context menu with options
*Retry* | -| Open placeholder (1) file | Directory index is out of sync.
File not found on server | - | File is deleted in local cache | - | +| Open placeholder[^1] file | Directory index is out of sync.
File not found on server | - | File is deleted in local cache | - | | Edit file deleted on server | Directory index is out of sync.
File not found on server | - | File is uploaded anew to server | - | | Edit file renamed on server | Directory index is out of sync.
File not found on server | - | File is uploaded anew to server | - | | Edit file already changed
on server | Last seen checksum differs from current
checksum on server. (Or timestamp
when server does not offer checksum
verification) | - | Existing file on server is renamed
to ` timestamp.`.
Eventually with user preference to
default to sync error instead. | User has to manually merge
the conflicting edits. | @@ -272,4 +272,4 @@ A conflict may be caused by two or more users editing the same files at the same | Create folder that exists already on
server | Directory index is out of sync | - | Failure creating folder is ignored | - | | Deleting file already changed on server | Directory index is out of sync | - | File is deleted on server | - | -(1) Indexed file in local cache not downloaded from server +[^1]: Indexed file in local cache not downloaded from server diff --git a/mountainduck/interface.md b/mountainduck/interface.md index 3091fc41..906c1aef 100644 --- a/mountainduck/interface.md +++ b/mountainduck/interface.md @@ -114,7 +114,7 @@ The bookmark can show three different status lights: - **Green light:** Currently connected to this bookmark. The bookmark is completely synced and idle. - **Orange light:** Currently connected to this bookmark. There is at least one active process. -You can can put the currently connected bookmarks on top of the bookmark list regardless of the sorting by using a [hidden configuration option](preferences.md#hidden-configuration-options): +You can can put the currently connected bookmarks on top of the bookmark list regardless of the sorting by using a [hidden configuration option](../tutorials/hidden_properties.md): ``` bookmark.menu.sort.connected=true diff --git a/mountainduck/issues/index.md b/mountainduck/issues/index.md index cafd5c0b..e1b94d44 100644 --- a/mountainduck/issues/index.md +++ b/mountainduck/issues/index.md @@ -235,10 +235,10 @@ You can work around this by setting `defaults write com.apple.finder AppleShowAl Files opened in Preview.app and edited cannot be saved at the original location but the message "The original document can't be changed, so a duplicate with your changes has been created" is displayed in the title bar. As a workaround, you can set a custom mount point in *Preferences → Connection → Mount Location* for volumes such as a `~/Volumes/` folder in your home directory. **Enable Application Icon in Dock**
-As a utility application with no application windows, no icon is displayed in the Dock but only in the system status bar. If you want to enable the application icon to appear in the Dock set the following property: +As a utility application with no application windows, no icon is displayed in the Dock but only in the system status bar. If you want to enable the application icon to appear in the Dock set the following [hidden configuration option](../../tutorials/hidden_properties.md): ``` -defaults write io.mountainduck application.dock.icon.enable true +application.dock.icon.enable=true ``` **Mounted Volumes do not Appear on the Desktop**
@@ -263,10 +263,10 @@ It may be that Finder closes the connection because Mountain Duck hasn't answere This is an issue within the operating system that can occur to any network drive. **Extended Attributes**
-Extended attributes containing metadata about the files some applications write in addition to the file content are saved in auxiliary `._*` files. These are only saved in a temporary location and not synchronized. If you want to save `._*` files to the server set the [hidden configuration option](../preferences.md#hidden-configuration-options): +Extended attributes containing metadata about the files some applications write in addition to the file content are saved in auxiliary `._*` files. These are only saved in a temporary location and not synchronized. If you want to save `._*` files to the server set the [hidden configuration option](../../tutorials/hidden_properties.md): ``` -defaults write io.mountainduck fs.filenames.metadata.enable false +fs.filenames.metadata.enable=false ``` :::: @@ -304,7 +304,7 @@ See Windows sessions above. It is not possible to run Mountain Duck as a Service You can close that overlay by holding your mouse cursor for about 3 seconds on the Mountain Duck icon within the Tray area. **Dot Files are not Hidden**
-By default, files starting with `.` aren't hidden by Windows Explorer. You can change the default by using a [hidden configuration option](../preferences.md#hidden-configuration-options). +By default, files starting with `.` aren't hidden by Windows Explorer. You can change the default by using a [hidden configuration option](../../tutorials/hidden_properties.md). ``` browser.hidden.regex=\\..* diff --git a/mountainduck/locking.md b/mountainduck/locking.md index a79b11d3..abdda39e 100644 --- a/mountainduck/locking.md +++ b/mountainduck/locking.md @@ -67,6 +67,8 @@ Attempting to open a locked document, an error message is displayed notifying th :::: ::::{group-tab} Windows + +**Microsoft Word**
`This file is already opend by another user. Would you like to make a copy of this file for your use?` :::{image} _images/File_in_Use_Microsoft_Word_Windows.png diff --git a/mountainduck/preferences.md b/mountainduck/preferences.md index a57581b9..f0dbf537 100644 --- a/mountainduck/preferences.md +++ b/mountainduck/preferences.md @@ -166,20 +166,4 @@ You receive no update notification if your user is missing administrator permiss ## Hidden Configuration Options -::::{tabs} -:::{group-tab} macOS - -- Type the `defaults` command given in a *Terminal.app* (in `/Applications/Utilities`) window and restart Mountain Duck. -`defaults write io.mountainduck ` -- Alternatively, create a file `~/Library/Group Containers/G69SCX94XU.duck/Library/Application Support/duck/default.properties` with the content formatted as `property=value` - -::: -:::{group-tab} Windows - -If not existing yet you need to create the file `%AppData%\Cyberduck\default.properties`. Add the setting as follows:
-`property=value` - -These settings are shared with Cyberduck. - -::: -:::: \ No newline at end of file +Refer to [Add Hidden Configuration Options for Mountain Duck and Cyberduck](../tutorials/hidden_properties.md) \ No newline at end of file diff --git a/protocols/azure.md b/protocols/azure.md index 88681825..ef55a841 100644 --- a/protocols/azure.md +++ b/protocols/azure.md @@ -58,7 +58,7 @@ To create a new container in your account, browse to the root and choose *File ## Blob Type -Uploads are stored as append blob type by default. You can use the [hidden configuration option](../cyberduck/preferences.md#hidden-configuration-options) `azure.upload.blobtype` which allows the values `BLOCK_BLOB`, `PAGE_BLOB` and `APPEND_BLOB`. +Uploads are stored as append blob type by default. You can use the [hidden configuration option](../tutorials/hidden_properties.md) `azure.upload.blobtype` which allows the values `BLOCK_BLOB`, `PAGE_BLOB` and `APPEND_BLOB`. ## Metadata @@ -66,10 +66,10 @@ You can edit standard custom metadata. Choose *File → Info → Metadata* to ed ### Default Metadata -Currently only possible using a [hidden configuration option](../cyberduck/preferences.md#hidden-configuration-options) you can define default headers to be added for uploads. Multiple headers must be separated using a whitespace delimiter. Key and value of a header are separated with `=`. For example, if you want to add an HTTP header for `Cache-Control` and one named `Creator` you would set +Currently only possible using a [hidden configuration option](../tutorials/hidden_properties.md) you can define default headers to be added for uploads. Multiple headers must be separated using a whitespace delimiter. Key and value of a header are separated with `=`. For example, if you want to add an HTTP header for `Cache-Control` and one named `Creator` you would set ``` -defaults write ch.sudo.cyberduck azure.metadata.default "Cache-Control=public,max-age=86400 Creator=Cyberduck" +azure.metadata.default="Cache-Control=public,max-age=86400 Creator=Cyberduck" ``` ### Shared Access Signature URLs diff --git a/protocols/b2.md b/protocols/b2.md index 0da93f1e..bda3e617 100644 --- a/protocols/b2.md +++ b/protocols/b2.md @@ -163,7 +163,7 @@ The modification date retention is supported using `src_last_modified_millis` fo ### Rename and Move Files -not supported. Supported in Cyberduck 7 or later. +Supported in Cyberduck 7 or later. ## References diff --git a/protocols/box.md b/protocols/box.md index 93e64d80..8a039209 100644 --- a/protocols/box.md +++ b/protocols/box.md @@ -26,10 +26,10 @@ Only available for Box business and enterprise accounts Enter the following information in the [bookmark](../cyberduck/bookmarks.md): -- Protocol: `FTP` or `FTPS` -- Server: `ftp.box.com` -- Username: Your Box account email address -- Password: Your Box account password +- **Protocol**: `FTP` or `FTPS` +- **Server**: `ftp.box.com` +- **Username**: Your Box account email address +- **Password**: Your Box account password #### WebDAV @@ -42,11 +42,11 @@ Box WebDAV support reached end-of-life at October 25th, 2019 Alternatively, enter the following information in the [bookmark](../cyberduck/bookmarks.md): -- Protocol: `WebDAV (HTTPS)` -- Server: `dav.box.com` -- Username: Your Box account email address -- Password: Your Box account password -- Path: `dav` +- **Protocol**: `WebDAV (HTTPS)` +- **Server**: `dav.box.com` +- **Username**: Your Box account email address +- **Password**: Your Box account password +- **Path**: `dav` ## Share diff --git a/protocols/cdn/cloudfront.md b/protocols/cdn/cloudfront.md index 78b821ed..2c14fdf1 100644 --- a/protocols/cdn/cloudfront.md +++ b/protocols/cdn/cloudfront.md @@ -13,13 +13,13 @@ Make sure your objects in the bucket you want to enable distribution for are wor ## Basic (Download HTTP) Distributions -Delivery method _Download (HTTP) CDN)_ used to serve static content from a S3 bucket as an origin. +Delivery method _(Download (HTTP) CDN)_ used to serve static content from a S3 bucket as an origin. ![CloudFront Configuration](_images/CloudFront_Configuration.png) ## Website Configuration Endpoint Distributions -Delivery method _Website Configuration (HTTP)_ to enable a [website endpoint](../s3/index.md#website-configuration) with no CDN features. This does *not* use any CloudFront feature. +Delivery method _(Website Configuration (HTTP))_ to enable a [website endpoint](../s3/index.md#website-configuration) with no CDN features. This does *not* use any CloudFront feature. ## Website Configuration Endpoint Distributions with CloudFront CDN @@ -35,7 +35,7 @@ You must also enable the website endpoint using the delivery method _Website Con ## Streaming (RTMP) Distributions -Delivery method _Streaming (RTMP) CDN)_ used to serve [media](http://en.wikipedia.org/wiki/Flash_Video) using a [streaming protocol](http://en.wikipedia.org/wiki/Real_Time_Messaging_Protocol). +Delivery method _(Streaming (RTMP) CDN)_ used to serve [media](http://en.wikipedia.org/wiki/Flash_Video) using a [streaming protocol](http://en.wikipedia.org/wiki/Real_Time_Messaging_Protocol). :::{attention} Discontinued on December 31, 2020 within CloudFront. For further information refer to the [AWS announcement](https://forums.aws.amazon.com/ann.jspa?annID=7356). diff --git a/protocols/files.com.md b/protocols/files.com.md index 31a7f127..6050b62b 100644 --- a/protocols/files.com.md +++ b/protocols/files.com.md @@ -17,19 +17,19 @@ The connection profile allows to login using the *Files.com REST API* supporting Enter the following information in the [bookmark](../cyberduck/bookmarks.md): -- Protocol: `FTP-SSL (Explicit AUTH TLS)` -- Server: `app.files.com` -- Username: `Your Files.com username` -- Password: `Your Files.com password` +- **Protocol**: `FTP-SSL (Explicit AUTH TLS)` +- **Server**: `app.files.com` +- **Username**: Your Files.com username +- **Password**: Your Files.com password #### WebDAV Enter the following information in the [bookmark](../cyberduck/bookmarks.md): -- Protocol: `WebDAV (HTTPS)` -- Server: `.files.com` -- Username: `Your Files.com username` -- Password: `Your Files.com password` +- **Protocol**: `WebDAV (HTTPS)` +- **Server**: `.files.com` +- **Username**: Your Files.com username +- **Password**: Your Files.com password ## References diff --git a/protocols/ftp.md b/protocols/ftp.md index 67a917c7..03ff4d5d 100644 --- a/protocols/ftp.md +++ b/protocols/ftp.md @@ -157,22 +157,22 @@ The error message `FTP Error: SITE not understood` or similar is displayed. The Various options are available to adjust the usage of different directory listing commands (`LIST`, `STAT` and `MLSD`). Directory listings are requested using `STAT`, `MLSD`, `LIST -a` and `LIST` commands in that order. If a failure is detected (because the server may not support the command), the next option is tried. Because this can be fuzzy logic, it may still be that Cyberduck does not correctly fall back to a supported list command. You may then try to force the use of a given command. -To disable `STAT` for directory listings, change the [hidden configuration option](../cyberduck/preferences.md#hidden-configuration-options) as follows: +To disable `STAT` for directory listings, change the [hidden configuration option](../tutorials/hidden_properties.md) as follows: ``` -defaults write ch.sudo.cyberduck ftp.command.stat false +ftp.command.stat=false ``` To disable `LIST -a` for directory listings, open a Terminal.app window and enter ``` -defaults write ch.sudo.cyberduck ftp.command.lista false +ftp.command.lista=false ``` To disable `MLSD` for directory listings, open a Terminal.app window and enter ``` -defaults write ch.sudo.cyberduck ftp.command.mlsd false +ftp.command.mlsd=false ``` Restart Cyberduck. diff --git a/protocols/googledrive.md b/protocols/googledrive.md index 11bac27a..ccafd258 100644 --- a/protocols/googledrive.md +++ b/protocols/googledrive.md @@ -78,7 +78,7 @@ A list of file versions can be viewed in the *Versions* tab of the *[Info](../cy ### Deleting Files and Folders -Deleted files are trashed instead of being permanently deleted. This feature is enabled by default. It can be disabled using a [hidden configuration option](../cyberduck/preferences.md#hidden-configuration-options). +Deleted files are trashed instead of being permanently deleted. This feature is enabled by default. It can be disabled using a [hidden configuration option](../tutorials/hidden_properties.md). ``` browser.delete.trash=false diff --git a/protocols/openstack/auro.md b/protocols/openstack/auro.md index 67b83146..83cedc31 100644 --- a/protocols/openstack/auro.md +++ b/protocols/openstack/auro.md @@ -10,11 +10,11 @@ AURO ## Connecting -- Protocol: `Swift (OpenStack Object Storage)` -- Server: `api.van1.auro.io` -- Port: `5000` -- Username: `:` -- Password: `` +- **Protocol**: `Swift (OpenStack Object Storage)` +- **Server**: `api.van1.auro.io` +- **Port**: `5000` +- **Username**: `:` +- **Password**: `` The server name is found in the Cloud Dashboard under `Project/Compute/Access & Security/API Access`. Use the Identity server, not the Object Store server. diff --git a/protocols/openstack/cloud.ca.md b/protocols/openstack/cloud.ca.md index 03de2054..31da02aa 100644 --- a/protocols/openstack/cloud.ca.md +++ b/protocols/openstack/cloud.ca.md @@ -15,8 +15,8 @@ Cloud.ca Object Storage Enter the following information in the [bookmark](../../cyberduck/bookmarks.md): -- Protocol: `OpenStack` -- Server: `objects.east-1.cloud.ca` -- Port: `443` -- Username: `Account Name` -- Password: `API Key` \ No newline at end of file +- **Protocol**: `OpenStack` +- **Server**: `objects.east-1.cloud.ca` +- **Port**: `443` +- **Username**: Account Name +- **Password**: API Key \ No newline at end of file diff --git a/protocols/openstack/clouda.md b/protocols/openstack/clouda.md index 51ed8dc1..9aa31b5e 100644 --- a/protocols/openstack/clouda.md +++ b/protocols/openstack/clouda.md @@ -10,11 +10,11 @@ Cloud A ## Connecting -- Protocol: `Swift (OpenStack Object Storage)` -- Server: `keystone.ca-ns-1.clouda.ca` -- Port: `8443` -- Username: `Email (Cloud-A login username)` -- Password: `Cloud-A login password` +- **Protocol**: `Swift (OpenStack Object Storage)` +- **Server**: `keystone.ca-ns-1.clouda.ca` +- **Port**: `8443` +- **Username**: Email (Cloud-A login username) +- **Password**: Cloud-A login password ## References diff --git a/protocols/openstack/cloudfiles.md b/protocols/openstack/cloudfiles.md index 183495a2..2f6091e4 100644 --- a/protocols/openstack/cloudfiles.md +++ b/protocols/openstack/cloudfiles.md @@ -30,9 +30,9 @@ Connection profiles can be installed from *Preferences → Profiles*. Alternatively, enter the following information in the [bookmark](../../cyberduck/bookmarks.md): -- Protocol: `Swift (OpenStack Object Storage)` -- Server: `lon.auth.api.rackspacecloud.com` -- Port: `443` +- **Protocol**: `Swift (OpenStack Object Storage)` +- **Server**: `lon.auth.api.rackspacecloud.com` +- **Port**: `443` ## Features @@ -74,8 +74,8 @@ You can add [custom HTTP headers](../../cyberduck/info.md#metadata-http-headers) ### Default Metadata -Currently only possible using a [hidden configuration option](../../cyberduck/preferences.md#hidden-configuration-options) you can define default headers to be added for uploads. Multiple headers must be separated using a whitespace delimiter. Key and value of a header are separated with `=`. For example, if you want to add a HTTP header for Cache-Control and one named `Creator` you would set +Currently only possible using a [hidden configuration option](../../tutorials/hidden_properties.md) you can define default headers to be added for uploads. Multiple headers must be separated using a whitespace delimiter. Key and value of a header are separated with `=`. For example, if you want to add a HTTP header for Cache-Control and one named `Creator` you would set ``` -defaults write ch.sudo.cyberduck openstack.metadata.default "Cache-Control=public,max-age=86400 Creator=Cyberduck" +openstack.metadata.default="Cache-Control=public,max-age=86400 Creator=Cyberduck" ``` \ No newline at end of file diff --git a/protocols/openstack/entercloudsuite.md b/protocols/openstack/entercloudsuite.md index 27b86e39..cc07866a 100644 --- a/protocols/openstack/entercloudsuite.md +++ b/protocols/openstack/entercloudsuite.md @@ -17,9 +17,9 @@ Use the Tenant ID `email` and password to login. See [API Access](https://cm.ent Enter the following information in the [bookmark](../../cyberduck/bookmarks.md): -- Protocol: `Swift (OpenStack Object Storage)` -- Server: `api.entercloudsuite.com` -- Port: `443` -- Username: *Enter Cloud Suite* `credentials email` -- Password: *Enter Cloud Suite* `credentials password` -- Tenant: `Tenant ID` from the [OpenStack RC File](https://cm.entercloudsuite.com/project/access_and_security/). \ No newline at end of file +- **Protocol**: `Swift (OpenStack Object Storage)` +- **Server**: `api.entercloudsuite.com` +- **Port**: `443` +- **Username**: *Enter Cloud Suite* `credentials email` +- **Password**: *Enter Cloud Suite* `credentials password` +- **Tenant**: `Tenant ID` from the [OpenStack RC File](https://cm.entercloudsuite.com/project/access_and_security/). \ No newline at end of file diff --git a/protocols/openstack/infomaniak.md b/protocols/openstack/infomaniak.md index 19160611..71372a87 100644 --- a/protocols/openstack/infomaniak.md +++ b/protocols/openstack/infomaniak.md @@ -28,8 +28,8 @@ Log in to your *Infomaniak OpenStack Swift space* via this preconfigured connect Enter the following information in the [bookmark](../../cyberduck/bookmarks.md): -- Project:Domain:Username: `Information available in your Infomaniak manager. Example: PCP-XXXXXX:Default:PCU-XXXXXX` -- Password: `password is the same as the one you use for the OpenStack dashboard` +- **Project:Domain:Username**: Information available in your Infomaniak manager. Example: `PCP-XXXXXX:Default:PCU-XXXXXX` +- **Password**: password is the same as the one you use for the OpenStack dashboard ### References @@ -61,8 +61,8 @@ Log in to your *Infomaniak OpenStack Swift space* via this preconfigured connect Enter the following information in the [bookmark](../../cyberduck/bookmarks.md): -- Project: Domain:Username: `information sent by email when you created your Swiss Backup space` -- Password: `password sent by email when you created your Swiss Backup space` +- **Project:Domain:Username**: information sent by email when you created your Swiss Backup space +- **Password**: password sent by email when you created your Swiss Backup space ### References diff --git a/protocols/openstack/internap.md b/protocols/openstack/internap.md index 36ea4f5b..aa2cfa21 100644 --- a/protocols/openstack/internap.md +++ b/protocols/openstack/internap.md @@ -13,10 +13,10 @@ Sign up for [Internap AgileCLOUD (includes AgileFILES object storage)](https://a Enter the following information in the [bookmark](../../cyberduck/bookmarks.md): -- Protocol: `OpenStack` -- Server: `auth.storage.santa-clara.internapcloud.net` -- Port: `443` -- Username: `[account/client login name]` -- Password: `[your client password]` +- **Protocol**: `OpenStack` +- **Server**: `auth.storage.santa-clara.internapcloud.net` +- **Port**: `443` +- **Username**: account/client login name +- **Password**: your client password For more user information please log in to the [Internap Customer Portal](https://login.internap.com/). \ No newline at end of file diff --git a/protocols/openstack/memset.md b/protocols/openstack/memset.md index fce99e48..1003af7f 100644 --- a/protocols/openstack/memset.md +++ b/protocols/openstack/memset.md @@ -32,12 +32,12 @@ Use `admin` for the username, the Memstore name when prompted for the Tenant ID Enter the following information in the [bookmark](../../cyberduck/bookmarks.md): -- Protocol: `Swift (OpenStack Object Storage)` -- Server: `auth.storage.memset.com` -- Port: `443` -- Username: Memstore name and username e.g. `mstestaa1.admin` +- **Protocol**: `Swift (OpenStack Object Storage)` +- **Server**: `auth.storage.memset.com` +- **Port**: `443` +- **Username**: Memstore name and username e.g. `mstestaa1.admin` - If you are not using the `admin` user then a container name will need to be specified under *More Options* -- Password: `Memstore password (API key)` +- **Password**: Memstore password (API key) ![Memstore configuration](_images/Memstore.Swift.Config.png) diff --git a/protocols/openstack/ovh.md b/protocols/openstack/ovh.md index d7b8bf2e..cbc8c452 100644 --- a/protocols/openstack/ovh.md +++ b/protocols/openstack/ovh.md @@ -21,10 +21,10 @@ Connection profiles can be installed from *Preferences → Profiles*. You will need to create a new user in the [OVH manager](https://www.ovh.com/manager/cloud/) in *Cloud → Servers → Project → OpenStack*. Choose *Download OpenStack configuration file* (`openrc.sh`) and open it in a text editor. Copy the values `OS_TENANT_ID:OS_USERNAME` for the username from the file. -- Server: `auth.cloud.ovh.net` -- Port: `443` -- Username: `OS_TENANT_ID:OS_USERNAME` -- Password: `Password`. You will find the password in the user list in *Project → OpenStack*. +- **Server**: `auth.cloud.ovh.net` +- **Port**: `443` +- **Username**: `OS_TENANT_ID:OS_USERNAME` +- **Password**: Your Password. You will find the password in the user list in *Project → OpenStack*. ### S3 diff --git a/protocols/openstack/swiftstack.md b/protocols/openstack/swiftstack.md index 57cf6e60..8b814798 100644 --- a/protocols/openstack/swiftstack.md +++ b/protocols/openstack/swiftstack.md @@ -27,9 +27,9 @@ Connect to a SwiftStack cluster via HTTP or HTTPS using these preconfigured [con Enter the following information in the [bookmark](../../cyberduck/bookmarks.md): -- Server: `SwiftStack cluster API IP address` -- Username: `SwiftStack cluster user` -- Password: `SwiftStack cluster user's password` +- **Server**: SwiftStack cluster API IP address +- **Username**: SwiftStack cluster user +- **Password**: SwiftStack cluster user's password ## References diff --git a/protocols/openstack/zetta.io.md b/protocols/openstack/zetta.io.md index 55611f9c..1e4e6c14 100644 --- a/protocols/openstack/zetta.io.md +++ b/protocols/openstack/zetta.io.md @@ -19,10 +19,10 @@ Connect using the preconfigured [connection profile](../../cyberduck/connection. ### Manual Configuration -- Server: `identity.api.zetta.io` -- Port: `443` -- Username: `::` -- Password: `` +- **Server**: `identity.api.zetta.io` +- **Port**: `443` +- **Username**: `::` +- **Password**: Your Password You will need the [Openstack Swift (Keystone 3) profile](index.md) if you want to use manual configuration with Cyberduck or Mountainduck. We recommend that you use the official profile instead. diff --git a/protocols/profiles/google_client_id.md b/protocols/profiles/google_client_id.md index 2091f00a..ce2433f3 100644 --- a/protocols/profiles/google_client_id.md +++ b/protocols/profiles/google_client_id.md @@ -15,7 +15,7 @@ Follow the [step-by-step instructions](../../tutorials/custom_oauth_client_id.md Follow the steps in [Setting up OAuth 2.0](https://support.google.com/googleapi/answer/6158849?hl=en). From Credentials copy the client ID and client secret by choosing the action Edit OAuth client. -* Choose _Desktop app_ as the _Application type_ which will result in a Client ID with a suffix like `number-id.apps.googleusercontent.com`. +- Choose _Desktop app_ as the _Application type_ which will result in a Client ID with a suffix like `number-id.apps.googleusercontent.com`. :::{image} _images/Google_Create_OAuth_Client_ID.png :alt: Google Create OAuth Client ID @@ -27,7 +27,7 @@ Follow the steps in [Setting up OAuth 2.0](https://support.google.com/googleapi/ :width: 600px ::: -* Edit the OAuth Consent Screen* to add the scopes *Google Cloud Storage JSON API* `../auth/devstorage.read_write` and/or *Google Drive API* `../auth/drive`. You will first need to enable *Google Drive* in the Google API Library. +- Edit the *OAuth Consent Screen* to add the scopes *Google Cloud Storage JSON API* `../auth/devstorage.read_write` and/or *Google Drive API* `../auth/drive`. You will first need to enable *Google Drive* in the Google API Library. ## Edit Custom Connection Profile diff --git a/protocols/s3/digitalocean.md b/protocols/s3/digitalocean.md index bcb08a9d..f474d135 100644 --- a/protocols/s3/digitalocean.md +++ b/protocols/s3/digitalocean.md @@ -18,57 +18,57 @@ Connection profiles can be installed from *Preferences → Profiles*. {download}`Download` the *DigitalOcean Spaces (ams3) Connection Profile* for preconfigured settings. -- Protocol: `Amazon S3` -- Server: `ams3.digitaloceanspaces.com` +- **Protocol**: `Amazon S3` +- **Server**: `ams3.digitaloceanspaces.com` ### BLR1 {download}`Download` the *DigitalOcean Spaces (blr1) Connection Profile* for preconfigured settings. -- Protocol: `Amazon S3` -- Server: `blr1.digitaloceanspaces.com` +- **Protocol**: `Amazon S3` +- **Server**: `blr1.digitaloceanspaces.com` ### FRA1 {download}`Download` the *DigitalOcean Spaces (fra1) Connection Profile* for preconfigured settings. -- Protocol: `Amazon S3` -- Server: `fra1.digitaloceanspaces.com` +- **Protocol**: `Amazon S3` +- **Server**: `fra1.digitaloceanspaces.com` ### NYC3 {download}`Download` the *DigitalOcean Spaces (nyc3) Connection Profile* for preconfigured settings. -- Protocol: `Amazon S3` -- Server: `nyc3.digitaloceanspaces.com` +- **Protocol**: `Amazon S3` +- **Server**: `nyc3.digitaloceanspaces.com` ### SFO2 {download}`Download` the *DigitalOcean Spaces (sfo2) Connection Profile* for preconfigured settings. -- Protocol: `Amazon S3` -- Server: `sfo2.digitaloceanspaces.com` +- **Protocol**: `Amazon S3` +- **Server**: `sfo2.digitaloceanspaces.com` ### SFO3 {download}`Download` the *DigitalOcean Spaces (sfo3) Connection Profile* for preconfigured settings. -- Protocol: `Amazon S3` -- Server: `sfo3.digitaloceanspaces.com` +- **Protocol**: `Amazon S3` +- **Server**: `sfo3.digitaloceanspaces.com` ### SGP1 {download}`Download` the *DigitalOcean Spaces (sgp1) Connection Profile* for preconfigured settings. -- Protocol: `Amazon S3` -- Server: `sgp1.digitaloceanspaces.com` +- **Protocol**: `Amazon S3` +- **Server**: `sgp1.digitaloceanspaces.com` ### SYD1 {download}`Download` the *DigitalOcean Spaces (syd1) Connection Profile* for preconfigured settings. -- Protocol: `Amazon S3` -- Server: `syd1.digitaloceanspaces.com` +- **Protocol**: `Amazon S3` +- **Server**: `syd1.digitaloceanspaces.com` ## Buckets diff --git a/protocols/s3/dunkel.md b/protocols/s3/dunkel.md index 02599ccb..765ee24f 100644 --- a/protocols/s3/dunkel.md +++ b/protocols/s3/dunkel.md @@ -18,8 +18,8 @@ Refer also to [S3](index.md) wiki page in general. ### Manual Configuration -- Protocol: `S3` -- Server: `dcs.dunkel.de` +- **Protocol**: `S3` +- **Server**: `dcs.dunkel.de` ## Limitations diff --git a/protocols/s3/index.md b/protocols/s3/index.md index 0d8913eb..67e99e93 100644 --- a/protocols/s3/index.md +++ b/protocols/s3/index.md @@ -139,7 +139,7 @@ For S3 compatible storage only supporting path style requests to reference bucke - {download}`Download` the *S3 (Deprecated path style requests) profile* for preconfigured settings. -Alternatively set the [hidden configuration option](../../cyberduck/preferences.md#hidden-configuration-options) `s3.bucket.virtualhost.disable` to `true`. +Alternatively set the [hidden configuration option](../../tutorials/hidden_properties.md) `s3.bucket.virtualhost.disable` to `true`. :::{admonition} Interoperability :class: note @@ -628,7 +628,7 @@ You can edit standard HTTP headers and add [custom HTTP headers](../../cyberduck ### Default Metadata -Currently only possible using a [hidden configuration option](../../cyberduck/preferences.md#hidden-configuration-options) you can define default headers to be added for uploads. Multiple headers must be separated using a whitespace delimiter. Key and value of a header are separated with `=`. For example, if you want to add an HTTP header for Cache-Control and one named `Creator` you would set +Currently only possible using a [hidden configuration option](../../tutorials/hidden_properties.md) you can define default headers to be added for uploads. Multiple headers must be separated using a whitespace delimiter. Key and value of a header are separated with `=`. For example, if you want to add an HTTP header for Cache-Control and one named `Creator` you would set ``` s3.metadata.default="Cache-Control=public,max-age=86400 Creator=Cyberduck" @@ -640,7 +640,7 @@ This option lets you control how long a client accessing objects from your S3 bu The default setting is `Cache-Control: public,max-age=2052000` when choosing to add a custom `Cache-Control` header in the [Info](../../cyberduck/info.md) panel which translates to a cache expiration of one month (one month in seconds equals more or less `60*60*24*30`). -Use the [hidden configuration option](../../cyberduck/preferences.md#hidden-configuration-options) `s3.cache.seconds` to set a custom default value +Use the [hidden configuration option](../../tutorials/hidden_properties.md) `s3.cache.seconds` to set a custom default value ``` s3.cache.seconds=2052000 diff --git a/protocols/s3/linode.md b/protocols/s3/linode.md index b851012f..80f8bd06 100644 --- a/protocols/s3/linode.md +++ b/protocols/s3/linode.md @@ -24,10 +24,10 @@ Connection profiles can be installed from *Preferences → Profiles*. Enter the following information in the [bookmark](../../cyberduck/bookmarks.md). Choose the endpoint based on the bucket location. Refer to [Availability](https://www.linode.com/docs/products/storage/object-storage/) -- Protocol: `Amazon S3` -- Server: `us-southeast-1.linodeobjects.com, us-east-1.linodeobjects.com, eu-central-1.linodeobjects.com, ap-south-1.linodeobjects.com` -- Access Key ID: `` -- Secret Access Key: `` +- **Protocol**: `Amazon S3` +- **Server**: `us-southeast-1.linodeobjects.com`, `us-east-1.linodeobjects.com`, `eu-central-1.linodeobjects.com`, `ap-south-1.linodeobjects.com` +- **Access Key ID**: your access key +- **Secret Access Key**: your secret access key ### Generate Access Keys diff --git a/protocols/s3/oraclecloud.md b/protocols/s3/oraclecloud.md index 0317e355..0f784a74 100644 --- a/protocols/s3/oraclecloud.md +++ b/protocols/s3/oraclecloud.md @@ -53,11 +53,11 @@ Follow these instructions: 1. {download}`Download` the Oracle Storage Cloud profile for preconfigured settings using the `/auth/v1.0` authentication context. 2. Enter the following information in the [bookmark](../../cyberduck/bookmarks.md): - - Protocol: Swift (OpenStack Object Storage) - - Server: `IdentityDomain.storage.oraclecloud.com`. For example, this is `cyduck.storage.oraclecloud.com` - - Username: `ServiceName-IdentityDomain:UserName`. For example this is `Storage-cyduck:dkocher@cyberduck.io` - - Password: Oracle Cloud Password - - Tenant: Oracle Cloud Username + - **Protocol**: Swift (OpenStack Object Storage) + - **Server**: `IdentityDomain.storage.oraclecloud.com`. For example, this is `cyduck.storage.oraclecloud.com` + - **Username**: `ServiceName-IdentityDomain:UserName`. For example this is `Storage-cyduck:dkocher@cyberduck.io` + - **Password**: Oracle Cloud Password + - **Tenant**: Oracle Cloud Username - OCI Object Storage Classic Regions - us2: Chicago, IL - us6: Ashburn, VA diff --git a/protocols/s3/polycloud.md b/protocols/s3/polycloud.md index ffc75f4a..73241718 100644 --- a/protocols/s3/polycloud.md +++ b/protocols/s3/polycloud.md @@ -8,9 +8,9 @@ Polycloud {download}`Download` the *Polycloud Connection Profile* for preconfigurated settings for authentication. Double-click on the downloaded file to activate the connection profile. Enter the following authentication credentials to the bookmark: -- Server: `polycloud.crowdapis.com` -- Access Key ID: Access Key Credentials -- Secret Access Key: Access Key Credentials +- **Server**: `polycloud.crowdapis.com` +- **Access Key ID**: Access Key Credentials +- **Secret Access Key**: Access Key Credentials ### How to Create Application Keys diff --git a/protocols/s3/seagate.md b/protocols/s3/seagate.md index c086e584..88ae363c 100644 --- a/protocols/s3/seagate.md +++ b/protocols/s3/seagate.md @@ -5,10 +5,10 @@ Seagate Lyve Cloud ## Connection -- Protocol: `S3 (HTTPS)` -- Server: `` -- Access Key ID: `` -- Secret Access Key: `` +- **Protocol**: `S3 (HTTPS)` +- **Server**: your endpoint +- **Access Key ID**: your access key +- **Secret Access Key**: your secret access key :::{hint} Available [endpoints](https://help.lyvecloud.seagate.com/en/s3-api-endpoint.html) are diff --git a/protocols/s3/storadera.md b/protocols/s3/storadera.md index a951256b..8d2043bd 100644 --- a/protocols/s3/storadera.md +++ b/protocols/s3/storadera.md @@ -11,10 +11,10 @@ Storadera ### Manual Configuration -- Protocol: `Amazon S3` -- Server: `eu-east-1.s3.storadera.com` -- Access Key ID: `` -- Secret Access Key: `` +- **Protocol**: `Amazon S3` +- **Server**: `eu-east-1.s3.storadera.com` +- **Access Key ID**: your access key +- **Secret Access Key**: your secret access key ## References diff --git a/protocols/s3/storjdcs.md b/protocols/s3/storjdcs.md index ab8038ba..7f5d6502 100644 --- a/protocols/s3/storjdcs.md +++ b/protocols/s3/storjdcs.md @@ -9,10 +9,10 @@ Storj DCS ### Manual Configuration -- Protocol: Amazon S3 -- Server: `gateway.storjshare.io` -- Access Key ID: `` -- Secret Access Key: `` +- **Protocol**: `Amazon S3` +- **Server**: `gateway.storjshare.io` +- **Access Key ID**: your access key +- **Secret Access Key**: your secret access key ### Credentials diff --git a/protocols/sftp/index.md b/protocols/sftp/index.md index 2bf045c9..61aacc9e 100644 --- a/protocols/sftp/index.md +++ b/protocols/sftp/index.md @@ -83,10 +83,10 @@ For the configuration above the hostname to specify in your bookmark is `myhosta #### Default Public Key Authentication Keys -You can enable the use of a default set of keys `~/.ssh/id_rsa` and `~/.ssh/id_dsa` (in this order) by setting the [hidden configuration option](../../cyberduck/preferences.md#hidden-configuration-options) `ssh.authentication.publickey.default.enable` to `true`. +You can enable the use of a default set of keys `~/.ssh/id_rsa` and `~/.ssh/id_dsa` (in this order) by setting the [hidden configuration option](../../tutorials/hidden_properties.md) `ssh.authentication.publickey.default.enable` to `true`. ``` -defaults write ch.sudo.cyberduck ssh.authentication.publickey.default.enable true +ssh.authentication.publickey.default.enable=true ``` ### Public Key Authentication @@ -240,10 +240,10 @@ Use *View → Customize Toolbar...* to add the *Terminal.app* toolbar icon to yo ![Terminal](../_images/Terminal.png) **Customize SSH Command:**
-You can change the SSH command using the [hidden configuration option](../../cyberduck/preferences.md#hidden-configuration-options) +You can change the SSH command using the [hidden configuration option](../../tutorials/hidden_properties.md) ``` -defaults write ch.sudo.cyberduck terminal.command.ssh \"ssh\ -t\ {0}\ {1}@{2}\ -p\ {3}\ \\\"cd\ {4}\ \&\&\ exec\ \\\\\$SHELL\\\"\" +terminal.command.ssh=\"ssh\ -t\ {0}\ {1}@{2}\ -p\ {3}\ \\\"cd\ {4}\ \&\&\ exec\ \\\\\$SHELL\\\"\" ``` where @@ -262,7 +262,7 @@ Because of all the escaping of characters, it might be easier to edit the key us No configuration change is required. Choose *iTerm2 → Make iTerm2 Default Term* and restart Cyberduck. To revert, set the default application for a file named `.command` to *Terminal.app* in *Finder → Info → Open With…*. **Previous versions:**
-You can change a [hidden configuration option](../../cyberduck/preferences.md#hidden-configuration-options) to use a third-party terminal application instead of Terminal.app. +You can change a [hidden configuration option](../../tutorials/hidden_properties.md) to use a third-party terminal application instead of Terminal.app. - Example for iTerm2 Version 2 ``` @@ -287,7 +287,7 @@ defaults delete ch.sudo.cyberduck terminal.command **Disable WSL** -There is a [hidden configuration option](../../cyberduck/preferences.md#hidden-configuration-options) for toggling additional SSH-terminal applications. Currently implemented are `ssh.exe` (OpenSSH built-in to Windows 10 since version 1709), `bash.exe` (using WSL and invoking `ssh` there) as well as PuTTY. +There is a [hidden configuration option](../../tutorials/hidden_properties.md) for toggling additional SSH-terminal applications. Currently implemented are `ssh.exe` (OpenSSH built-in to Windows 10 since version 1709), `bash.exe` (using WSL and invoking `ssh` there) as well as PuTTY. - Disabling OpenSSH: `terminal.openssh.enable=false` - Disabling WSL: `terminal.windowssubsystemlinux.enable=false` @@ -433,7 +433,7 @@ Symlink is displayed as a regular file or folder. :::{admonition} macOS :class: note -Mountain Duck will forward all permission changes from Finder or any other application to the SFTP server. There is a [hidden configuration option](../../mountainduck/preferences.md#hidden-configuration-options) `fs.setattr.chmod=false` to disable the writing of permissions. +Mountain Duck will forward all permission changes from Finder or any other application to the SFTP server. There is a [hidden configuration option](../../tutorials/hidden_properties.md) `fs.setattr.chmod=false` to disable the writing of permissions. ::: #### File Owner Reset When Saving File @@ -452,4 +452,4 @@ Some editors save files using an *Atomic Save* feature that writes changes to a The available space for a volume mounted over SFTP is determined using quota features of the SSH protocol. Technically using the `space-available` extension of the SFTP protocol or the `statvfs@openssh.com` extension from OpenSSH. If the connected device returns an invalid value (e.g. from the disk the server is running instead of the data disk) you will get an incorrect calculation for the free space. You can work around the issue using one of the following options: - Set a default path you want to connect to within the bookmark *Path* option. -- Disable the feature in Mountain Duck by setting the [hidden configuration option](../../mountainduck/preferences.md#hidden-configuration-options) `fs.quota.enable=false`. +- Disable the feature in Mountain Duck by setting the [hidden configuration option](../../tutorials/hidden_properties.md) `fs.quota.enable=false`. diff --git a/protocols/sftp/sftptogo.md b/protocols/sftp/sftptogo.md index 44974173..7015d495 100644 --- a/protocols/sftp/sftptogo.md +++ b/protocols/sftp/sftptogo.md @@ -14,20 +14,20 @@ To connect using username and password, login to SFTP To Go's dashboard and go t 1. Expand the credentials you'd like to use to connect to copy the hostname, username and password. 2. Create a new [bookmark](../../cyberduck/bookmarks.md) and enter the following information: -- Protocol: `SFTP (SSH File Transfer Protocol)` -- Server: `Hostname copied from SFTP To Go's dashboard` -- Username: `Username copied from SFTP To Go's dashboard` -- Password: `Password copied from SFTP To Go's dashboard` +- **Protocol**: `SFTP (SSH File Transfer Protocol)` +- **Server**: Hostname copied from SFTP To Go's dashboard +- **Username**: Username copied from SFTP To Go's dashboard +- **Password**: Password copied from SFTP To Go's dashboard To connect using public key authentication, login to SFTP To Go's dashboard and go to the credentials page: 1. Expand the credentials you'd like to use to connect in order to copy the hostname and username. 2. Create a new [bookmark](../../cyberduck/bookmarks.md) and enter the following information: -- Protocol: `SFTP (SSH File Transfer Protocol)` -- Server: `Hostname copied from SFTP To Go's dashboard` -- Username: `Username copied from SFTP To Go's dashboard` -- SSH Private key: `path to private key that matches the public key imported in SFTP To Go` +- **Protocol**: `SFTP (SSH File Transfer Protocol)` +- **Server**: Hostname copied from SFTP To Go's dashboard +- **Username**: Username copied from SFTP To Go's dashboard +- **SSH Private key**: path to private key that matches the public key imported in SFTP To Go #### FTPS @@ -36,10 +36,10 @@ Login to SFTP To Go's dashboard and go to the credentials page: 1. Expand the credentials you'd like to use to connect in order to copy the hostname, username and password. 2. Create a new [bookmark](../../cyberduck/bookmarks.md) and enter the following information: -- Protocol: `FTP-SSL (Explicit AUTH TLS)` -- Server: `Hostname copied from SFTP To Go's dashboard` -- Username: `Username copied from SFTP To Go's dashboard` -- Password: `Password copied from SFTP To Go's dashboard` +- **Protocol**: `FTP-SSL (Explicit AUTH TLS)` +- **Server**: Hostname copied from SFTP To Go's dashboard +- **Username**: Username copied from SFTP To Go's dashboard +- **Password**: Password copied from SFTP To Go's dashboard #### S3 @@ -49,11 +49,11 @@ Login to SFTP To Go's dashboard and go to the credentials page: Enter the following information in the [bookmark](../../cyberduck/bookmarks.md): -- Protocol: `Amazon S3` -- Server: Copy the bucket from SFTP To Go' dashboard and use them in the following pattern: `.s3.amazonaws.com` -- Access Key ID: `Access key ID copied from SFTP To Go's dashboard` -- Secret Access Key: `Secret access key copied from SFTP To Go's dashboard` -- Path: `Bucket name copied from SFTP To Go's dashboard` +- **Protocol**: `Amazon S3` +- **Server**: Copy the bucket from SFTP To Go' dashboard and use them in the following pattern: `.s3.amazonaws.com` +- **Access Key ID**: Access key ID copied from SFTP To Go's dashboard +- **Secret Access Key**: Secret access key copied from SFTP To Go's dashboard +- **Path**: Bucket name copied from SFTP To Go's dashboard ## References diff --git a/protocols/sharepoint.md b/protocols/sharepoint.md index 2dc4491a..39892ac1 100644 --- a/protocols/sharepoint.md +++ b/protocols/sharepoint.md @@ -75,11 +75,11 @@ Basic Authentication should only be used when using secured connection over TLS #### NTLM Authentication -If you need to set the `domain` and `workstation`, you can do so using a [hidden configuration option](../cyberduck/preferences.md#hidden-configuration-options). +If you need to set the `domain` and `workstation`, you can do so using a [hidden configuration option](../tutorials/hidden_properties.md). ``` -defaults write ch.sudo.cyberduck webdav.ntlm.workstation MYWORKSTATION -defaults write ch.sudo.cyberduck webdav.ntlm.domain MYDOMAIN +webdav.ntlm.workstation=MYWORKSTATION +webdav.ntlm.domain=MYDOMAIN ``` #### Configuration diff --git a/protocols/smb.md b/protocols/smb.md index 33631e66..495dd780 100644 --- a/protocols/smb.md +++ b/protocols/smb.md @@ -17,7 +17,7 @@ SMB :::{important} * Cyberduck [8.7.0](https://cyberduck.io/changelog/) or later required -* Mountain Duck [5.0.0](https://mountainduck.io/changelog/) or later required +* Mountain Duck 5.0.0 required (not yet available) ::: To connect to a SMB server, choose _SMB (Server Message Block)_. diff --git a/protocols/webdav/bigcommerce.md b/protocols/webdav/bigcommerce.md index 13838cf8..c4e5de9e 100644 --- a/protocols/webdav/bigcommerce.md +++ b/protocols/webdav/bigcommerce.md @@ -5,11 +5,11 @@ BigCommerce 1. Obtain your WebDAV credentials and setup details from your BigCommerce control panel ([Server Settings → File Access (WebDAV)](http://login.bigcommerce.com/deep-links/settings/file-access)). 2. Enter the following information in the [bookmark](../../cyberduck/bookmarks.md): - - Protocol: `WebDAV (HTTPS)` - - Server: Your WebDAV Path without `/dav` - - Username: Your WebDAV username - - Password: Your WebDAV password - - Path: `dav` + - **Protocol**: `WebDAV (HTTPS)` + - **Server**: Your WebDAV Path without `/dav` + - **Username**: Your WebDAV username + - **Password**: Your WebDAV password + - **Path**: `dav` ## References diff --git a/protocols/webdav/gmx.md b/protocols/webdav/gmx.md index 68816f0e..e64cff51 100644 --- a/protocols/webdav/gmx.md +++ b/protocols/webdav/gmx.md @@ -11,9 +11,9 @@ GMX Cloud ### Manual Configuration -- Protocol: `WebDAV (HTTPS)` -- Server: `webdav.mc.gmx.net` -- Username: `GMX Kundenummer` or `GMX email` +- **Protocol**: `WebDAV (HTTPS)` +- **Server**: `webdav.mc.gmx.net` +- **Username**: `GMX Kundenummer` or `GMX email` ## References diff --git a/protocols/webdav/ikeepincloud.md b/protocols/webdav/ikeepincloud.md index 5efe8bf1..5d4179fd 100644 --- a/protocols/webdav/ikeepincloud.md +++ b/protocols/webdav/ikeepincloud.md @@ -5,10 +5,10 @@ iKeepinCloud ## Connecting -- Protocol: `WebDAV (HTTP)`, `WebDAV (HTTPS)`, `SFTP`, `FTPS` or `FTP` -- Server: `.ikeepincloud.com` or public.`.ikeepincloud.com` -- Username: Your subscription ID -- Password: the one sent by IKoula +- **Protocol**: `WebDAV (HTTP)`, `WebDAV (HTTPS)`, `SFTP`, `FTPS` or `FTP` +- **Server**: `.ikeepincloud.com` or public.`.ikeepincloud.com` +- **Username**: Your subscription ID +- **Password**: the one sent by IKoula ## References diff --git a/protocols/webdav/index.md b/protocols/webdav/index.md index 6e80d45d..5ebfd226 100644 --- a/protocols/webdav/index.md +++ b/protocols/webdav/index.md @@ -133,7 +133,7 @@ Saving the modification dates requires support from server storing metadata in c ### Cannot Login with Special Characters in Credentials -If your server requires the use of UTF-8 character set for authentication, set the [hidden configuration option](../../cyberduck/preferences.md#hidden-configuration-options) +If your server requires the use of UTF-8 character set for authentication, set the [hidden configuration option](../../tutorials/hidden_properties.md) ``` http.credentials.encoding=UTF-8 diff --git a/protocols/webdav/kdrive.md b/protocols/webdav/kdrive.md index 02cd5d64..1363bdd4 100644 --- a/protocols/webdav/kdrive.md +++ b/protocols/webdav/kdrive.md @@ -7,10 +7,10 @@ Infomaniak kDrive Enter the following information in the [bookmark](../../cyberduck/bookmarks.md): -- Protocol: `WebDAV (HTTPS)` -- Server: `connect.drive.infomaniak.com` -- Username: `Your kDrive login email.` -- Password: +- **Protocol**: `WebDAV (HTTPS)` +- **Server**: `connect.drive.infomaniak.com` +- **Username**: Your kDrive login email. +- **Password**: - 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) diff --git a/protocols/webdav/pcloud.md b/protocols/webdav/pcloud.md index 8ce4b7d2..b85b0741 100644 --- a/protocols/webdav/pcloud.md +++ b/protocols/webdav/pcloud.md @@ -22,10 +22,10 @@ Connection profiles can be installed from *Preferences → Profiles*. #### Data Region: USA (Texas) -- Server: `https://webdav.pcloud.com` -- Port: `443` -- Username: pCloud login Email -- Password: pCloud login password +- **Server**: `https://webdav.pcloud.com` +- **Port**: `443` +- **Username**: pCloud login Email +- **Password**: pCloud login password #### Data Region: Europe (Luxemburg) diff --git a/tutorials/hidden_properties.md b/tutorials/hidden_properties.md new file mode 100644 index 00000000..e32e5e48 --- /dev/null +++ b/tutorials/hidden_properties.md @@ -0,0 +1,85 @@ +Add Hidden Configuration Options to Mountain Duck and Cyberduck +=== + +:::{tip} +For Cyberduck CLI refer to [Preferences](../cli/index.md) +::: + +There are some settings which aren't yet available in the *Preferences* either because they are not considered stable yet or not of general interest. + +For [Mountain Duck](../mountainduck/index.md) and [Cyberduck](../cyberduck/index.md) you can add the property line in the format `property=value` to the `default.properties` file within the [application support folder](../cyberduck/support.md#application-support-folder) on Windows and macOS. + +:::{important} +You'll have to create the `default.properties` file manually if it isn't present yet! +::: + +## Step-by-Step Instructions +1. Quit Mountain Duck/Cyberduck +2. Navigate into the [application support folder](../cyberduck/support.md#application-support-folder). + + :::{note} + The application support folder is the same for Mountain Duck and Cyberduck. + ::: + +3. Check if there is a `default.properties` file available + - If it is available, open it within a text editor of your choice, add the desired property line and save the file. + - If the file isn't available, follow the remaining steps. +4. Open a text editor of your choice, for example, TextEdit (macOS) or Notepad (Windows), and add the desired property line. +5. Save the file as a text file (txt) into the [application support folder](../cyberduck/support.md#application-support-folder). + + :::{attention} + Avoid saving the file within the rich text format (rtf), as this causes Mountain Duck/Cyberduck to not recognize the property file after changing the file extension. + ::: + +6. Close the text editor. +7. Replace the file name **and** extension with `default.properties`. +8. Confirm that you want to change the file extension if your operating system warns you about it. + +In case you don't see the file extensions you can reveal them by following the instructions for your respective operating system. + +::::{tabs} +:::{tab} macOS + +You can reveal the file extensions for all files by ticking the checkmark `Show all filename extensions` within `Finder → Preferences → Advanced`. + +Alternatively, you can reveal the file extension for a specific file by opening the Finder info window on the wanted file and removing the checkmark `Hide extension` within the `Name & Extension` section. + +::: +:::{tab} Windows + +1. Open the *Folder Options* window. +2. Select the *View* tab. +3. Deselect the `Hide extensions for known file types` checkbox under *Advanced Settings* +4. Click on *Apply* and *OK*. + +You can also open the *Folder Options* window by searching for `File Explorer Options` within the *Start* search box. + +::: +:::: + +## Activate Hidden Configuration Options Through `Terminal.app` + +:::::{admonition} macOS only +:class: note + +::::{tabs} +:::{tab} Mountain Duck + +Type the `defaults` command in the format below in a *Terminal.app* (in `\Applications\Utilities`) window and restart Mountain Duck. + +``` +defaults write io.mountainduck +``` + +::: +:::{tab} Cyberduck + +Type the `defaults` command in the format below in a *Terminal.app* (in `\Applications\Utilities`) window and restart Cyberduck. + +``` +defaults write ch.sudo.cyberduck +``` + +::: +:::: +::::: \ No newline at end of file diff --git a/tutorials/index.md b/tutorials/index.md index 73426aa8..ce58f031 100644 --- a/tutorials/index.md +++ b/tutorials/index.md @@ -4,6 +4,7 @@ Tutorials :::{toctree} :hidden: :titlesonly: +hidden_properties custom_oauth_client_id :::