From 5186dcb967a51e219531fa019f2d95f8a8bbf1b6 Mon Sep 17 00:00:00 2001 From: fyears <1142836+fyears@users.noreply.github.com> Date: Sun, 9 Jun 2024 23:05:08 +0800 Subject: [PATCH] add tutorials for box and pcloud --- README.md | 12 ++++- docs/remote_services/box/README.md | 34 +++++++++++++ docs/remote_services/pcloud/README.md | 40 +++++++++++++++ docs/services_connectable_or_not.md | 72 ++++++++++++++------------- 4 files changed, 123 insertions(+), 35 deletions(-) create mode 100644 docs/remote_services/box/README.md create mode 100644 docs/remote_services/pcloud/README.md diff --git a/README.md b/README.md index 4df91fd..1e9282a 100644 --- a/README.md +++ b/README.md @@ -20,9 +20,11 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find - Amazon S3 or S3-compatible (Cloudflare R2 / BackBlaze B2 / MinIO / ...) - Dropbox - OneDrive for personal - - Webdav + - Webdav (NextCloud / InfiniCloud / Synology webdav server / ...) - Webdis - Google Drive (PRO feature) + - Box (PRO feature) + - pCloud (PRO feature) - [Here](./docs/services_connectable_or_not.md) shows more connectable (or not-connectable) services in details. - **Obsidian Mobile supported.** Vaults can be synced across mobile and desktop devices with the cloud service as the "broker". - **[End-to-end encryption](./docs/encryption/README.md) supported.** Files would be encrypted using openssl format before being sent to the cloud **if** user specify a password. @@ -124,6 +126,14 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a PRO (paid) feature "sync with Google Drive" allows users to to sync with Google Drive. Tutorials and limitations are documented [here](./docs/remote_services/googledrive/README.md). +### Box (PRO feature) + +PRO (paid) feature "sync with Box" allows users to to sync with Box. Tutorials and limitations are documented [here](./docs/remote_services/box/README.md). + +### pCloud (PRO feature) + +PRO (paid) feature "sync with pCloud" allows users to to sync with pCloud (using its native API instead of webdav). Tutorials and limitations are documented [here](./docs/remote_services/pcloud/README.md). + ## Scheduled Auto Sync - You can configure auto syncing every N minutes in settings. diff --git a/docs/remote_services/box/README.md b/docs/remote_services/box/README.md new file mode 100644 index 0000000..99bf33e --- /dev/null +++ b/docs/remote_services/box/README.md @@ -0,0 +1,34 @@ +# Box (PRO) + +# Links + + + +# Intro + +* It's a PRO feature of Remotely Save plugin. +* **This plugin is NOT an official Box product, and just uses Box's public api.** + +# Steps + +## Steps of Remotely Save subscription + +1. Please sign up and sign in an online account, connect your plugin to your online account firstly. See [the PRO tutorial](../../pro/README.md) firstly. +2. Subscribe to "sync with Box" feature online. +3. Go back to your Remotely Save plugin inside Obsidian, click "Check again" button in PRO settings. So that the plugin knows some features are enabled. In this case, sync with Box should be detected. + +## Steps of Connecting to your Box + +After you enabled the PRO feature in your Remotely Save plugin, you can connect to your Box account now. + +1. In Remotely Save settings, change your sync service to Box. +2. Click Auth, visit the link, go to Box website to start. +3. Follow the instruction on Box, and allow Remotely Save to connect. +4. You will be redirected back to Remotely Save plugin. +5. A notice will tell you that you've connected or not. +6. Sync! The plugin will create a vault folder in the root of your Box and upload notes into that folder. +7. **Read the caveats below.** + +# The caveats + +* As of June 2024, this feature is in beta stage. **Back up your vault before using this feature.** diff --git a/docs/remote_services/pcloud/README.md b/docs/remote_services/pcloud/README.md new file mode 100644 index 0000000..89ca313 --- /dev/null +++ b/docs/remote_services/pcloud/README.md @@ -0,0 +1,40 @@ +# pCloud (PRO) + +# Links + + + +# Intro + +* It's a PRO feature of Remotely Save plugin. +* **This plugin is NOT an official pCloud product, and just uses pCloud's public api.** + +# Steps + +## Steps of Remotely Save subscription + +1. Please sign up and sign in an online account, connect your plugin to your online account firstly. See [the PRO tutorial](../../pro/README.md) firstly. +2. Subscribe to "sync with pCloud" feature online. +3. Go back to your Remotely Save plugin inside Obsidian, click "Check again" button in PRO settings. So that the plugin knows some features are enabled. In this case, sync with pCloud should be detected. + +## Steps of Connecting to your pCloud + +After you enabled the PRO feature in your Remotely Save plugin, you can connect to your pCloud account now. + +1. In Remotely Save settings, change your sync service to pCloud. +2. Click Auth, visit the link, go to pCloud website to start. +3. Follow the instruction on pCloud, and allow Remotely Save to connect. +4. You will be redirected back to Remotely Save plugin. +5. A notice will tell you that you've connected or not. +6. Sync! The plugin will create a vault folder in the root of your pCloud and upload notes into that folder. +7. **Read the caveats below.** + +# The caveats + +* As of June 2024, this feature is in beta stage. **Back up your vault before using this feature.** +* pCloud's API seems to not allow uploading empty files. You can choose to skip them or raise errors in Remotely Save plugin's settings. + +# Why not use webdav? + +1. pCloud only provides webdav for Premium. If you are a Premium user, you can still use pCloud webdav with Remotely Save. +2. The Remotely Save PRO feture "sync with pCloud" is developed using pCloud's native API, instead of webdav interface. It brings benefits such that the last modified time can be preserved. diff --git a/docs/services_connectable_or_not.md b/docs/services_connectable_or_not.md index bcf541e..49676c5 100644 --- a/docs/services_connectable_or_not.md +++ b/docs/services_connectable_or_not.md @@ -6,37 +6,41 @@ The plugin works under the browser environment in Obsidian, so CORS is an issue. The list is for information purposes only. -| Service | Connectable | by S3 | by WebDAV | by other protocol | can bypass CORS issue in latest Obsidian | need CORS config in old Obsidian | -| ------------------------------------------------------------------------------------- | ----------- | ----- | --------- | ---------------------------------------------------------------- | ---------------------------------------- | ------------------------------------------------ | -| Amazon S3 | Yes | Yes | | | Yes | [CORS config needed.](./s3_cors_configure.md) | -| Tencent Cloud - Cloud Object Storage (COS) 腾讯云对象存储 | Yes | Yes | | | Yes | CORS config needed. | -| Alibaba Cloud - Object Storage Service 阿里云对象存储 | Yes | Yes | | | Yes | CORS config needed. | -| Backblaze B2 Cloud Storage | Yes | Yes | | | Yes | Its CORS rules doesn't allow no-http(s) origins. | -| [Wasabi](https://wasabi.com) | ? | ? | | | | | -| [filebase](https://filebase.com/) | Yes | Yes | | | Yes | CORS config needed. | -| QingStor 青云 | ? | ? | | | | | -| [MinIO](https://min.io/) | ? | ? | | | | | -| [WsgiDAV](https://github.com/mar10/wsgidav) | Yes | | Yes | | Yes | CORS rules can be set. | -| [Nginx `ngx_http_dav_module`](http://nginx.org/en/docs/http/ngx_http_dav_module.html) | Yes? | | Yes? | | Yes? | ? | -| NextCloud | Yes | | Yes | | Yes? | No CORS config by default. | -| OwnCloud | Yes? | | Yes? | | Yes? | No CORS config by default. | -| Seafile | Yes | | Yes | | Yes? | No CORS config by default. | -| `rclone serve webdav` | Yes | | Yes | | Yes | No CORS support. | -| [Nutstore 坚果云](https://www.jianguoyun.com/) | Yes | | Yes | | Yes | No CORS support. | -| [TeraCLOUD](https://teracloud.jp/en/) | Yes | | Yes | | Yes | No CORS support. | -| Dropbox | Yes | | | Yes | | | -| OneDrive for personal | Yes | | | Yes | | | -| OneDrive for Business | Yes | | | ? | | | -| Google Drive | In the plan | | | ? | | | -| [Box](https://www.box.com/) | ? | | | May be possible but needs further development. | | | -| Google Cloud Storage | ? | | | May be possible but needs further development. | | | -| Microsoft Azure Blob Storage | ? | | | May be possible but needs further development. | | | -| [OpenStack Storage (Swift)](https://github.com/openstack/swift) | ? | | | May be possible but needs further development. | | | -| https://put.io/ | ? | | | ? | | | -| Yandex Disk | ? | | | ? | | | -| FTP / FTPS | Never | | | Technically never possible to be implemented. | | | -| SFTP | Never | | | Technically never possible to be implemented. | | | -| Jottacloud | No | | | No. It seems that no open api is available. | | | -| Mega | Never | | | No. No js api is available. | | | -| Git | Never | | | No. Technically very hard, if not impossible, to be implemented. | | | -| | | | | | | | + +| Service | Connectable | by S3 | by WebDAV | by other protocol | +| ------ | ------ | ------ | ------ | ------ | +| Amazon S3 | Yes | Yes | | | +| Tencent Cloud - Cloud Object Storage (COS) 腾讯云对象存储 | Yes | Yes | | | +| Alibaba Cloud - Object Storage Service 阿里云对象存储 | Yes | Yes | | | +| Backblaze B2 Cloud Storage | Yes | Yes | | | +| [Wasabi](https://wasabi.com) | ? | ? | | | +| [filebase](https://filebase.com/) | Yes | Yes | | | +| QingStor 青云 | ? | ? | | | +| [MinIO](https://min.io/) | Yes | Yes | | | +| [WsgiDAV](https://github.com/mar10/wsgidav) | Yes | | Yes | | +| [Nginx `ngx_http_dav_module`](http://nginx.org/en/docs/http/ngx_http_dav_module.html) | Yes | | Yes | | +| NextCloud | Yes | | Yes | | +| OwnCloud | Yes? | | Yes? | | +| Seafile | Yes | | Yes | | +| `rclone serve webdav` | Yes | | Yes | | +| [Nutstore 坚果云](https://www.jianguoyun.com/) | Yes (partially) | | Yes (partially) | | +| [TeraCLOUD](https://teracloud.jp/en/) | Yes | | Yes | | +| Seafile | ? | | ? | ? | +| Dropbox | Yes | | | Yes | +| OneDrive for personal | Yes | | | Yes | +| OneDrive for Business | Yes | | | ? | +| Google Drive | Yes (with limitations) (PRO) | | | Yes (with limitations) (PRO) | +| [Box](https://www.box.com/) | Yes (PRO) | | | Yes (PRO) | +| [pCloud](https://www.pcloud.com/) | Yes (PRO) | | Yes | Yes (PRO) | +| Google Cloud Storage | ? | | | May be possible but needs further development. | +| Microsoft Azure Blob Storage | ? | | | May be possible but needs further development. | +| [OpenStack Storage (Swift)](https://github.com/openstack/swift) | ? | | | May be possible but needs further development. | +| | ? | | | ? | +| Yandex Disk | Yes (PRO) | | Yes | Yes (PRO) | +| FTP / FTPS | Never | | | Technically never possible to be implemented. | +| SFTP | Never | | | Technically never possible to be implemented. | +| Jottacloud | No | | | No. It seems that no open api is available. | +| Mega | Never | | | No. No js api is available. | +| Git | Never | | | No. Technically very hard, if not impossible, to be implemented. | +| [Koofr](https://koofr.eu/) | ? | | ? | ? | +| [Blomp](https://www.blomp.com/) | ? | | | May be possible but needs further development. |