-
Notifications
You must be signed in to change notification settings - Fork 68
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Mountain Duck 5 #279
Draft
dkocher
wants to merge
31
commits into
main
Choose a base branch
from
mountainduck/5
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Mountain Duck 5 #279
Changes from all commits
Commits
Show all changes
31 commits
Select commit
Hold shift + click to select a range
5d424fc
Spotlight is supported for _Integrated_ connect mode.
dkocher 7371244
Dragging files will move by default in Finder in _Integrated_ connect…
dkocher 34d98a4
Custom mount not supported in _Integrated_ connect mode.
dkocher 57007e7
Custom cache location not supported in _Integrated_ connect mode.
dkocher 3ae0782
Add note about OS cache management.
dkocher 1cd778a
Pseudo locking not supported.
dkocher e11f228
Add _Integrated_ mode.
dkocher f90e04b
Add but always in `~/Library/CloudStorage`
dkocher 12062ca
Add additional icons shown in Finder with file provider.
dkocher 37b7375
Add note that opening files from history in applications may fail bec…
dkocher 0f703ba
New system requirements.
dkocher 3fc037e
Add page for _Integrated_ mode.
dkocher 360c656
Invert images.
dkocher c799cba
Add Integrated connect mode to table.
dkocher 7fbb05f
Remove not not applicable.
dkocher f927020
Add links to pages.
dkocher 1105b50
Change to headings.
dkocher d86453d
Revise sync status documentation with additional file provider icons.
dkocher 3968ae1
Optional Driver Installation
dkocher 758b2dc
Review
Cassie205 a6d7a43
Add Limitations
Cassie205 e9649a6
Issue #458
Cassie205 745d2e4
Add "Network Volume"
dkocher 2461070
QuickLook requires offline file.
dkocher 0f434f8
Add note about OS cache management.
dkocher 351cd73
Review
Cassie205 073bee5
Add info for custom versioning Mountain Duck
Cassie205 fe68980
Review
dkocher 2f3c49a
Review
dkocher caf03f6
Formatting
dkocher 7eda3bf
Checkmark for indexer.
dkocher File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,142 @@ | ||
Integrated | ||
==== | ||
|
||
:::{toctree} | ||
:hidden: | ||
:titlesonly: | ||
::: | ||
|
||
:::{image} ../_images/Disk_Syncing.png | ||
:alt: Disk Syncing | ||
:width: 200px | ||
::: | ||
|
||
> Local storage is managed by the operating system. The mount is not seen as a remote volume by applications but as a regular folder on disk. This option uses the tightly integrated _File Provider_ (macOS) and _Cloud Files_ (Windows) APIs. Directories can be browsed when offline and files opened are made available for later offline access. You can choose to make selected files and folders available for offline use. Changes to files are uploaded in the background as soon as a connection is available. | ||
|
||
:::{tip} | ||
You can access files in _Integrated_ connect mode without being always connected the server or cloud storage. | ||
::: | ||
|
||
|
||
## Status of Files | ||
|
||
Files and folders on a mounted volume have a status icon overlay in _File Explorer_ (Windows) and _Finder_ (macOS). | ||
|
||
### ![](../_images/overlay_uptodate.png) Up to Date | ||
The file or the contents of a directory has been opened and downloaded to your computer and therefore currently synced with the server or cloud storage. The file takes disk space on your computer and can always be opened even when no connection to the server or cloud storage is possible. New files in a directory on the remote server will appear as *Online Only* and are not downloaded automatically. Files copied to a volume are kept cached by default. | ||
|
||
:::{note} | ||
Files can be purged automatically from the cache when not accessed or the cache size limit is exceeded. Refer to [Cache Limitations](../preferences.md#cache-limitations). | ||
::: | ||
|
||
### ![](../_images/overlay_infinite.png) Online Only | ||
The file can only be opened when a connection to the server or cloud storage can be made. The file does not take any space on your computer. The file is downloaded on demand when you open it. | ||
|
||
:::{admonition} macOS only | ||
:class: note | ||
:::{image} ../_images/File_Provider_Online_Only.png | ||
:alt: File Provider Icon | ||
:width: 24px | ||
:align: left | ||
::: | ||
Click this additional icon displayed next to the filename in Finder.app to request the download of the file. | ||
::: | ||
|
||
### ![](../_images/overlay_sync.png) In Sync | ||
The file or folder is selected to be synced with the server or cloud storage to always keep offline. The file takes disk space on your computer and can always be opened even when no connection to the server or cloud storage is possible. New files in a directory on the remote server will be downloaded automatically. | ||
|
||
:::{tip} | ||
Files explicitly selected to keep offline are **not** automatically purged. Refer to [Cache Limitations](../preferences.md#cache-limitations). | ||
::: | ||
|
||
### ![](../_images/overlay_syncing.png) Sync in Progress | ||
The file or folder is currently syncing with the server or cloud storage. Check the menu with the sync status for current download or upload progress. | ||
|
||
### ![](../_images/overlay_error.png) Sync Error | ||
Files that failed to sync after changes. You are missing permission to write to the file or another problem occurred. Please contact your web hosting service provider for assistance. To resolve the error, move the file to your local disk, and reload the directory. Refer to [Sync Conflicts](sync.md#sync-conflicts) for possible error scenarios. You can try to repeat the failed transfer by selecting *Mountain Duck → Retry* in the [context menu](sync.md#context-menu-options). If a sync error cannot be solved using *Mountain Duck → Retry* because the server does not allow the operation (i.e. due to a permission issue), you can resolve the error state on the file or folder by | ||
|
||
- Move the file or folder to another location on the volume | ||
- Delete the file or folder | ||
- To upload files to a target directory no longer existing on the server, you have to move the files to a location found on the server. | ||
|
||
:::{admonition} macOS only | ||
:class: note | ||
:::{image} ../_images/File_Provider_Ignored.png | ||
:alt: File Provider Icon | ||
:width: 24px | ||
:align: left | ||
::: | ||
This additional icon displayed next to the filename in Finder.app indicates the file is not synced. | ||
::: | ||
|
||
### ![](../_images/overlay-pause.png) Sync Paused | ||
The file or folder is pending syncing with the server but synchronization has been [paused](sync.md#pause-sync). | ||
|
||
### ![](../_images/overlay_ignored.png) Ignored | ||
The file or folder is only saved in local cache and not synced. New _Folders_, empty files and files matching [excluded filename patterns](../issues/index.md#filenames) are not uploaded. Folders are uploaded after being renamed. | ||
|
||
:::{admonition} macOS only | ||
:class: note | ||
:::{image} ../_images/File_Provider_Error.png | ||
:alt: File Provider Icon | ||
:width: 24px | ||
:align: left | ||
::: | ||
This additional icon displayed next to the filename in Finder.app indicates a sync error for the file. | ||
::: | ||
|
||
|
||
## Sync Progress | ||
|
||
Changes to files are uploaded in the background as soon as a connection is available. Progress is reported by animating the status bar icon and a menu item titled *Sync in Progress*. | ||
|
||
:::{admonition} macOS only | ||
:class: tip | ||
Progress is shown when downloading or uploading a file with a progress bar over the file icon or circular progress indicator adjacent the filename. | ||
::: | ||
|
||
### Keep Offline | ||
|
||
Choose *Mountain Duck → Keep Offline on Local Disk* to make files and folders available offline. The status of the file will change to *In Sync*. The action is recursive for all contained files when a folder is selected and applies to new files found on the remote storage. | ||
|
||
:::{admonition} macOS only | ||
:class: tip | ||
|
||
:::{image} ../_images/File_Provider_Online_Only.png | ||
:alt: File Provider Icon | ||
:width: 24px | ||
:align: left | ||
::: | ||
_Download Now_ when using _Integrated_ connect mode downloads the file but allows it to be removed from cache on low disk space. | ||
::: | ||
|
||
|
||
### Delete on Local Disk | ||
|
||
Choose *Mountain Duck → Delete on Local Disk* to delete the offline copy. The status of the file will change to *Online Only*. The action is recursive for all contained files when a folder is selected and allows you to quickly free up space used in the cache on your local disk. | ||
|
||
:::{admonition} macOS only | ||
:class: tip | ||
|
||
Choose _Remove Download_ instead when using _Integrated_ connect mode. | ||
::: | ||
|
||
## Cache | ||
|
||
There are different ways to delete the sync cache: | ||
* Delete the bookmark with connection mode set to *Smart Synchronization* or *Integrated* | ||
* Use the deletion prompt when switching the connect mode between *Integrated* and *Smart Synchronization* | ||
:::{image} ../_images/Prompt_Delete_Cache.png | ||
:alt: Delete Cache Prompt | ||
:width: 400px | ||
::: | ||
* Use the delete option in Finder.app once the bookmark is disconnected. You will be prompt to confirm the deletion as it can lead to file loss if some changes aren't synchronized to the server | ||
:::{image} ../_images/Finder_Option_Delete_Cache.png | ||
:alt: Delete Cache Option | ||
:width: 800px | ||
::: | ||
|
||
## Limitations | ||
|
||
- Custom mount locations are not honoured using the Integrated mode. | ||
- The *Pseudo File locking* available in the Mountain Duck preferences *Connection* tab is not supported in *Integrated* mode. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Applies to Windows for Downloads. Research required to check whether uploads could benefit here too.