Skip to content

Commit

Permalink
Merge branch 'main' into mountainduck/5
Browse files Browse the repository at this point in the history
  • Loading branch information
Cassie205 authored Jan 30, 2024
2 parents 6372a46 + 2ba0fef commit 909c740
Show file tree
Hide file tree
Showing 32 changed files with 157 additions and 74 deletions.
6 changes: 6 additions & 0 deletions .codespellrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[codespell]
skip = .git,*.pdf,*.svg,go.sum,*.css,.codespellrc
check-hidden = true
# Some German and custom names and regexes
ignore-regex = .*\b(ist ein|SAV for Mac)\b|.*ü.*|\bTe\*|\b_static/Ressources\b
# ignore-words-list =
22 changes: 22 additions & 0 deletions .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Codespell

on:
push:
branches: [main]
pull_request:
branches: [main]

permissions:
contents: read

jobs:
codespell:
name: Check for spelling errors
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v3
- name: Codespell
uses: codespell-project/actions-codespell@v2
2 changes: 1 addition & 1 deletion Formatting_Cheat-Sheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ test
[Formatting Cheat Sheet](Formatting_Cheat-Sheet)

```
{download}`Titel<Download_Link>`
{download}`Title<Download_Link>`
```

---
Expand Down
2 changes: 1 addition & 1 deletion cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ duck --username <Access Key ID> --list s3:/<bucketname>/

#### `--retry`

Retry requests with I/O failures once per default. Useful on connnection timeout or latency issues.
Retry requests with I/O failures once per default. Useful on connection timeout or latency issues.

#### `--verbose`

Expand Down
4 changes: 2 additions & 2 deletions cyberduck/browser.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Navigate into a folder with a double-click *(`⌘↓`)* or one level up by using
````
````{group-tab} Windows
You can expand and collaps folders using the right and left arrow keys in the outline view.
You can expand and collapse folders using the right and left arrow keys in the outline view.
Navigate into a folder with a doubl-click *(`Ctrl+Down`)* or one level up by using the ▲ button next to the path-field *(`Ctrl+Up`)*.
Expand Down Expand Up @@ -183,7 +183,7 @@ Use the *File → Print* option where you can open a PDF from the browser listin

### Folder Icon Badges

Folder icons are badged for paticular access permissions.
Folder icons are badged for particular access permissions.

```{image} _images/privatefolderbadge.png
:alt: Private Folder Badge
Expand Down
4 changes: 2 additions & 2 deletions cyberduck/connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ Choose *Cyberduck → Preferences → Connection → Use system proxy settings*.

### Additional Settings

#### Prefer IPv6 Adresses of DNS Lookups
#### Prefer IPv6 Addresses of DNS Lookups

A [hidden configuration option](preferences.md#hidden-configuration-options).

Expand All @@ -203,7 +203,7 @@ A [hidden configuration option](preferences.md#hidden-configuration-options).

defaults write ch.sudo.cyberduck rendezvous.enable false

#### Disable Bonjour Notifications in Notification Center and Sytem Tray
#### 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.

Expand Down
2 changes: 1 addition & 1 deletion cyberduck/edit.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Edit Files
You can edit a file just as a local file in an external editor by clicking the Edit toolbar button or by choosing *File → Edit With*. The file will be downloaded to a temporary directory and opened with the preferred editor. The file will be uploaded to the server every time you choose *File → Save* in the Editor application. The file is not changed on the server if you just close the document without saving it or if the content has not changed.

## Default Editor
The default editor opened for a file is selected depeding on the file type. If no application is found to handle the file type the default eidtor chosen in *Preferences* is used instead.
The default editor opened for a file is selected depending on the file type. If no application is found to handle the file type the default eidtor chosen in *Preferences* is used instead.

```{image} _images/Edit_With_Application.png
:alt: Edit with Application
Expand Down
2 changes: 1 addition & 1 deletion cyberduck/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Cyberduck is an open-source server and cloud storage browser for Mac and Windows

### Is Cyberduck Free?

Cyberduck is free software. Free software is a matter of the users' freedom to run, copy, distribute, study, change, and improve the software. If you find this programm useful, please consider making a [donation](http://cyberduck.ch/donate). A donation would not only demonstrate your appreciation of this software but also help to advance development in the future. You receive a registration key and it will help to make Cyberduck even better!
Cyberduck is free software. Free software is a matter of the users' freedom to run, copy, distribute, study, change, and improve the software. If you find this program useful, please consider making a [donation](http://cyberduck.ch/donate). A donation would not only demonstrate your appreciation of this software but also help to advance development in the future. You receive a registration key and it will help to make Cyberduck even better!

