google drive is usable now

2024-06-02 23:37:53 +08:00
parent 2ace90155c
commit e116bb1deb
35 changed files with 1595 additions and 24 deletions
@@ -0,0 +1,53 @@
+# PRO Features
+
+From version 0.5.x, Remotely Save introduces PRO (paid) features. Users need to subscribe to (pay) them to use them.
+
+**If you are using basic features only, you don't need an online account, and you don't need to pay for the plugin.**
+
+# Links
+
+* Remotely Save official website: <https://remotelysave.com>
+* Sign up / Sign in: <https://remotelysave.com/user/signupin>
+* User profile: <https://remotelysave.com/user/profile>
+
+# Disclaimer
+
+It's different from, and NOT affiliated with Obsidian account.
+
+# Steps
+
+## Steps of signing up and signing in
+
+1. Go to the website, sign up and sign in. You can directly visit <https://remotelysave.com/user/signupin> or click the link in Remotely Save plugin setting page.
+    ![pro setting](./pro_setting.png)
+2. Use an email and your password as usual. Don't need to be GMail account.
+
+## Steps of connecting
+
+You need to connect your plugin to your online account. In Obsidian, in your Remotely Save plugin setting, you can click the button "Connect" to start the flow.
+
+1. You will see a special address on website. Click it and visit the website
+2. Click "allow" on the website.
+3. In the end of the auth flow on the website, you will be shown up a code, please copy it...
+4. And paste the code back to the plugin modal inside Obsidian, and confirm.
+
+![connect flow](./connect_flow.png)
+
+## Steps of subscribing to some features. 
+
+1. Firstly please visit your [profile page](https://remotelysave.com/user/profile) online.
+2. You can subscribe to some features. Prices vary.
+    ![PRO features online](./pro_features_enabled_on_website.png)
+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.
+    ![check again PRO features](./check_pro_features_in_settings.png)
+4. Sync and enjoy your PRO features!
+
+## Why so complicated?
+
+Because we doesn't have payment method inside the plugin, so we have to:
+
+* build a website, 
+* require users having online accounts
+* and connect the plugin to the online account.
+
+Moreover, an online account allows flexibe management of subscriptions. 
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:8c73da29a621d225387640b76ec0dcfb56b3ffad151dab374d3b7cc76067a1a0
+size 94377
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:116c2a8ec1a277a3985f4056b390574fc57145ec5635d44accf2a7445666264a
+size 626668
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4c45c08e6fc487341032aac511c332e3f9978a44e9b93377a73648b56b684b62
+size 155427
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:08d128125dba033f5dd18a6ea8d942b284ddca6c5c3b0362c47dcb4a7153a8f9
+size 395800
@@ -0,0 +1,59 @@
+# Google Drive (PRO)
+
+# Intro
+
+* It's a PRO feature of Remotely Save plugin.
+* **This plugin is NOT an official Google product, and just uses Google Drive'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 Google Drive" 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 Google Drive should be detected.
+
+## Steps of Connecting to your Google Drive
+
+After you enabled the PRO feature in your Remotely Save plugin, you can connect to your Google Drive account now.
+
+1. In Remotely Save settings, change your sync service to Google Drive.
+    ![change remote to google drive](./change_remote_to_google_drive.png)
+2. Click Auth, visit the link, go to Remotely Save website to start.
+    ![visit start link](./google_drive_auth_link.png)
+3. On the website, click the link to go to Google Drive auth page.
+4. Follow the instruction on Google website, and allow (continue) Remotely Save to connect.
+    ![allow Remotely Save in Google website](./google_drive_auth_allow.png)
+5. You will be redirected to Remotely Save website, and you will get a code. Copy it...
+    ![redirected back and get the code](./google_drive_auth_code_show.png)
+6. ... And paste the code back to the plugin inside Obsidian. Click submit.
+    ![submit the code in setting](./google_drive_code_submit.png)
+7. A notice will tell you that you've connected or not.
+8. Sync! The plugin will create a vault folder in the root of your Google Drive and upload notes into that folder.
+9. **Read the caveats below.**
+
+# Why so complicated?
+
+Because Google Drive's api doesn't fit into the special envorinment of Obsidian plugin. So we need a website.
+
+# The credential
+
+The website does **NOT** store or save the credential (the code you obtian in the end of the flow). The website is just a "bridge" to help you obtain that code, and just manage your subscription to PRO features.
+
+But please be aware that the code is saved locally in your Obsidian. It works like a special password. So that the plugin can upload or download or modify the files for you.
+
+# The caveats
+
+* As of June 2024, this feature is in beta stage. **Back up your vault before using this feature.**
+
+* The plugin can **only** sees, reads or writes the files and folders created by itself! 
+
+    It means that, you CANNOT manually create the vault folder in your Google Drive account. And if you manually upload any files using Google's official website, the plugin does **NOT** see them. All operations must go through Obsidian and uploaded by the plugin.
+
+    You can, however, view, and download the files on Google Drive [official web page](https://drive.google.com/drive/u/0/my-drive).
+
+    Precisely speaking, the plugin applies for the `drive.file` scope recommended by Google. See [the doc](https://developers.google.com/drive/api/guides/api-specific-auth#benefits) by Google for the scope's benefits. Basically the plugin will never (is unable to) mess up your other files or folders.
+
+    Moreover, this scope is "not-sensitive", so that the plugin doesn't need to go through Google's complicated verification process while applying for it.
+
+* Google Drive, unlike other cloud storage, allows files of same name co-existing in the same folder! (hmmmmm...) It may or may not make the plugin stop working. Users might need to remove the duplicated file manually on Google's official website.
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:eaa9aa8ba6b066dfefdce08a8d1da1d97089f5c2de0ba4c0c026d6df9eb9ece8
+size 99896
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6683a63718053603ae7dde44063a3807ba0def7e935da0b40fcc8e181afd24ae
+size 342848
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:310bd4c7d5fe19521ec7184b2eee749f0eecf00397f2b8e68480c23b4fd7c943
+size 153504
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:dcebb1f73829670883071447a8eee46c972b26fe8735c7422949cb6fe927b8ab
+size 179369
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:7e5a85c28f5614e4de75eacc021c2876d36596bcb77f0744a6edcff7777b9530
+size 155004