Add drive client for macOS (#73)

* Add drive client for macOS * Update drive client * Update mkdocs.yml Improve wording --------- Co-authored-by: heran yang <[email protected]> Co-authored-by: Jiaqiang Xu <[email protected]>
haiwen · Nov 22, 2023 · 1407ea8 · 1407ea8
1 parent f9b244e
commit 1407ea8
Show file tree

Hide file tree

Showing 13 changed files with 117 additions and 10 deletions.
diff --git a/en/drive_client/drive_client_for_macos.md b/en/drive_client/drive_client_for_macos.md
@@ -0,0 +1,78 @@
+# SeaDrive for macOS and later versions
+
+If you are using macOS 12.1 or later versions, it's recommended to use SeaDrive 3.0.
+
+Please download SeaDrive 2.0 if your macOS is below 12.1. All SeaDrive clients require macOS 10.14 or higher to install and run.
+
+SeaDrive 3.0 is implemented as a Finder extension, which is redesigned with deeper integration to macOS. We recommend macOS users to upgrade to SeaDrive 3.0 for more native virtual drive experience.
+
+## Install and Access the Virtual Drive
+
+You can download SeaDrive 3.0 from [official Seafile website](https://www.seafile.com/en/download/). After installation and logging into your Seafile account, SeaDrive creates a SeaDrive entry in the Finder. Upon clicking the entry, SeaDrive extension will be activated. After that you should see category folders such as "My Libraries" in the SeaDrive folder.
+
+![seadrive-3.0](imgs/seadrive-3.0.png)
+
+## Accessing Files in the Virtual Drive
+
+Libraries are grouped into 4 categories in the virtual drive: My Libraries, Shared with me, Shared with groups and Shared with all.
+
+Files in the virtual drive are created as "placeholders" in the local file system. They may be in 2 states:
+
+* **Placeholder file**: An empty representation of the file and can only be opened when there is network connection.
+* **Full file**: The file has been downloaded and saved locally. Download is automatic when a placeholder file is opened for the first time. These files are available whenever you open SeaDrive regardless to network connections. The operating system may decide to clear a full file when more disk space is needed.
+
+![seadrive-mac-file-icons](imgs/seadrive-mac-file-icons.png)
+
+You can control which files or folder are cached locally. Choose "Remove Download" when you want to clean the cache for a file or folder.
+
+![seadrive-mac-cache-control](imgs/seadrive-mac-cache-control.png)
+
+In SeaDrive 3.0, full files are automatically kept in sync with the server.
+
+## File Download and Control
+
+Whenever you open a placeholder file or click on the cloud icon on the file, the operating system will automatically start to download it. If the file may take some time to download, the cloud icon will change to a progress icon to show the download progress.
+
+## Cache Management
+
+You can set the cache size limit and clean interval in the settings.
+
+When the cache size exceeds the limit, SeaDrive will automatically free up space based on files' last modification time. Older files will be cleaned up first. This process continues until the cache size is reduced to below 70% of the specified limit.
+
+![seadrive-mac-cache-management](imgs/seadrive-mac-cache-management.png)
+
+## Account Management
+
+In SeaDrive 3.0, you can log into multiple accounts across different servers, providing access to files from all linked accounts within the Finder entry.
+
+![seadrive-mac-account-management](imgs/seadrive-mac-account-management.png)
+
+You can log out of the account by selecting 'Delete' in the account management, at this time it will log out of the account and keep the local files that have been cached.
+
+![seadrive-mac-account-delete](imgs/seadrive-mac-account-delete.png)
+
+## FAQ
+
+### Why is SeaDrive extension not started?
+
+When the tray icon keeps showing a red x, this is due to the SeaDrive extension not being started, you need to start the SeaDrive extension by clicking on the SeaDrive entry in the Finder.
+
+### Can I create, delete, rename libraries?
+
+Yes. When you create, delete or rename library folders in the virtual drive, the operation will be reflected on the server. You can only create, delete, rename libraries under the "My Libraries" category. Creating, deleting or renaming libraries in other categories will be ignored.
+
+### Can I create files or folders outside of a library folder?
+
+No. Files created outside of a library folder will be deleted and **NOT **synced to the server. A new folder under the "My Libraries" folder will be handled as a new library.
+
+### Can I access encrypted libraries?
+
+Yes. By default, encrypted libraries are not synced, but shown in the virtual drive. You need to manually choose which encrypted libraries to sync and enter the password. Just right click on the SeaDrive icon in the system tray area and choose "Show encrypted libraries". A window will show up and you can choose to sync or unsync an encrypted library.
+
+### Is it compatible to SeaDrive 1.0 and SeaDrive 2.0?
+
+No. SeaDrive 3.0 does not require a system extension to be installed, SeaDrive 1.0 and SeaDrive 2.0 do.
+
+### How do I clean the cache?
+
+Since seadrive will automatically free up space when the cache size exceeds the limit, you don't need to clean the cache.
diff --git a/...client/drive_client_2.0_for_windows_10.md → en/drive_client/drive_client_for_win10.md b/...client/drive_client_2.0_for_windows_10.md → en/drive_client/drive_client_for_win10.md
@@ -1,10 +1,12 @@
-# SeaDrive 2.0 for Windows 10
+# SeaDrive for Windows 10 and later versions
 
-SeaDrive 2.0 (and future versions) is redesigned with deeper integration to Windows 10 operating system. It supports Windows 10 1709 version (2017 Fall Update for Windows 10) and later versions. We recommend Windows 10 users to upgrade to SeaDrive 2.0 for more native virtual drive experience.
+If you are using windows 10 or later versions, it's recommended to use SeaDrive 3.0.
+
+SeaDrive 3.0 (and future versions) is redesigned with deeper integration to Windows 10 operating system. It supports Windows 10 1709 version (2017 Fall Update for Windows 10) and later versions. We recommend Windows 10 users to upgrade to SeaDrive 3.0 for more native virtual drive experience.
 
 ## Install and Access the Virtual Drive
 
-You can download SeaDrive 2.0 from [official Seafile website](https://www.seafile.com/en/download/). After installation and logging into your Seafile account, SeaDrive will start downloading library and file lists from the server (just as in SeaDrive 1.0.x). It may take some time, depending on the number of files available in your seafile account. The download is progressive, so in the mean time you can already access some files in the virtual drive.
+You can download SeaDrive 3.0 from [official Seafile website](https://www.seafile.com/en/download/). After installation and logging into your Seafile account, SeaDrive will start downloading library and file lists from the server (just as in SeaDrive 1.0.x). It may take some time, depending on the number of files available in your seafile account. The download is progressive, so in the mean time you can already access some files in the virtual drive.
 
 To access the virtual drive, just open Windows file explorer. There is a "seadrive" node in the navigation pane of Windows file explorer.
 
@@ -28,14 +30,34 @@ You can control which files or folder are cached locally. This can be changed fr
 
 ![seadrive-cache-control](imgs/seadrive-cache-control.png)
 
-In SeaDrive 1.0, cached files are not automatically updated when they're updated on the server. In SeaDrive 2.0, full and pinned files are automatically kept in sync with the server.
+In SeaDrive 1.0, cached files are not automatically updated when they're updated on the server. In SeaDrive 3.0, full and pinned files are automatically kept in sync with the server.
 
 ## File Download and Control
 
 Whenever you open a placeholder file, the operating system will automatically start to download it. If the file may take some time to download, there will be a progress bar shown up in file explorer and you may cancel the download.
 
 Sometimes a background application may try to download a file in the virtual drive (such as an Anti-Virus software). You will be notified by the operating system about this and you may choose to cancel the download or disallow the application from automatically downloading files in the future.
 
+## Cache Management
+
+You can customize the cache directory and set the cache size limit and clean interval in the settings.
+
+When the cache size exceeds the limit, SeaDrive will automatically free up space based on files' last modification time. Older files will be cleaned up first. This process continues until the cache size is reduced to below 70% of the specified limit.
+
+![seadrive-cache-management](imgs/seadrive-cache-management.png)
+
+## Account Management
+
+In SeaDrive 3.0, you can log into multiple accounts across different servers, providing access to files from all linked accounts within the cache directory.
+
+![seadrive-account-management](imgs/seadrive-account-management.png)
+
+You can log out of the account by selecting 'Delete' in the account management, at this time it will log out of the account and keep the local files that have been cached. 
+
+Some special sync errors, such as invalid placeholders, local metadata corruption, can be fixed by re-syncing the account.
+
+![seadrive-account-resync](imgs/seadrive-account-resync.png)
+
 ## FAQ
 
 ### Can I create, delete, rename libraries?
@@ -52,15 +74,19 @@ Yes. By default, encrypted libraries are not synced and shown in the virtual dri
 
 ### Is it compatible to SeaDrive 1.0?
 
-SeaDrive 2.0 will use any existing accounts and their metadata (stored under C:\\users\\username\\seadrive\\ folder). But it will not use the cached files from SeaDrive 1.0. So any locally cached files in 1.0 version will not be accessible in 2.0 version. You can start SeaDrive 1.0 again to upload the files to server or copy them out.
+SeaDrive 3.0 will use any existing accounts and their metadata (stored under C:\\users\\username\\seadrive\\ folder). But it will not use the cached files from SeaDrive 1.0. So any locally cached files in 1.0 version will not be accessible in 3.0 version. You can start SeaDrive 1.0 again to upload the files to server or copy them out.
+
+### Is it compatible to SeaDrive 2.0?
+
+Yes. SeaDrive 3.0 is fully compatible to SeaDrive 2.0.
 
 ### How do I clean the cache?
 
-You can manually choose which folders or files to be cached locally. If you find a folder consumes too much space, just choose to "Free up space" on that folder and all cached files in that folder will be cleaned. There is no need to set cache cleaning time and cache size limit as in SeaDrive 1.0. Because placeholders are just normal files created on your local disk, your cache size is only limited by the available disk space on your computer.
+Since seadrive will automatically free up space when the cache size exceeds the limit, you don't need to clean the cache. You can also choose to "Free up space" on a folder or a flie and the cached files will be cleaned.
 
 ### How to remove left-over SeaDrive shortcuts in Windows Explorer?
 
-The "SeaDrive" shortcut in Windows Explorer won't disappear after you exit SeaDrive program or switch Seafile accounts in SeaDrive. This is an intended behavior. You don't need to remove them if you still need to access the account later.
+In general, when an account is deleted, the left-over SeaDrive shortcut associated with the account is also deleted.
 
 In some corner cases, the "SeaDrvie" shortcut will be left-over in Windows Explorer and you want to remove it.
 

diff --git a/en/drive_client/using_drive_client.md → en/drive_client/drive_client_for_win7.md b/en/drive_client/using_drive_client.md → en/drive_client/drive_client_for_win7.md
@@ -1,4 +1,6 @@
-# Using Seafile Drive Client
+# SeaDrive for Windows 7/8
+
+If you are using windows 7 or windows 8 then you need to download SeaDrive 1.0.
 
 After installing a drive client with the instructions on the [download page](https://www.seafile.com/en/download/), you can start it by double clicking the "SeaDrive" app icon on your desktop.
 

diff --git a/en/drive_client/imgs/seadrive-3.0.png b/en/drive_client/imgs/seadrive-3.0.png
diff --git a/en/drive_client/imgs/seadrive-account-management.png b/en/drive_client/imgs/seadrive-account-management.png
diff --git a/en/drive_client/imgs/seadrive-account-resync.png b/en/drive_client/imgs/seadrive-account-resync.png
diff --git a/en/drive_client/imgs/seadrive-cache-management.png b/en/drive_client/imgs/seadrive-cache-management.png
diff --git a/en/drive_client/imgs/seadrive-mac-account-delete.png b/en/drive_client/imgs/seadrive-mac-account-delete.png
diff --git a/en/drive_client/imgs/seadrive-mac-account-management.png b/en/drive_client/imgs/seadrive-mac-account-management.png
diff --git a/en/drive_client/imgs/seadrive-mac-cache-control.png b/en/drive_client/imgs/seadrive-mac-cache-control.png
diff --git a/en/drive_client/imgs/seadrive-mac-cache-management.png b/en/drive_client/imgs/seadrive-mac-cache-management.png
diff --git a/en/drive_client/imgs/seadrive-mac-file-icons.png b/en/drive_client/imgs/seadrive-mac-file-icons.png
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -78,8 +78,9 @@ nav:
     - Install On Linux: syncing_client/install_linux_client.md
     - Seafile Client for a Cli server: syncing_client/linux-cli.md
   - Drive Client:
-    - Using Seafile Drive Client: drive_client/using_drive_client.md
-    - Using drive client 2.0 on Windows: drive_client/drive_client_2.0_for_windows_10.md
+    - Drive Client for Windows 7/8: drive_client/drive_client_for_win7.md
+    - Drive Client for Windows 10 or later: drive_client/drive_client_for_win10.md
+    - Drive Client for macOS: drive_client/drive_client_for_macos.md
     - Drive Client for Linux: drive_client/drive_client_for_linux.md
   - Security and Encryption:
     - How to use encrypted libraries: security_and_encryption/use_encrypted_libraries.md