```{image} _images/Donation_Prompt.png
:alt: Donation Prompt
Expand Down
2 changes: 1 addition & 1 deletion cyberduck/share.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Providers with support to share a file using a public, password protected or tem

### S3

For connections using [S3](../protocols/s3/index.md) protocol.
For connections using [S3](../protocols/s3/index.md) protocol, make sure the bucket allows [ACLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html?icmpid=docs_amazons3_console) and doesn't block [public access](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html?icmpid=docs_amazons3_console).

`````{tabs}
````{group-tab} Cyberduck
Expand Down
4 changes: 2 additions & 2 deletions cyberduck/sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,5 +54,5 @@ No files are downloaded.

You have to manually restart the synchronization in the transfer window. If you want to automate things you will be better off with either

- [Cyberduck CLI](https://duck.sh/) which allows you to write a script and schedule ot with your preferred method such as `cron`.
- [Mountain Duck](https://mountainduck.io/) which allows you to mount the remote volume and synchronise files with any of your preferred tools such as `rsync`.
- [Cyberduck CLI](https://duck.sh/) which allows you to write a script and schedule it with your preferred method such as `cron`.
- [Mountain Duck](https://mountainduck.io/) which allows you to mount the remote volume and synchronise files with any of your preferred tools such as `rsync`.
2 changes: 1 addition & 1 deletion cyberduck/transfer.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ Enabling change of modification date slows down the transfer rate when uploading

A [hidden configuration option](preferences.md#hidden-configuration-options). Edit the available options (in bytes).

defaults write ch.sudo.cyberduck queue.bandwith.options 102400,1073741824
defaults write ch.sudo.cyberduck queue.bandwidth.options 102400,1073741824

### Badge Dock Icon

Expand Down
2 changes: 1 addition & 1 deletion cyberduck/upload.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,4 +89,4 @@ An option to upload with a temporary name and rename the file after the transfer

defaults write ch.sudo.cyberduck queue.upload.file.temporary.format "'{0}-{1}'"

where `{0}` is the original filename and `{1}` is a random UUID. The default setting uses a temprary filename of `filename-uuid`.
where `{0}` is the original filename and `{1}` is a random UUID. The default setting uses a temporary filename of `filename-uuid`.
36 changes: 36 additions & 0 deletions mountainduck/connect/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ Switching between [_Integrated_ mode](integrated.md) and [_Smart Synchronization

## Feature Comparison


| | **Online** | **Smart Synchronization** | **Integrated** |
|------------------------------------------|-----------------------------------------------------------------------|-------------------------------------------------------------------------------|-------------------------------------------------------------|
| **Offline Access** || ✔ Save files in cache on disk for access with no server connectivity ||
Expand All @@ -36,3 +37,38 @@ Switching between [_Integrated_ mode](integrated.md) and [_Smart Synchronization
| **[Recent Files](sync.md#recent-files)** || Available in the status bar (macOS) or taskbar (Windows) ||
| **[Lock Files](../locking.md)** | ✔︎ |||
| **[Share Files](../share.md)** ||||


## Quota support
Mountain Duck displays the overall quota present on the server as available disk space on the mounted volume.

| Protocol | Support |
|--------------------------| :---: |
| [Local Disk](../../protocols/index.md#local-disk) ||
| [SFTP](../../protocols/sftp/index.md#free-space-calculation-is-incorrect) ||
| [FTP](../../protocols/ftp.md) ||
| [WebDAV](../../protocols/webdav/index.md) ||
| [Google Drive](../../protocols/googledrive.md) ||
| [Google Cloud Storage](../../protocols/googlecloudstorage.md) ||
| [Microsoft OneDrive](../../protocols/onedrive.md#quota) ||
| [Microsoft Sharepoint](../../protocols/sharepoint.md#quota) ||
| [Files.com](../../protocols/files.com.md) ||
| [DRACOON](../../protocols/dracoon.md) ||
| [Backblaze B2](../../protocols/b2.md) ||
| [Box.com](../../protocols/box.md) ||
| [Dropbox](../../protocols/dropbox.md) ||
| [Nextcloud](../../protocols/webdav/nextcloud.md) ||
| [ownCloud](../../protocols/webdav/nextcloud.md) ||
| [S3](../../protocols/s3/index.md) ||
| [SMB](../../protocols/smb.md) ||
| [Windows Azure ](../../protocols/azure.md) ||
| [OpenStack Object Storage](../../protocols/openstack/index.md) ||

```{admonition} Limited Support
:class: attention
- **[Microsoft OneDrive](../../protocols/onedrive.md#quota)**: Quota is only supported when setting the *Path* in the bookmark configuration to a folder different from `/`.
- **[Microsoft SharePoint](../../protocols/sharepoint.md#quota)**: Quota is only supported when setting the *Path* in the bookmark configuration to a *Drives* folder in a SharePoint site folder.
```

Some protocols do not report the available quota. Finder and Windows Explorer will show exabyte values in *Online* connect mode and the available space within the synchronization cache location on your local disk in *Smart Synchronization* connect mode for the affected protocols.

6 changes: 3 additions & 3 deletions mountainduck/installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ No admin privileges for installation is required.
Mountain Duck is installed through the Mac App Store in `/Applications`. You can always reinstall Mountain Duck on any Mac you own from the Mac App Store in *→ App Store... → Purchased*.
**Login Item**<br/>
You can choose to open Mountain Duck when you log into your computer. Tha application will appear in *Login Items* of the *User & Groups* system preferences panel.
You can choose to open Mountain Duck when you log into your computer. The application will appear in *Login Items* of the *User & Groups* system preferences panel.
![Login Item](_images/Login_Item.png)
Expand All @@ -48,10 +48,10 @@ For **macOS Ventura and later**, the setting can be found in *System Settings
![Mountain Duck Windows Installer](_images/Mountain_Duck_Windows_Installer.png)
**MSI**<br/>
[Download](https://mountainduck.io/changelog/) MSI Installer for corporate environments. Requires prior installation of *Microsoft .NET Framework 4.5.2*.
[Download](https://mountainduck.io/changelog/) MSI Installer for corporate environments. Requires prior installation of *Microsoft .NET Framework 4.7.2*.
```{note}
Using the MSI Installer, you'll have to install the *MSI Package Shell Extension for 32bit applications* **and** *MSI Package Shell Extension for 64bit applications* separatly. Both packages are needed to enable the explorer extension.
Using the MSI Installer, you'll have to install the *MSI Package Shell Extension for 32bit applications* **and** *MSI Package Shell Extension for 64bit applications* separately. Both packages are needed to enable the explorer extension.
```
````
Expand Down
4 changes: 2 additions & 2 deletions mountainduck/interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ Use
````{group-tab} Windows
Enter the commmand `<path to Mountainduck.exe> %AppData%/Cyberduck/Bookmarks/<Bookmarkfile>` in *cmd.exe*.
Enter the command `<path to Mountainduck.exe> %AppData%/Cyberduck/Bookmarks/<Bookmarkfile>` in *cmd.exe*.
````
`````
Expand Down Expand Up @@ -201,7 +201,7 @@ You can unmount volumes using your command-line interface (CLI). Use `umount <bo
In *File Explorer* in "This PC" view or the sidebar on the left of the *File Explorer* window, open the context menu for your mounted drive and select *Disconnect*.
**Disconnect using command line**<br/>
You can unmount volumes using your commmand-line interface (CLI). Use `net use <drive letter>: /delete` in *cmd.exe*
You can unmount volumes using your command-line interface (CLI). Use `net use <drive letter>: /delete` in *cmd.exe*
````
Expand Down
10 changes: 5 additions & 5 deletions mountainduck/issues/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Choose *File Explorer → Folder Options*.
`````

## Temporary Files
When opening files with status _Online only_ or when connected with _Online_ connect mode, it may be required to temporarily cache contents depending on the read pattern of the application opening the file. Data ist stored in the temporary file location of the operating system and allows for faster access when repeatedly reading the file. Temporary files are deleted as soon as the application closes the file after reading, unless the option _Enable buffering_ checked in _Preferences → Sync_.
When opening files with status _Online only_ or when connected with _Online_ connect mode, it may be required to temporarily cache contents depending on the read pattern of the application opening the file. Data is stored in the temporary file location of the operating system and allows for faster access when repeatedly reading the file. Temporary files are deleted as soon as the application closes the file after reading, unless the option _Enable buffering_ checked in _Preferences → Sync_.

```{tip}
When enabled _Preferences → Sync → Enable buffering_ is enabled:
Expand Down Expand Up @@ -68,7 +68,7 @@ Files matching the following naming pattern are excluded from folder listings an
- `\` (backslash)
- `|` (vertical bar or pipe)
- `?` (question mark)
- `*` (asterik)
- `*` (asterisk)
````
`````
Expand Down Expand Up @@ -241,7 +241,7 @@ The Spotlight search does not work on mounted volumes with _Online_ or _Smart Sy
**Spotlight indexer**<br/>
To prevent the indexing through Spotlight the default mount location has been changed to `Volumes.noindex`. In case you **do** want the mount location to be indexed by Spotlight, use the *Terminal.app* command `mdutil -i on <mount location>`. Additionally, [mount location](../preferences.md#mount-location) to a directory without the extension `.noindex`.
```{attention}
Enabling Spotlight can cause high CPU and bandwith usage while indexing folders.
Enabling Spotlight can cause high CPU and bandwidth usage while indexing folders.
```
**Multiple Mountain Duck Finder Extensions Processes**<br/>
Expand All @@ -253,7 +253,7 @@ 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.
<del> **Additional `._*` Files Saved on Remote Volumes** </del> <br/>
<del> The `._*` files contain metadata about the files some applications write in additional to the file content. On macOS, this metadata can be stored alongside the file on the filesystem, but on remote volumes, with no metadata suppport, an auxiliary file is created to contain this information. You can delete metadata on files using `xattr -d <filename>`. </del>
<del> The `._*` files contain metadata about the files some applications write in additional to the file content. On macOS, this metadata can be stored alongside the file on the filesystem, but on remote volumes, with no metadata support, an auxiliary file is created to contain this information. You can delete metadata on files using `xattr -d <filename>`. </del>
As of version [2.1](https://mountainduck.io/changelog/), extended attributes are only saved in a temporary location and not stored on the mounted remote volume. If you want to revert to saving extended attributes to the server, enter in a *Terminal.app* window:
Expand All @@ -275,7 +275,7 @@ If you get this error message you most likely haven't restarted your system afte
**Missing Files in Windows Explorer**<br/>
Windows has a limitation on the maximum path length. It might happen that Mountain Duck exceeds this maximum for long file names when trying to create placeholders in the local cache. If Mountain Duck is unable to create a placeholder file for a remote file it will not appear in the Windows Explorer listing.
To work around this Windows limitaion you can enable long path support in Windows 10 as of version 1607.
To work around this Windows limitation you can enable long path support in Windows 10 as of version 1607.
1. Open the *Local Group Policy editor* (search for *Edit Group Policy*)
2. Navigate to *Local Computer Policy → Computer Configuration → Administrative Templates → System → Filesystem*
Expand Down
4 changes: 2 additions & 2 deletions mountainduck/preferences.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Files selected to always keep offline are never automatically removed from the c
By default, files are kept in cache for 30 days and the cache is limited to a maximum size of 5GiB.

```{attention}
The settings apply separately for each bookmark. The synchronization cache gets cleared based on the choosen cache limit after Mountain Duck is started and every 24h as long as Mountain Duck is running.
The settings apply separately for each bookmark. The synchronization cache gets cleared based on the chosen cache limit after Mountain Duck is started and every 24h as long as Mountain Duck is running.
```

```{note}
Expand Down Expand Up @@ -139,7 +139,7 @@ The connection profiles for [default protocols](../protocols/index.md) are alway
Reconnect after restarting the computer. If you choose *Enable Login Item* and *Save Workspace* in *Preferences → General* and do not manually eject the volume prior to reboot it will reconnect after login.

## Cryptomator
Choose wheather or not your [Cryptomator vaults](../cryptomator/index.md) should be auto detected and unlocked while browsing the parent folder or not by using the *Auto detect and open vault in browser* option.
Choose whether or not your [Cryptomator vaults](../cryptomator/index.md) should be auto detected and unlocked while browsing the parent folder or not by using the *Auto detect and open vault in browser* option.

```{note}
Without saving the vaults passwords using keychain, you will receive passwords prompts for the vaults after reconnecting to the server or cloud storage.
Expand Down
2 changes: 1 addition & 1 deletion protocols/box.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Download [Mountain Duck](https://mountainduck.io/) as an alternative to *Box Dri
## Connecting

Use the default *Box* connection profile to connect to your server using the Box API. This allows to have Multi-Factor Authentication enabled for your accout.
Use the default *Box* connection profile to connect to your server using the Box API. This allows to have Multi-Factor Authentication enabled for your account.

### Alternate Connection Options

Expand Down
Loading

0 comments on commit 909c740

Please sign in to comment.