Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7f446b810c | ||
|
|
9b1a8f6068 | ||
|
|
94350873a9 | ||
|
|
1e6f59eb79 | ||
|
|
a64b859e46 | ||
|
|
689376adfe | ||
|
|
52d46b58d8 | ||
|
|
157eff3a61 | ||
|
|
5ed6fec6e9 | ||
|
|
e3c53860f7 | ||
|
|
ce48f072cb | ||
|
|
d067937138 | ||
|
|
60ff7e41bf | ||
|
|
9f67d41786 | ||
|
|
adacda7ee5 | ||
|
|
356c563e95 | ||
|
|
d3e134ce73 | ||
|
|
df0a0e2daa | ||
|
|
c9080dae4e | ||
|
|
08b68e224d | ||
|
|
2e09686675 | ||
|
|
5186dcb967 | ||
|
|
24b839227a | ||
|
|
12e45a7f38 | ||
|
|
d5c2f726f9 | ||
|
|
1e4d729eb7 | ||
|
|
64371b7d65 | ||
|
|
e116bb1deb | ||
|
|
2ace90155c | ||
|
|
d885a4c743 | ||
|
|
b6d46d8b91 | ||
|
|
06dad54d4c | ||
|
|
0802767726 | ||
|
|
be4a2d3271 | ||
|
|
7ca2d19255 | ||
|
|
ff765d5ae7 | ||
|
|
bdbf0b1484 | ||
|
|
7497b5fae7 | ||
|
|
408acb6230 | ||
|
|
d9cab7b1ff | ||
|
|
5e53967e01 | ||
|
|
fb9f4a67b4 | ||
|
|
26a426dda8 | ||
|
|
de64c3c53f | ||
|
|
0cefafa491 | ||
|
|
b769becb97 | ||
|
|
7b3600a46f | ||
|
|
69e72eae1d | ||
|
|
b0acde0ba6 | ||
|
|
11b7fee80b | ||
|
|
c4c39f6b79 | ||
|
|
45578a01dd | ||
|
|
0391c42999 | ||
|
|
807eec928e | ||
|
|
3d7c4d2a4a | ||
|
|
cb779fc7bf | ||
|
|
9d8e2af7b9 | ||
|
|
a48440e60b | ||
|
|
2a84fae368 | ||
|
|
3c3426a842 | ||
|
|
74de7da89a | ||
|
|
1f33ac5d7a | ||
|
|
63c54d1956 | ||
|
|
b584f89a95 | ||
|
|
fa17ea074b | ||
|
|
cb98bae79a | ||
|
|
d1e30e3536 | ||
|
|
36079fc1d0 | ||
|
|
67467a5034 | ||
|
|
2a3df8ab53 | ||
|
|
e66b0c71c4 | ||
|
|
a081d09212 | ||
|
|
6ed6122bb6 | ||
|
|
235e346d2f | ||
|
|
084cbc8391 | ||
|
|
dc0c1db779 | ||
|
|
2645ff34e6 | ||
|
|
f25a2c2992 | ||
|
|
3d1269a9f2 | ||
|
|
ed52a8542f | ||
|
|
757eb5c801 | ||
|
|
048e7b6251 | ||
|
|
b762052da3 | ||
|
|
c61efd1367 | ||
|
|
605bffa471 | ||
|
|
895e3db4c6 | ||
|
|
ce1990a35f | ||
|
|
9ea7c8e858 | ||
|
|
61a3fab219 | ||
|
|
5340e38eac | ||
|
|
8d5868b8d8 | ||
|
|
55175a6d06 | ||
|
|
f60bd25490 | ||
|
|
1d8463a3ed | ||
|
|
9fe1b1d5e6 | ||
|
|
df7b6e1848 | ||
|
|
a9126e5947 | ||
|
|
3bb7355db3 | ||
|
|
f33fa26c03 | ||
|
|
5ce350ba41 | ||
|
|
1d32f1242d | ||
|
|
d8ab054da1 | ||
|
|
b877228415 | ||
|
|
28b99557a8 | ||
|
|
ae28cf9183 | ||
|
|
8f68ac4ded | ||
|
|
220fd07a8b | ||
|
|
fe572b41c9 | ||
|
|
ca5ca5f576 | ||
|
|
0e6182b887 | ||
|
|
c5a7085fda | ||
|
|
640f1e56f1 | ||
|
|
cb6f7e572c | ||
|
|
83e0073134 | ||
|
|
cfe316f690 | ||
|
|
c472654060 | ||
|
|
46cbfcc3aa | ||
|
|
ce94a6d79c | ||
|
|
0fc0dcad64 | ||
|
|
577cdde21f | ||
|
|
583b365e72 | ||
|
|
3d213b2be8 | ||
|
|
ee224bf4f2 | ||
|
|
f1bd0b1ce6 | ||
|
|
300ed213af | ||
|
|
4be67ce491 | ||
|
|
98107ba4ea | ||
|
|
b674dd0f10 | ||
|
|
7930509e2a | ||
|
|
1c918d82da | ||
|
|
593fd7471b | ||
|
|
222f386586 | ||
|
|
dcd02457cb | ||
|
|
791c0e8df6 | ||
|
|
c37bf6aedd | ||
|
|
bed28d9f0b | ||
|
|
02e03681f7 | ||
|
|
62452341a3 | ||
|
|
bff2f6a642 | ||
|
|
833fdee69e | ||
|
|
936fce76a1 | ||
|
|
e2e8265d43 | ||
|
|
e228250613 | ||
|
|
dde4327249 | ||
|
|
e283efc8f7 | ||
|
|
6825241071 | ||
|
|
98380b6c92 | ||
|
|
d3eb2166aa | ||
|
|
7ecce29940 | ||
|
|
581c6237cc | ||
|
|
257c995090 | ||
|
|
fd095a9093 | ||
|
|
acc9233611 | ||
|
|
4456db11cf | ||
|
|
54449dd207 | ||
|
|
822941f1c3 | ||
|
|
62b176d709 | ||
|
|
9553bff44a | ||
|
|
ede1f4e1bc | ||
|
|
97f4c0c427 | ||
|
|
94a56dabdd | ||
|
|
4947eb91a2 | ||
|
|
2d12c9977d | ||
|
|
f2794ac539 | ||
|
|
519fd27dd5 | ||
|
|
dcbd36e33a | ||
|
|
e40a6adf63 | ||
|
|
06bf59bf2a | ||
|
|
d51659d3d1 | ||
|
|
7ec0102c7a | ||
|
|
c828a341ba | ||
|
|
d7ff793715 | ||
|
|
996533328e | ||
|
|
aff5a8b088 | ||
|
|
9fc46553e1 | ||
|
|
447e0c0aa4 | ||
|
|
768d6636d0 | ||
|
|
5f5b5de505 | ||
|
|
5df06bbed5 | ||
|
|
1f4737bfb8 | ||
|
|
40020c3e44 | ||
|
|
c512330d84 | ||
|
|
e34b120a63 | ||
|
|
725b12832c | ||
|
|
e341c4f780 | ||
|
|
10d22cb912 | ||
|
|
06b15b2146 | ||
|
|
2fbd87eed4 | ||
|
|
f6ea9938d1 | ||
|
|
38b189e2a7 | ||
|
|
6d1b451f4c | ||
|
|
69537f7002 | ||
|
|
17de78240f | ||
|
|
8cbcdf5323 | ||
|
|
6ba5abc0a6 | ||
|
|
d820285d1e | ||
|
|
a6002ba340 | ||
|
|
1f31303906 | ||
|
|
0fcedf397f | ||
|
|
085d8448d2 | ||
|
|
0d9da32b00 | ||
|
|
22880d6cf5 | ||
|
|
a084ec7728 | ||
|
|
eeeb4893c7 | ||
|
|
ed1ac66ac0 | ||
|
|
c33a9ecfa4 | ||
|
|
cabca54d80 | ||
|
|
8dde6c59d2 | ||
|
|
480cf224c6 | ||
|
|
37a801332f | ||
|
|
1e33f8b7d2 | ||
|
|
071b10387c | ||
|
|
b99053ef10 | ||
|
|
ff237ad8cb | ||
|
|
b89a163a66 | ||
|
|
991376a7a3 | ||
|
|
2da39bdfec | ||
|
|
f38c3d36be | ||
|
|
da0f183fad | ||
|
|
eb2ecca825 | ||
|
|
2494a2d96e | ||
|
|
8bb095c4aa | ||
|
|
c5e3147805 | ||
|
|
942e54961e | ||
|
|
29a3c76b4e | ||
|
|
897e4fc4e5 | ||
|
|
0124a49d7e | ||
|
|
3e245af50c | ||
|
|
695c74588f | ||
|
|
e3bd41a05a | ||
|
|
a6b73bde6a | ||
|
|
87d6e1f75f | ||
|
|
347c051d0c | ||
|
|
7422956621 | ||
|
|
7b67ba5b26 | ||
|
|
43cf95c417 | ||
|
|
53a1c32b43 | ||
|
|
71e25be28e | ||
|
|
afc5670313 | ||
|
|
81eb45d32c | ||
|
|
d7a59b82be | ||
|
|
acbf0318b4 | ||
|
|
f3f26f7c0b | ||
|
|
9fba9241dc |
@@ -1,3 +1,15 @@
|
||||
DROPBOX_APP_KEY=
|
||||
ONEDRIVE_CLIENT_ID=
|
||||
ONEDRIVE_AUTHORITY=https://
|
||||
REMOTELYSAVE_WEBSITE=http://127.0.0.1:46683
|
||||
REMOTELYSAVE_CLIENT_ID=cli-xxx
|
||||
GOOGLEDRIVE_CLIENT_ID=xxx.apps.googleusercontent.com
|
||||
GOOGLEDRIVE_CLIENT_SECRET=GOCSPX-sss
|
||||
BOX_CLIENT_ID=
|
||||
BOX_CLIENT_SECRET=
|
||||
PCLOUD_CLIENT_ID=
|
||||
PCLOUD_CLIENT_SECRET=
|
||||
YANDEXDISK_CLIENT_ID=
|
||||
YANDEXDISK_CLIENT_SECRET=
|
||||
KOOFR_CLIENT_ID=
|
||||
KOOFR_CLIENT_SECRET=
|
||||
|
||||
@@ -31,13 +31,30 @@ body:
|
||||
- type: dropdown
|
||||
id: service
|
||||
attributes:
|
||||
label: What remote cloud services are you using?
|
||||
label: What remote cloud services are you using? (Please choose the specified one if it's in the list)
|
||||
multiple: true
|
||||
options:
|
||||
- S3
|
||||
- S3 (Cloudflare R2)
|
||||
- S3 (BackBlaze B2)
|
||||
- S3 (腾讯云 COS Tencent Cloud COS)
|
||||
- S3 (阿里云 OSS Alibaba Cloud OSS)
|
||||
- S3 (MinIO)
|
||||
- S3 (Wasabi)
|
||||
- S3 (Storj)
|
||||
- OneDrive for personal
|
||||
- OneDrive for business
|
||||
- Dropbox
|
||||
- webdav
|
||||
- webdav
|
||||
- webdav (ownCloud)
|
||||
- webdav (InfiniCloud (formally TeraCLOUD))
|
||||
- webdav (AList)
|
||||
- webdav (Cloudreve)
|
||||
- webdav (坚果云 JianGuoYun/NutStore)
|
||||
- webdav (NextCloud)
|
||||
- webdav (FastMail)
|
||||
- webdav (rclone webdav)
|
||||
- webdav (nginx)
|
||||
- others
|
||||
validations:
|
||||
required: true
|
||||
|
||||
@@ -21,9 +21,26 @@ body:
|
||||
multiple: true
|
||||
options:
|
||||
- S3
|
||||
- S3 (Cloudflare R2)
|
||||
- S3 (BackBlaze B2)
|
||||
- S3 (腾讯云 COS Tencent Cloud COS)
|
||||
- S3 (阿里云 OSS Alibaba Cloud OSS)
|
||||
- S3 (MinIO)
|
||||
- S3 (Wasabi)
|
||||
- S3 (Storj)
|
||||
- OneDrive for personal
|
||||
- OneDrive for business
|
||||
- Dropbox
|
||||
- webdav
|
||||
- webdav
|
||||
- webdav (ownCloud)
|
||||
- webdav (InfiniCloud (formally TeraCLOUD))
|
||||
- webdav (AList)
|
||||
- webdav (Cloudreve)
|
||||
- webdav (坚果云 JianGuoYun/NutStore)
|
||||
- webdav (NextCloud)
|
||||
- webdav (FastMail)
|
||||
- webdav (rclone webdav)
|
||||
- webdav (nginx)
|
||||
- others
|
||||
validations:
|
||||
required: false
|
||||
|
||||
@@ -19,6 +19,18 @@ jobs:
|
||||
DROPBOX_APP_KEY: ${{secrets.DROPBOX_APP_KEY}}
|
||||
ONEDRIVE_CLIENT_ID: ${{secrets.ONEDRIVE_CLIENT_ID}}
|
||||
ONEDRIVE_AUTHORITY: ${{secrets.ONEDRIVE_AUTHORITY}}
|
||||
REMOTELYSAVE_WEBSITE: ${{secrets.REMOTELYSAVE_WEBSITE}}
|
||||
REMOTELYSAVE_CLIENT_ID: ${{secrets.REMOTELYSAVE_CLIENT_ID}}
|
||||
GOOGLEDRIVE_CLIENT_ID: ${{secrets.GOOGLEDRIVE_CLIENT_ID}}
|
||||
GOOGLEDRIVE_CLIENT_SECRET: ${{secrets.GOOGLEDRIVE_CLIENT_SECRET}}
|
||||
BOX_CLIENT_ID: ${{secrets.BOX_CLIENT_ID}}
|
||||
BOX_CLIENT_SECRET: ${{secrets.BOX_CLIENT_SECRET}}
|
||||
PCLOUD_CLIENT_ID: ${{secrets.PCLOUD_CLIENT_ID}}
|
||||
PCLOUD_CLIENT_SECRET: ${{secrets.PCLOUD_CLIENT_SECRET}}
|
||||
YANDEXDISK_CLIENT_ID: ${{secrets.YANDEXDISK_CLIENT_ID}}
|
||||
YANDEXDISK_CLIENT_SECRET: ${{secrets.YANDEXDISK_CLIENT_SECRET}}
|
||||
KOOFR_CLIENT_ID: ${{secrets.KOOFR_CLIENT_ID}}
|
||||
KOOFR_CLIENT_SECRET: ${{secrets.KOOFR_CLIENT_SECRET}}
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
@@ -29,10 +41,18 @@ jobs:
|
||||
- name: Checkout codes
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
lfs: true
|
||||
submodules: recursive
|
||||
- name: Checkout LFS
|
||||
run: git lfs checkout
|
||||
- name: Checkout LFS file list
|
||||
run: git lfs ls-files --long | cut -d ' ' -f1 | sort > .lfs-assets-id
|
||||
- name: LFS Cache
|
||||
uses: actions/cache@v3
|
||||
with:
|
||||
path: .git/lfs/objects
|
||||
key: ${{ runner.os }}-lfs-${{ hashFiles('.lfs-assets-id') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-lfs-
|
||||
- name: Git LFS Pull
|
||||
run: git lfs pull
|
||||
- name: Use Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v2
|
||||
with:
|
||||
|
||||
@@ -0,0 +1,43 @@
|
||||
name: "CLA Assistant"
|
||||
on:
|
||||
issue_comment:
|
||||
types: [created]
|
||||
pull_request_target:
|
||||
types: [opened,closed,synchronize]
|
||||
|
||||
# explicitly configure permissions, in case your GITHUB_TOKEN workflow permissions are set to read-only in repository settings
|
||||
permissions:
|
||||
actions: write
|
||||
contents: write
|
||||
pull-requests: write
|
||||
statuses: write
|
||||
|
||||
jobs:
|
||||
CLAAssistant:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: "CLA Assistant"
|
||||
if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target'
|
||||
uses: contributor-assistant/github-action@v2.3.0
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
# the below token should have repo scope and must be manually added by you in the repository's secret
|
||||
# This token is required only if you have configured to store the signatures in a remote repository/organization
|
||||
PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
|
||||
with:
|
||||
path-to-signatures: 'signatures/version1/cla.json'
|
||||
path-to-document: 'https://github.com/remotely-save/remotely-save/blob/master/CLA.md' # e.g. a CLA or a DCO document
|
||||
# branch should not be protected
|
||||
branch: 'main'
|
||||
allowlist: bot*
|
||||
|
||||
# the followings are the optional inputs - If the optional inputs are not given, then default values will be taken
|
||||
remote-organization-name: remotely-save
|
||||
remote-repository-name: cla-signed
|
||||
#create-file-commit-message: 'For example: Creating file for storing CLA Signatures'
|
||||
#signed-commit-message: 'For example: $contributorName has signed the CLA in $owner/$repo#$pullRequestNo'
|
||||
custom-notsigned-prcomment: '<br/>Thank you for your submission, we really appreciate it. However, we ask that $you sign our [Contributor License Agreement](https://github.com/remotely-save/remotely-save/blob/master/CLA.md) before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.<br/>'
|
||||
#custom-pr-sign-comment: 'The signature to be committed in order to sign the CLA'
|
||||
#custom-allsigned-prcomment: 'pull request comment when all contributors has signed, defaults to **CLA Assistant Lite bot** All Contributors have signed the CLA.'
|
||||
#lock-pullrequest-aftermerge: false - if you don't want this bot to automatically lock the pull request after merging (default - true)
|
||||
#use-dco-flag: true - If you are using DCO instead of CLA
|
||||
@@ -23,6 +23,18 @@ jobs:
|
||||
DROPBOX_APP_KEY: ${{secrets.DROPBOX_APP_KEY}}
|
||||
ONEDRIVE_CLIENT_ID: ${{secrets.ONEDRIVE_CLIENT_ID}}
|
||||
ONEDRIVE_AUTHORITY: ${{secrets.ONEDRIVE_AUTHORITY}}
|
||||
REMOTELYSAVE_WEBSITE: ${{secrets.REMOTELYSAVE_WEBSITE}}
|
||||
REMOTELYSAVE_CLIENT_ID: ${{secrets.REMOTELYSAVE_CLIENT_ID}}
|
||||
GOOGLEDRIVE_CLIENT_ID: ${{secrets.GOOGLEDRIVE_CLIENT_ID}}
|
||||
GOOGLEDRIVE_CLIENT_SECRET: ${{secrets.GOOGLEDRIVE_CLIENT_SECRET}}
|
||||
BOX_CLIENT_ID: ${{secrets.BOX_CLIENT_ID}}
|
||||
BOX_CLIENT_SECRET: ${{secrets.BOX_CLIENT_SECRET}}
|
||||
PCLOUD_CLIENT_ID: ${{secrets.PCLOUD_CLIENT_ID}}
|
||||
PCLOUD_CLIENT_SECRET: ${{secrets.PCLOUD_CLIENT_SECRET}}
|
||||
YANDEXDISK_CLIENT_ID: ${{secrets.YANDEXDISK_CLIENT_ID}}
|
||||
YANDEXDISK_CLIENT_SECRET: ${{secrets.YANDEXDISK_CLIENT_SECRET}}
|
||||
KOOFR_CLIENT_ID: ${{secrets.KOOFR_CLIENT_ID}}
|
||||
KOOFR_CLIENT_SECRET: ${{secrets.KOOFR_CLIENT_SECRET}}
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
@@ -32,10 +44,18 @@ jobs:
|
||||
- name: Checkout codes
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
lfs: true
|
||||
submodules: recursive
|
||||
- name: Checkout LFS
|
||||
run: git lfs checkout
|
||||
- name: Checkout LFS file list
|
||||
run: git lfs ls-files --long | cut -d ' ' -f1 | sort > .lfs-assets-id
|
||||
- name: LFS Cache
|
||||
uses: actions/cache@v3
|
||||
with:
|
||||
path: .git/lfs/objects
|
||||
key: ${{ runner.os }}-lfs-${{ hashFiles('.lfs-assets-id') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-lfs-
|
||||
- name: Git LFS Pull
|
||||
run: git lfs pull
|
||||
- name: Use Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v2
|
||||
with:
|
||||
|
||||
@@ -1,3 +0,0 @@
|
||||
node_modules/
|
||||
main.js
|
||||
data.json
|
||||
@@ -0,0 +1,23 @@
|
||||
In order to clarify the intellectual property license granted with Contributions from any person or entity, Remotely Save dev team ("Remotely Save") must have on file a signed Contributor License Agreement ("CLA") from each Contributor, indicating agreement with the license terms below. This agreement is for your protection as a Contributor as well as the protection of Remotely Save and its users. It does not change your rights to use your own Contributions for any other purpose.
|
||||
|
||||
You accept and agree to the following terms and conditions for Your Contributions (present and future) that you submit to Remotely Save. Except for the license granted herein to Remotely Save and recipients of software distributed by Remotely Save, You reserve all right, title, and interest in and to Your Contributions.
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"You" (or "Your") shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement with Remotely Save. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"Contribution" shall mean any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You to Remotely Save for inclusion in, or documentation of, any of the products owned or managed by Remotely Save (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to Remotely Save or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, Remotely Save for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution."
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of this Agreement, You hereby grant to Remotely Save and to recipients of software distributed by Remotely Save a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of this Agreement, You hereby grant to Remotely Save and to recipients of software distributed by Remotely Save a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed.
|
||||
|
||||
4. You represent that you are legally entitled to grant the above license. If your employer(s) has rights to intellectual property that you create that includes your Contributions, you represent that you have received permission to make Contributions on behalf of that employer, that your employer has waived such rights for your Contributions to Remotely Save, or that your employer has executed a separate Corporate CLA with Remotely Save.
|
||||
|
||||
5. You represent that each of Your Contributions is Your original creation (see section 7 for submissions on behalf of others). You represent that Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which you are personally aware and which are associated with any part of Your Contributions.
|
||||
|
||||
6. You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.
|
||||
|
||||
7. Should You wish to submit work that is not Your original creation, You may submit it to Remotely Save separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]".
|
||||
|
||||
8. You agree to notify Remotely Save of any facts or circumstances of which you become aware that would make these representations inaccurate in any respect.
|
||||
@@ -0,0 +1,22 @@
|
||||
# Contributing
|
||||
|
||||
## What
|
||||
|
||||
Starting from April 29, 2024, all individual contributors' contributions are only possibly accepted after they sign the CLA.
|
||||
|
||||
We do not accept corporate contributions at this moment.
|
||||
|
||||
You can check out [CLA](./CLA.md).
|
||||
|
||||
## Steps
|
||||
|
||||
1. Make some changes to the code. Open a pull request.
|
||||
2. A rebot will check the status.
|
||||

|
||||
3. Read the [CLA](./CLA.md) carefully and make a decision.
|
||||
4. If you decide to sign the CLA, please make a comment "I have read the CLA Document and I hereby sign the CLA".
|
||||
5. If you decide to not sign the CLA, please close the PR.
|
||||
6. The robot should recheck and pass the check automatically.
|
||||

|
||||
7. Your pr will be reviewed.
|
||||
8. If you sign the CLA and submit some more PRs, the robot should pass the test automatically.
|
||||
@@ -1,202 +1,3 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
The codes or files or subfolders inside the folder `src`, `tests`, `docs`, `assets`, are released under the "Open Source" license: "Apache License, version 2.0", described at: https://www.apache.org/licenses/LICENSE-2.0 .
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
||||
The codes or files or subfolders inside the folder `pro`, are released under the "Source Available" license: "PolyForm Strict License 1.0.0", described at: https://polyformproject.org/licenses/strict/1.0.0/ .
|
||||
|
||||
@@ -17,23 +17,28 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find
|
||||
## Features
|
||||
|
||||
- Supports:
|
||||
- Amazon S3 or S3-compatible
|
||||
- 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)
|
||||
- Yandex Disk (PRO feature)
|
||||
- Koofr (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.md) supported.** Files would be encrypted using openssl format before being sent to the cloud **if** user specify a password.
|
||||
- **[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.
|
||||
- **Scheduled auto sync supported.** You can also manually trigger the sync using sidebar ribbon, or using the command from the command palette (or even bind the hot key combination to the command then press the hot key combination).
|
||||
- **[Minimal Intrusive](./docs/minimal_intrusive_design.md).**
|
||||
- \*\*Skip Large files and skip paths by custom regex conditions!
|
||||
- **Fully open source under [Apache-2.0 License](./LICENSE).**
|
||||
- **[Sync Algorithm open](./docs/sync_algorithm_v2.md) for discussion.**
|
||||
- **Skip Large files** and **skip paths** by custom regex conditions!
|
||||
- **[Sync Algorithm](./docs/sync_algorithm/v3/intro.md) is provided for discussion.**
|
||||
- **[Basic Conflict Detection And Handling](./docs/sync_algorithm/v3/intro.md)** for free version. **[Advanced Conflict Handling](./pro/README.md)** for PRO version.
|
||||
- Source Available. See [License](./LICENSE) for details.
|
||||
|
||||
## Limitations
|
||||
|
||||
- **To support deletions sync, extra metadata will also be uploaded.** See [Minimal Intrusive](./docs/minimal_intrusive_design.md).
|
||||
- **No Conflict resolution. No content-diff-and-patch algorithm.** All files and folders are compared using their local and remote "last modified time" and those with later "last modified time" wins.
|
||||
- **Cloud services cost you money.** Always be aware of the costs and pricing. Specifically, all the operations, including but not limited to downloading, uploading, listing all files, calling any api, storage sizes, may or may not cost you money.
|
||||
- **Some limitations from the browser environment.** More technical details are [in the doc](./docs/browser_env.md).
|
||||
- **You should protect your `data.json` file.** The file contains sensitive information.
|
||||
@@ -63,15 +68,21 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
|
||||
|
||||
- Tutorials / Examples:
|
||||
- [Cloudflare R2](./docs/remote_services/s3_cloudflare_r2/README.md)
|
||||
- [BackBlaze B2](./docs/remote_services/s3_backblaze_b2/README.md)
|
||||
- [Storj](./docs/remote_services/s3_storj_io/README.md)
|
||||
- [腾讯云 COS](./docs/remote_services/s3_tencent_cloud_cos/README.zh-cn.md) | [Tencent Cloud COS](./docs/remote_services/s3_tencent_cloud_cos/README.md)
|
||||
- [MinIO](./docs/remote_services/s3_minio/README.md)
|
||||
- Prepare your S3 (-compatible) service information: [endpoint, region](https://docs.aws.amazon.com/general/latest/gr/s3.html), [access key id, secret access key](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/getting-your-credentials.html), bucket name. The bucket should be empty and solely for syncing a vault.
|
||||
- [又拍云](./docs/remote_services/s3_upyun/README.zh-cn.md)
|
||||
- Prepare your S3 (-compatible) service information: [endpoint, region](https://docs.aws.amazon.com/general/latest/gr/s3.html), [access key id, secret access key](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/getting-your-credentials.html), bucket name.
|
||||
- If you are using AWS S3, create [policy and user](./docs/remote_services/s3_general/s3_user_policy.md).
|
||||
- Very old version of Obsidian needs [configuring CORS](./docs/remote_services/s3_general/s3_cors_configure.md).
|
||||
- Download and enable this plugin.
|
||||
- Enter your information to the settings of this plugin.
|
||||
- If you do not set the prefix in the settings, the bucket should be empty and solely for syncing a vault. You can set the prefix in the settings so that the same bucket can store multiple vaults.
|
||||
- If you want to enable end-to-end encryption, also set a password in settings. If you do not specify a password, the files and folders are synced in plain, original content to the cloud.
|
||||
- Click the new "circle arrow" icon on the ribbon (the left sidebar), **every time** you want to sync your vault between local and remote. (Or, you could configure auto sync in the settings panel (See next chapter).) While syncing, the icon becomes "two half-circle arrows". Besides clicking the icon on the sidebar ribbon, you can also activate the corresponding command in the command palette.
|
||||
- **Be patient while syncing.** Especially in the first-time sync.
|
||||
- If you want to sync the files across multiple devices, **your vault name should be the same** while using default settings.
|
||||
|
||||
### Dropbox
|
||||
|
||||
@@ -79,6 +90,7 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
|
||||
- After the authorization, the plugin can read your name and email (which cannot be unselected on Dropbox api), and read and write files in your Dropbox's `/Apps/remotely-save` folder.
|
||||
- If you decide to authorize this plugin to connect to Dropbox, please go to plugin's settings, and choose Dropbox then follow the instructions. [More with screenshot is here](./docs/dropbox_review_material/README.md).
|
||||
- Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
|
||||
- If you want to sync the files across multiple devices, **your vault name should be the same** while using default settings.
|
||||
|
||||
### OneDrive for personal
|
||||
|
||||
@@ -87,16 +99,53 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
|
||||
- After the authorization, the plugin can read your name and email, and read and write files in your OneDrive's `/Apps/remotely-save` folder.
|
||||
- If you decide to authorize this plugin to connect to OneDrive, please go to plugin's settings, and choose OneDrive then follow the instructions.
|
||||
- Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
|
||||
- If you want to sync the files across multiple devices, **your vault name should be the same** while using default settings.
|
||||
- You might also want to checkout [faq for OneDrive](./docs/remote_services/onedrive/README.md).
|
||||
|
||||
### webdav
|
||||
|
||||
- Tutorials / Examples:
|
||||
- [Nextcloud](./docs/remote_services/webdav_nextcloud/README.md)
|
||||
- [The Good Cloud](./docs/remote_services/webdav_thegoodcloud/README.md)
|
||||
- [ownCloud](./docs/remote_services/webdav_owncloud/README.md)
|
||||
- [InfiniCloud](./docs/remote_services/webdav_infinicloud_teracloud/README.md)
|
||||
- [坚果云 JianGuoYun/NutStore](./docs/remote_services/webdav_jianguoyun/README.md)
|
||||
- [Synology webdav server](./docs/remote_services/webdav_synology_webdav_server/README.md) | [群晖 webdav server](./docs/remote_services/webdav_synology_webdav_server/README.zh-cn.md)
|
||||
- [AList(中文)](./docs/remote_services/webdav_alist/README.zh-cn.md) | [AList (English)](./docs/remote_services/webdav_alist/README.md)
|
||||
- [坚果云](./docs/remote_services/webdav_jianguoyun/README.zh-cn.md) | [JianGuoYun/NutStore](./docs/remote_services/webdav_jianguoyun/README.md)
|
||||
- [Open Media Vault](./docs/remote_services/webdav_openmediavault/README.md)
|
||||
- [Nginx (`ngx_http_dav_module`, `nginx-dav-ext-module`, with Docker)](./docs/remote_services/webdav_nginx/README.md)
|
||||
- [Apache (with Docker)](./docs/remote_services/webdav_apache/README.md)
|
||||
- Very old version of Obsidian needs [configuring CORS](./docs/remote_services/webdav_general/webav_cors.md).
|
||||
- Your data would be synced to a `${vaultName}` sub folder on your webdav server.
|
||||
- Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
|
||||
- If you want to sync the files across multiple devices, **your vault name should be the same** while using default settings.
|
||||
|
||||
### Webdis
|
||||
|
||||
- Tutorials:
|
||||
- [Webdis](./docs/remote_services/webdis/README.md)
|
||||
- Mostly experimental.
|
||||
- You have to setup and protect your web server by yourself.
|
||||
|
||||
### Google Drive (PRO feature)
|
||||
|
||||
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).
|
||||
|
||||
### Yandex Disk (PRO feature)
|
||||
|
||||
PRO (paid) feature "sync with Yandex Disk" allows users to to sync with Yandex Disk (using its native API instead of webdav). Tutorials and limitations are documented [here](./docs/remote_services/yandexdisk/README.md).
|
||||
|
||||
### Yandex Disk (PRO feature)
|
||||
|
||||
PRO (paid) feature "sync with Koofr" allows users to to sync with Koofr (using its native API instead of webdav). Tutorials and limitations are documented [here](./docs/remote_services/koofr/README.md).
|
||||
|
||||
## Scheduled Auto Sync
|
||||
|
||||
@@ -110,6 +159,10 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
|
||||
|
||||
In the latest version, you can change the settings to allow syncing `_` files or folders, as well as `.obsidian` special config folder (but not any other `.` files or folders).
|
||||
|
||||
## PRO Features
|
||||
|
||||
See [PRO](./docs/pro/README.md) for more details.
|
||||
|
||||
## How To Debug
|
||||
|
||||
See [here](./docs/how_to_debug/README.md) for more details.
|
||||
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:07fd075d0f73c708d77fd97bb31d6f185f094031e8275e8fd582e3a0145f6be8
|
||||
size 415757
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:4c5754df8b5d6878a7fa58992fc7e37ddcce1ecf578a0fc2ec751b6f7bab6f13
|
||||
size 284700
|
||||
+55
@@ -0,0 +1,55 @@
|
||||
{
|
||||
"$schema": "https://biomejs.dev/schemas/1.7.3/schema.json",
|
||||
"organizeImports": {
|
||||
"enabled": true
|
||||
},
|
||||
"files": {
|
||||
"ignore": ["main.js"]
|
||||
},
|
||||
"formatter": {
|
||||
"enabled": true,
|
||||
"formatWithErrors": false,
|
||||
"ignore": [],
|
||||
"attributePosition": "auto",
|
||||
"indentStyle": "space",
|
||||
"indentWidth": 2,
|
||||
"lineEnding": "lf",
|
||||
"lineWidth": 80
|
||||
},
|
||||
"javascript": {
|
||||
"formatter": {
|
||||
"arrowParentheses": "always",
|
||||
"bracketSameLine": false,
|
||||
"bracketSpacing": true,
|
||||
"jsxQuoteStyle": "double",
|
||||
"quoteProperties": "asNeeded",
|
||||
"semicolons": "always",
|
||||
"trailingComma": "es5"
|
||||
}
|
||||
},
|
||||
"linter": {
|
||||
"enabled": true,
|
||||
"rules": {
|
||||
"recommended": true,
|
||||
"suspicious": {
|
||||
"noExplicitAny": "off",
|
||||
"noPrototypeBuiltins": "off",
|
||||
"noControlCharactersInRegex": "off"
|
||||
},
|
||||
"style": {
|
||||
"noUselessElse": "off",
|
||||
"useNodejsImportProtocol": "off",
|
||||
"noUnusedTemplateLiteral": "off",
|
||||
"useTemplate": "off",
|
||||
"noNonNullAssertion": "off"
|
||||
},
|
||||
"performance": {
|
||||
"noDelete": "off"
|
||||
},
|
||||
"complexity": {
|
||||
"noForEach": "off",
|
||||
"useLiteralKeys": "off"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,25 +0,0 @@
|
||||
// Importing the http module
|
||||
const http = require("http");
|
||||
|
||||
const requestHandler = (req, res) => {
|
||||
let body = [];
|
||||
req
|
||||
.on("data", (chunk) => {
|
||||
body.push(chunk);
|
||||
})
|
||||
.on("end", () => {
|
||||
const parsed = JSON.parse(Buffer.concat(body).toString());
|
||||
const prettyParsed = JSON.stringify(parsed, null, 2);
|
||||
console.log(prettyParsed);
|
||||
res.setHeader("Content-Type", "application/json");
|
||||
res.end(prettyParsed);
|
||||
});
|
||||
};
|
||||
|
||||
const server = http.createServer(requestHandler);
|
||||
|
||||
const addr = "0.0.0.0";
|
||||
const port = 3000;
|
||||
server.listen(port, addr, undefined, () => {
|
||||
console.log(`Server is Running on ${addr}:${port}`);
|
||||
});
|
||||
@@ -0,0 +1,8 @@
|
||||
# Encryption
|
||||
|
||||
Currently (March 2024), Remotely Save supports two end to end encryption format:
|
||||
|
||||
1. [RClone Crypt](./rclone.md) format, which is the recommend way now.
|
||||
2. [OpenSSL enc](./openssl.md) format
|
||||
|
||||
Here is also the [comparation](./comparation.md).
|
||||
@@ -0,0 +1,23 @@
|
||||
# Comparation Between Encryption Formats
|
||||
|
||||
## Warning
|
||||
|
||||
**ALWAYS BACKUP YOUR VAULT MANUALLY!!!**
|
||||
|
||||
If you switch between RClone Crypt format and OpenSSL enc format, you have to delete the cloud vault files **manually** and **fully**, so that the plugin can re-sync (i.e. re-upload) the newly encrypted versions to the cloud.
|
||||
|
||||
## The feature table
|
||||
|
||||
| | RClone Crypt | OpenSSL enc | comments |
|
||||
| ------------------------ | ------------------------------------------------------------------------------------------ | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| key generation | scrypt with fixed salt | PBKDF2 with dynamic salt | scrypt is better than PBKDF2 from the algorithm aspect. But RClone uses fixed salt by default. Also the parameters might affect the result. |
|
||||
| content encryption | XSalsa20Poly1305 on chunks | AES-256-CBC | XSalsa20Poly1305 is way better than AES-256-CBC. And encryption by chunks should require less resources. |
|
||||
| file name encryption | EME on each segment of the path | AES-256-CBC on the whole path | RClone has the benefit as well as pitfall that the path structure is preserved. Maybe it's more of a design decision difference? No comment on EME and AES-256-CBC. |
|
||||
| viewing decrypted result | RClone has command that can mount the encrypted vault as if the encryption is transparent. | No convenient way except writing some scripts we are aware of. | RClone is way more convenient. |
|
||||
|
||||
## Some notes
|
||||
|
||||
1. Anyway, security is a hard problem. The author of Remotely Save doesn't have sufficient knowledge to "judge" which one is the better format. **Use them at your own risk.**
|
||||
2. Currently the RClone Crypt format is recommended by default in Remotely Save. Just because of the taste from the Remotely Save author, who likes RClone.
|
||||
3. **Always use a long password.**
|
||||
4. Both algorithms are selected deliberately to **be compatible with some well-known third-party tools** (instead of some home-made methods) and **have many tests to ensure the correctness**.
|
||||
@@ -1,10 +1,22 @@
|
||||
# Encryption
|
||||
# OpenSSL enc format
|
||||
|
||||
If a password is set, the files are encrypted before being sent to the cloud.
|
||||
|
||||
The encryption algorithm is delibrately designed to be aligned with openssl format.
|
||||
## Warning
|
||||
|
||||
1. The encryption algorithm is implemented using web-crypto.
|
||||
**ALWAYS BACKUP YOUR VAULT MANUALLY!!!**
|
||||
|
||||
If you switch between RClone Crypt format and OpenSSL enc format, you have to delete the cloud vault files **manually** and **fully**, so that the plugin can re-sync (i.e. re-upload) the newly encrypted versions to the cloud.
|
||||
|
||||
## Comparation between encryption formats
|
||||
|
||||
See the doc [Comparation](./comparation.md).
|
||||
|
||||
## Interoperability with official OpenSSL
|
||||
|
||||
This encryption algorithm is delibrately designed to be aligned with openssl format.
|
||||
|
||||
1. The encryption algorithm is implemented using web-crypto. Using AES-256-CBC.
|
||||
2. The file content is encrypted using openssl format. Assuming a file named `sometext.txt`, a password `somepassword`, then the encryption is equivalent to the following command:
|
||||
|
||||
```bash
|
||||
@@ -0,0 +1,46 @@
|
||||
# RClone Crypt format
|
||||
|
||||
The encryption is compatible with RClone Crypt with **base64** name encryption format.
|
||||
|
||||
It's developed based on another js project by the same author of Remotely Save: [`@fyears/rclone-crypt`](https://github.com/fyears/rclone-crypt), which is NOT an official library from RClone, and is NOT affiliated with RClone.
|
||||
|
||||
Reasonable tests are also ported from official RClone code, to ensure the compatibility and correctness of the encryption.
|
||||
|
||||
## Warning
|
||||
|
||||
**ALWAYS BACKUP YOUR VAULT MANUALLY!!!**
|
||||
|
||||
If you switch between RClone Crypt format and OpenSSL enc format, you have to delete the cloud vault files **manually** and **fully**, so that the plugin can re-sync (i.e. re-upload) the newly encrypted versions to the cloud.
|
||||
|
||||
## Comparation between encryption formats
|
||||
|
||||
See the doc [Comparation](./comparation.md).
|
||||
|
||||
## Interoperability with official RClone
|
||||
|
||||
Please pay attention that the plugin uses **base64** of encrypted file names, while official RClone by default uses **base32** file names. The intention is purely for potentially support longer file names.
|
||||
|
||||
You could set up the RClone profile by calling `rclone config`. You need to create two profiles, one for your original connection and the other for RClone Crypt.
|
||||
|
||||
Finally, a working config file should like this:
|
||||
|
||||
```ini
|
||||
[webdav1]
|
||||
type = webdav
|
||||
url = https://example.com/sharefolder1/subfolder1 # the same as the web address in Remotely Save settings.
|
||||
vendor = other
|
||||
user = <some webdav username>
|
||||
pass = <some webdav password, obfuscated>
|
||||
|
||||
[webdav1crypt]
|
||||
type = crypt
|
||||
remote = nas1test:vaultname # the same as your "Remote Base Directory" (usually the vault name) in Remotely Save settings
|
||||
password = <some encryption password, obfuscated>
|
||||
filename_encoding = base64 # don't forget this!!!
|
||||
```
|
||||
|
||||
You can use the `mount` command to view and see the files in file explorer! On Windows, the command should like this (the remote vault is mounted to drive `X:`):
|
||||
|
||||
```bash
|
||||
rclone mount webdav1crypt: X: --network-mode
|
||||
```
|
||||
@@ -12,8 +12,8 @@ See [here](./export_sync_plans.md).
|
||||
|
||||
See [here](./check_console_output.md).
|
||||
|
||||
## Advanced: Save Console Output Then Read Them Later
|
||||
## Advanced: Use `Logstravaganza` to export logs
|
||||
|
||||
This method works for desktop and mobile devices (iOS, Android).
|
||||
This method works for desktop and mobile devices (iOS, Android), especially useful for iOS.
|
||||
|
||||
See [here](./save_console_output_and_export.md).
|
||||
See [here](./use_logstravaganza.md).
|
||||
|
||||
@@ -1,25 +0,0 @@
|
||||
# Save Console Output And Read Them Later
|
||||
|
||||
## Disable Auto Sync Firstly
|
||||
|
||||
You should disable auto sync to avoid any unexpected running.
|
||||
|
||||
## Set The Output Level To Debug
|
||||
|
||||
Go to the plugin settings, scroll down to the section "Debug" -> "alter console log level", and change it from "info" to "debug".
|
||||
|
||||
## Enable Saving The Output To DB
|
||||
|
||||
Go to the plugin settings, scroll down to the section "Debug" -> "Save Console Logs Into DB", and change it from "disable" to "enable". **This setting has some performance cost, so do NOT always turn this on when not necessary!**
|
||||
|
||||
## Run The Sync
|
||||
|
||||
Trigger the sync manually (by clicking the icon on the ribbon sidebar). Something (hopefully) helpful should show up in the console. The the console logs are also saved into DB now.
|
||||
|
||||
## Export The Output And Read The Logs
|
||||
|
||||
Go to the plugin settings, scroll down to the section "Debug" -> "Export Console Logs From DB", and click the button. A new file `log_hist_exported_on_....md` should be created inside the special folder `_debug_remotely_save/`. You could read it and hopefully find something useful.
|
||||
|
||||
## Disable Saving The Output To DB
|
||||
|
||||
After debugging, go to the plugin settings, scroll down to the section "Debug" -> "Save Console Logs Into DB", and change it from "enable" to "disable".
|
||||
@@ -0,0 +1,14 @@
|
||||
# Use `Logstravaganza`
|
||||
|
||||
On iOS, it's quite hard to directly check the console logs.
|
||||
|
||||
Luckily, there is a third-party plugin: [`Logstravaganza`](https://obsidian.md/plugins?search=Logstravaganza#), by Carlo Zottmann, that can redirect the output to a note.
|
||||
|
||||
You can just:
|
||||
|
||||
1. Install it.
|
||||
2. Enable it.
|
||||
3. Do something, to trigger some console logs.
|
||||
4. Checkout `LOGGING-NOTE (device name).md` in the root of your vault.
|
||||
|
||||
See more on its site: <https://github.com/czottmann/obsidian-logstravaganza>.
|
||||
@@ -0,0 +1,56 @@
|
||||
# How to receive `obsidian://` in Linux
|
||||
|
||||
## Background
|
||||
|
||||
For example, when we are authorizing OneDrive, we have to jump back to Obsidian automatically using `obsidian://`.
|
||||
|
||||
## Short Desc From Official Obsidian Doc
|
||||
|
||||
Official doc has some explanation:
|
||||
|
||||
<https://help.obsidian.md/Extending+Obsidian/Obsidian+URI#Register+Obsidian+URI>
|
||||
|
||||
# Long Desc
|
||||
|
||||
Assuming the username is `somebody`, and the `.AppImage` file is downloaded to `~/Desktop`.
|
||||
|
||||
1. Download and **extract** the app image file in terminal
|
||||
|
||||
```bash
|
||||
cd /home/somebody/Desktop
|
||||
chmod +x Obsidian-x.y.z.AppImage
|
||||
./Obsidian-x.y.z.AppImage --appimage-extract
|
||||
|
||||
# you should have the folder squashfs-root
|
||||
# we want to rename it
|
||||
mv squashfs-root Obsidian
|
||||
```
|
||||
|
||||
2. Create a `.desktop` file
|
||||
|
||||
```bash
|
||||
# copy and paste the follow MULTI LINE command
|
||||
# you might need to input your password because it requires root privilege
|
||||
# remember to adjust the path
|
||||
cat > ~/Desktop/obsidian.desktop <<EOF
|
||||
[Desktop Entry]
|
||||
Name=Obsidian
|
||||
Comment=obsidian
|
||||
Exec=/home/somebody/Desktop/Obsidian/obsidian %u
|
||||
Keywords=obsidian
|
||||
StartupNotify=true
|
||||
Terminal=false
|
||||
Type=Application
|
||||
Icon=/home/somebody/Desktop/Obsidian/obsidian.png
|
||||
MimeType=x-scheme-handler/obsidian;
|
||||
EOF
|
||||
|
||||
# yeah we can check out the output
|
||||
cat ~/Desktop/obsidian.desktop
|
||||
## [Desktop Entry]
|
||||
## ...
|
||||
```
|
||||
|
||||
3. Right click the `obsidian.desktop` file on the Desktop, and click "Allow launching"
|
||||
|
||||
4. Double click the `obsidian.desktop` file.
|
||||
@@ -1,8 +1,10 @@
|
||||
# Minimal Intrusive Design
|
||||
|
||||
Before version 0.3.0, the plugin did not upload additional meta data to the remote.
|
||||
~~Before version 0.3.0, the plugin did not upload additional meta data to the remote.~~
|
||||
|
||||
From and after version 0.3.0, the plugin just upload minimal extra necessary meta data to the remote.
|
||||
~~From version 0.3.0 ~ 0.3.40, the plugin just upload minimal extra necessary meta data to the remote.~~
|
||||
|
||||
From version 0.4.1 and above, the plugin doesn't need uploading meta data due to the sync algorithm upgrade.
|
||||
|
||||
## Benefits
|
||||
|
||||
@@ -12,10 +14,14 @@ For example, it's possbile for a uses to manually upload a file to s3, and next
|
||||
|
||||
And it's also possible to combine another "sync-to-s3" solution (like, another software) on desktops, and this plugin on mobile devices, together.
|
||||
|
||||
## Necessarity Of Uploading Extra Metadata
|
||||
## ~~Necessarity Of Uploading Extra Metadata from 0.3.0 ~ 0.3.40~~
|
||||
|
||||
The main issue comes from deletions (and renamings which is actually interpreted as "deletion-then-creation").
|
||||
~~The main issue comes from deletions (and renamings which is actually interpreted as "deletion-then-creation").~~
|
||||
|
||||
If we don't upload any extra info to the remote, there's usually no way for the second device to know what files / folders have been deleted on the first device.
|
||||
~~If we don't upload any extra info to the remote, there's usually no way for the second device to know what files / folders have been deleted on the first device.~~
|
||||
|
||||
To overcome this issue, from and after version 0.3.0, the plugin uploads extra metadata files `_remotely-save-metadata-on-remote.{json,bin}` to users' configured cloud services. Those files contain some info about what has been deleted on the first device, so that the second device can read the list to apply the deletions to itself. Some other necessary meta info would also be written into the extra files.
|
||||
~~To overcome this issue, from and after version 0.3.0, the plugin uploads extra metadata files `_remotely-save-metadata-on-remote.{json,bin}` to users' configured cloud services. Those files contain some info about what has been deleted on the first device, so that the second device can read the list to apply the deletions to itself. Some other necessary meta info would also be written into the extra files.~~
|
||||
|
||||
## No uploading extra metadata from 0.4.1
|
||||
|
||||
Some information, including previous successful sync status of each file, is kept locally.
|
||||
|
||||
@@ -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.
|
||||

|
||||
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.
|
||||
|
||||

|
||||
|
||||
## 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.
|
||||

|
||||
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.
|
||||

|
||||
4. Sync and enjoy your PRO features!
|
||||
|
||||
## Why so complicated?
|
||||
|
||||
Because we don't have a 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 flexible 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,34 @@
|
||||
# Box (PRO)
|
||||
|
||||
# Links
|
||||
|
||||
<https://www.box.com/>
|
||||
|
||||
# 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.**
|
||||
@@ -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.
|
||||

|
||||
2. Click Auth, visit the link, go to Remotely Save website to start.
|
||||

|
||||
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.
|
||||

|
||||
5. You will be redirected to Remotely Save website, and you will get a code. Copy it...
|
||||

|
||||
6. ... And paste the code back to the plugin inside Obsidian. Click submit.
|
||||

|
||||
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 Google drive 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
|
||||
@@ -0,0 +1,38 @@
|
||||
# Koofr (PRO)
|
||||
|
||||
# Links
|
||||
|
||||
<https://koofr.eu/>
|
||||
|
||||
# Intro
|
||||
|
||||
* It's a PRO feature of Remotely Save plugin.
|
||||
* **This plugin is NOT an official Koofr product, and just uses Koofr'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 Koofr" 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 Koofr should be detected.
|
||||
|
||||
## Steps of Connecting to your Koofr
|
||||
|
||||
After you enabled the PRO feature in your Remotely Save plugin, you can connect to your Koofr account now.
|
||||
|
||||
1. In Remotely Save settings, change your sync service to Koofr.
|
||||
2. Click Auth, visit the link, go to Koofr website to start.
|
||||
3. Follow the instruction on Koofr, 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 Koofr 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.**
|
||||
|
||||
# Why not use webdav?
|
||||
|
||||
The Remotely Save PRO feture "sync with Koofr" is developed using Koofr's native API, instead of webdav interface. It brings benefits such that the last modified time can be preserved.
|
||||
@@ -0,0 +1,23 @@
|
||||
# OneDrive
|
||||
|
||||
- **This plugin is NOT an official Microsoft / OneDrive product.** The plugin just uses Microsoft's [OneDrive's public API](https://docs.microsoft.com/en-us/onedrive/developer/rest-api).
|
||||
- After the authorization, the plugin can read your name and email, and read and write files in your OneDrive's `/Apps/remotely-save` folder.
|
||||
- If you decide to authorize this plugin to connect to OneDrive, please go to plugin's settings, and choose OneDrive then follow the instructions.
|
||||
- Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
|
||||
- If you want to sync the files across multiple devices, **your vault name should be the same** while using default settings.
|
||||
|
||||
## FAQ
|
||||
|
||||
### How about OneDrive for Business?
|
||||
|
||||
This plugin only works for "OneDrive for personal", and not works for "OneDrive for Business" (yet). See [#11](https://github.com/fyears/remotely-save/issues/11) to further details.
|
||||
|
||||
### I cannot find `/Apps/remotely-save` folder
|
||||
|
||||
Mystically some users report that their OneDrive generate `/Application/Graph` instead of `/Apps/remotely-save`. See [#517](https://github.com/remotely-save/remotely-save/issues/517).
|
||||
|
||||
The solution is simple:
|
||||
|
||||
1. Backup your vault manually.
|
||||
2. Go to onedrive website (<https://onedrive.live.com/>), and rename `/Application/Graph` to `/Application/remotely-save` (right click on the folder and you will see rename option)
|
||||
3. Come back to Obsidian and try to sync!
|
||||
@@ -0,0 +1,40 @@
|
||||
# pCloud (PRO)
|
||||
|
||||
# Links
|
||||
|
||||
<https://www.pcloud.com/>
|
||||
|
||||
# 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.
|
||||
@@ -0,0 +1,53 @@
|
||||
# Backblaze B2
|
||||
|
||||
## Links
|
||||
|
||||
https://www.backblaze.com/cloud-storage
|
||||
|
||||
## Steps
|
||||
|
||||
1. Create a Backblaze account [on this page](https://www.backblaze.com/cloud-storage). Credit card info _is not_ required. Backblaze B2 offers 10 GB of free storage.
|
||||
|
||||
2. Please be aware that, though B2 provides some free quota, **it may still cost you money if the usage of storage or api requests exceed a certain value!!!** Especially pay attention to the api requests!!!
|
||||
|
||||
3. Create a **bucket**, you can leave the default settings, or you can enable the encryption (which is different from what you can set in Remotely Save):
|
||||
|
||||

|
||||

|
||||
|
||||
4. Copy `Endpoint`, eg. `s3.us-east-005.backblazeb2.com` — it'll be used later.
|
||||
|
||||
5. Copy `bucketname` near the 🪣 icon (the "bucket icon") — it'll be used later.
|
||||
|
||||

|
||||
|
||||
6. Go to **Application Keys**:
|
||||
|
||||

|
||||
|
||||
7. **Add a new key**:
|
||||
|
||||

|
||||

|
||||
|
||||
8. Save `keyID` and `applicationKey` — they will be used later.
|
||||
|
||||
9. Go to Remotely Save settings in Obsidian and:
|
||||
|
||||
- Choose `S3 or compatibile` in **Remote Service**:
|
||||
- Copy `Endpoint` from Backblaze (see 3. above) to `Endpoint` in Remotely Save
|
||||
- From `endpoint` take `region` (eg. `us-east-005`) and paste it in `endpoint` in Remotely Save
|
||||
- Copy `keyID` (see 7. above) to `Access Key ID` in Remotely Save
|
||||
- Copy `applicationKey` (see 7. above) to `Secret Access Key` in Remotely Save
|
||||
- Copy `bucketname` (see 4. above) to `Bucket Name` in Remotely Save
|
||||

|
||||
|
||||
10. **Enable Bypass CORS**:
|
||||

|
||||
|
||||
11. Click **Check** in _Check Connectivity_ to see if you can connect to B2 bucket:
|
||||

|
||||
|
||||
12. Sync!
|
||||
|
||||

|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:fae18a84bb218461aca01c7de47ddadfd2b451d865ec889c098cd6918f6e8773
|
||||
size 59679
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:9389f9c4462740371edb548f7e05191ede5277a5d470e3254c60fbcc4a75e552
|
||||
size 4558
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:46f35968938ebf3bbafae64ee49a4927844fd0abf79e4190522be91776d9fed0
|
||||
size 107623
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:7fb639c7b4e595516594ee9d07c864e7cd15b608a97c81386f4cf72d499d0e5f
|
||||
size 80121
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:299bfca82b77de86f60d8f481b5f74069dc977dece19fa025ee629d1e6f783d4
|
||||
size 6499
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:5985e918b521c91cc185f60c58cdd334ee76695b897a02e02eaa17c1bad71609
|
||||
size 10214
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:5796791bcf89c99c1e1e844c0083739fd46b1a458dc274f3c3fa3f65b87b71b3
|
||||
size 70728
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:3633379fcb12f1a5e0a4d1d68c193ddc7bf0be7edd92f2f6006351817035a94f
|
||||
size 27164
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:9e130be182ae7d3270e5de3fec442ac5e81efd61822e844cd61ed24c7e485d39
|
||||
size 16802
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:29a8971fea065fd86223850198640f4072ee3fda2112820829cda1348f122c59
|
||||
size 11103
|
||||
@@ -28,19 +28,12 @@ Using the principle of least privilege is crucial for security when allowing a t
|
||||
{
|
||||
"Version": "2012-10-17",
|
||||
"Statement": [
|
||||
{
|
||||
"Sid": "ObsidianBucket",
|
||||
"Effect": "Allow",
|
||||
"Action": [
|
||||
"s3:HeadBucket"
|
||||
],
|
||||
"Resource": "arn:aws:s3:::my-bucket"
|
||||
},
|
||||
{
|
||||
"Sid": "ObsidianObjects",
|
||||
"Effect": "Allow",
|
||||
"Action": [
|
||||
"s3:HeadObject",
|
||||
"s3:ListBucket",
|
||||
"s3:PutObject",
|
||||
"s3:CopyObject",
|
||||
"s3:UploadPart",
|
||||
@@ -56,7 +49,10 @@ Using the principle of least privilege is crucial for security when allowing a t
|
||||
"s3:DeleteObject",
|
||||
"s3:DeleteObjects"
|
||||
],
|
||||
"Resource": "arn:aws:s3:::my-bucket/*"
|
||||
"Resource": [
|
||||
"arn:aws:s3:::my-bucket",
|
||||
"arn:aws:s3:::my-bucket/*"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
# Storj
|
||||
|
||||
## Links
|
||||
|
||||
<https://www.storj.io/>
|
||||
|
||||
## Steps
|
||||
|
||||
1. Register an account. Login.
|
||||
2. Create a bucket.
|
||||
3. Create S3 Credentials in Access Management. Allow all permissions for the bucket. Remember the access key and secret key and the end point. The end point is likely to be [`https://gateway.storjshare.io`](https://docs.storj.io/dcs/api/s3/s3-compatible-gateway).
|
||||

|
||||

|
||||
4. Input your credentials into remotely-save settings. Region [should be `global`](https://docs.storj.io/dcs/api/s3/s3-compatibility).
|
||||

|
||||
5. Check connectivity.
|
||||
6. Sync!
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:a3484f74f45fbdae6110de285edeff10c196c13160cb97f079da77843ae92e80
|
||||
size 386188
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:42593d98e1b154f4174a932088e72c25db9a976b5613f4d6ae21df1445b4559c
|
||||
size 278219
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:7843c31153054eb4762dbaf3027c1042b0d7cb4dd774bf584788cd7a97ba4044
|
||||
size 571188
|
||||
@@ -0,0 +1,23 @@
|
||||
# Tencent Cloud COS
|
||||
|
||||
English | [中文](./README.zh-cn.md)
|
||||
|
||||
## Link
|
||||
|
||||
- international <https://console.tencentcloud.com/cos>
|
||||
|
||||
## 步骤 Steps
|
||||
|
||||
The example shows the steps of China version. International version should be similar.
|
||||
|
||||
1. Create a bucket with **private read-write permissions** and recommendly enable server-side-encryption.
|
||||
2. In bucket list page, enter the bucket overview page of the bucket you just created. You should see the bucket name (your texts with the number of your account id), region, and access address.
|
||||

|
||||
3. In CAM page, create api key, and note down the SecretID and SecretKey.
|
||||

|
||||
4. **Remove the bucket name from your access address to obtain your endpoint address! If your access address on the website is `https://<bucket-name-with-number>.cos.<region>.myqcloud.com`, then the endpoint address you are going to use is `https://cos.<region>.myqcloud.com`.**
|
||||
5. In remotely-save settings page, enter your endpoint adress, SecretID, SecretKey,and bucket name.
|
||||

|
||||
6. Check Connectivity.
|
||||

|
||||
7. Sync!
|
||||
@@ -0,0 +1,23 @@
|
||||
# 腾讯云 COS
|
||||
|
||||
[English](./README.md) | 中文
|
||||
|
||||
## 链接
|
||||
|
||||
- 中国区 <https://console.cloud.tencent.com/cos>
|
||||
|
||||
## 步骤
|
||||
|
||||
注意这里用中国区示例,国际区配置应该类似。
|
||||
|
||||
1. 在“存储桶列表”页,[“创建存储桶”](https://console.cloud.tencent.com/cos/bucket?action=create)。注意创建**私有读写**,建议打开服务端加密。
|
||||
2. 在桶列表页,点击刚刚存储的桶,进入概览页。可以见到桶名称(一般来说是之前指定的英文加账号数字),地域,访问域名。记录下来。
|
||||

|
||||
3. 在[“访问管理页”](https://console.cloud.tencent.com/cam/capi) ,“API 密钥管理”,“创建密钥”,要记录 SecretID 和 SecretKey。
|
||||

|
||||
4. **把桶名称从访问域名移除,才是你即将输入的服务地址!假如你在腾讯云网站看到访问域名是 `https://<bucket-name-with-number>.cos.<region>.myqcloud.com`,那么“服务地址”是 `https://cos.<region>.myqcloud.com`.**
|
||||
5. 在 remotely-save 设置,输入服务地址,SecretID,SecretKey,和 桶名称。
|
||||

|
||||
6. 检查连接。
|
||||

|
||||
7. 可以同步了!
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:08b47288686c8ef8c6426776f7df52411efe431966e8f7f2f9a3a8836ee4d6c6
|
||||
size 323127
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:94c0ec5db7a75c54c36224f067659682e271aea2e61b1ee50d046cd493ba72ac
|
||||
size 58410
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:f51f542756def80a77404e47f9793d1cd6917df5ab6e09d5a0ee1f7191855dc6
|
||||
size 425021
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:55064233031b44066fb7b77e17ba1eb1d0ae8398235a343cc7e137b07aaf7a39
|
||||
size 668954
|
||||
@@ -0,0 +1,24 @@
|
||||
# 又拍云
|
||||
|
||||
## 链接
|
||||
|
||||
- 官网 <https://www.upyun.com/>
|
||||
- 官网的 S3 文档 <https://help.upyun.com/knowledge-base/aws-s3%e5%85%bc%e5%ae%b9/>
|
||||
|
||||
## 注意!!!!!
|
||||
|
||||
又拍云似乎(?)文件都是默认公开的,强烈建议注意隐私问题,强烈建议设置插件加密。
|
||||
|
||||
## 步骤
|
||||
|
||||
1. 注册,新建对象存储。
|
||||
2. 参考官网文档 <https://help.upyun.com/knowledge-base/aws-s3%e5%85%bc%e5%ae%b9/>,创建操作员然后创建 S3 访问凭证。
|
||||
3. 在 Remotely Save 设置以下:
|
||||
- 服务地址(Endpoint):`s3.api.upyun.com` **一定是这个域名**
|
||||
- 区域(Region):`us-east-1`
|
||||
- Acccess Key ID:您获取到的访问凭证的 AccessKey
|
||||
- Secret Access Key:您获取到的访问凭证的 SecretAccessKey
|
||||
- 存储桶(Bucket)的名字:您创建的“服务名”
|
||||
- 是否生成文件夹 Object:不生成(默认) **一定要选择不生成**
|
||||
4. 可以在插件设置里,加上密码。
|
||||
5. 同步。
|
||||
@@ -1,22 +1,23 @@
|
||||
# AList
|
||||
|
||||
## 链接 Links
|
||||
English | [中文](./README.zh-cn.md)
|
||||
|
||||
## Links
|
||||
|
||||
- English official website: <https://alist.nn.ci/> and <https://alist.nn.ci/guide/webdav.html>
|
||||
- 中文官网:<https://alist.nn.ci/zh/> 和 <https://alist.nn.ci/zh/guide/webdav.html>
|
||||
|
||||
## 步骤 Steps
|
||||
## Steps
|
||||
|
||||
1. 安装和使用 AList。获取账号名和密码。在网页上登录。Install and run AList. Get the account and password. Login using the web page.
|
||||
2. 新建挂载,检查挂载路径。如图所示是 `/alisttest davpath`。Add new storage. Pay attention to the mount path. The screenshot shows the mount path as `/alisttest davpath`.
|
||||
1. Install and run AList. Get the account and password. Login using the web page.
|
||||
2. Add new storage. Pay attention to the mount path. The screenshot shows the mount path as `/alisttest davpath`.
|
||||

|
||||

|
||||
3. 从而构建 webdav 网址如下,**http(s)://域名** + **端口** + **`/dav`** + **挂载路径**,其中挂载路径中假如有空格,换成 `%20`:Construct the webdav address as: **http(s)://domain** + **port** + **`/dav`** + **mount path**, and the space inside the mount path should be replaced with `%20`:
|
||||
3. Construct the webdav address as: **http(s)://domain** + **port** + **`/dav`** + **mount path**, and the space inside the mount path should be replaced with `%20`:
|
||||
```
|
||||
http[s]://domain:port/dav/[mountpath url encoded]
|
||||
http://127.0.0.1:5244/dav/alisttest%20davpath
|
||||
```
|
||||
4. 在 remotely-save 设置,输入**带域名端口`/dav`和挂载路径的网址**、账号、密码。In remotely-save setting page, select webdav type, then input the **full address with mount path**/account/password.
|
||||
4. In remotely-save setting page, select webdav type, then input the **full address with mount path**/account/password.
|
||||

|
||||
5. 在 remotely-save 设置,检查连接。In remotely-save setting page, click "Check Connectivity".
|
||||
6. 同步文件!Sync!
|
||||
5. In remotely-save setting page, click "Check Connectivity".
|
||||
6. Sync!
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
# AList
|
||||
|
||||
[English](./README.md) | 中文
|
||||
|
||||
## 链接
|
||||
|
||||
- 中文官网:<https://alist.nn.ci/zh/> 和 <https://alist.nn.ci/zh/guide/webdav.html>
|
||||
|
||||
## 步骤
|
||||
|
||||
1. 安装和使用 AList。获取账号名和密码。在网页上登录。
|
||||
2. 新建挂载,检查挂载路径。如图所示是 `/alisttest davpath`。
|
||||

|
||||

|
||||
3. 从而构建 webdav 网址如下,**http(s)://域名** + **端口** + **`/dav`** + **挂载路径**,其中挂载路径中假如有空格,换成 `%20`:
|
||||
```
|
||||
http[s]://domain:port/dav/[mountpath url encoded]
|
||||
http://127.0.0.1:5244/dav/alisttest%20davpath
|
||||
```
|
||||
4. 在 remotely-save 设置,输入**带域名端口`/dav`和挂载路径的网址**、账号、密码。
|
||||

|
||||
5. 在 remotely-save 设置,检查连接。
|
||||
6. 同步文件!
|
||||
@@ -0,0 +1,62 @@
|
||||
# Apache Webdav
|
||||
|
||||
The following tutorial uses Apache with Docker in Linux, using the image [`bytemark/webdav`](https://hub.docker.com/r/bytemark/webdav/).
|
||||
|
||||
You can also checkout the official doc from Bytemark [here](https://docs.bytemark.co.uk/article/run-your-own-webdav-server-with-docker/). The tutorial you are reading here is a little different from Bytemark's article.
|
||||
|
||||
Assuming you want a webdav server on Linux satisfying that:
|
||||
|
||||
1. Data is saved in your host machine's `./dav1` folder,
|
||||
2. WebDAV is accessed by a user `user1` with password `password1`,
|
||||
3. WebDAV is accessed on the host machine and port 8080: `127.0.0.1:8080`.
|
||||
4. Use Basic auth type.
|
||||
|
||||
Install docker nd set its permission properly. Then run this in terminal:
|
||||
|
||||
```bash
|
||||
mkdir ./dav1 # create the local folder
|
||||
|
||||
docker container run --rm \
|
||||
-p 127.0.0.1:8080:80 \
|
||||
-v ./dav1:/var/lib/dav \
|
||||
-e USERNAME=user1 \
|
||||
-e PASSWORD=password1 \
|
||||
-e AUTH_TYPE=Basic \
|
||||
bytemark/webdav
|
||||
```
|
||||
|
||||
We do not have `--detach` prameter here, so the server will be closed as soon as you terminate the program or close terminal. You might want to adjust the settings further by yourself.
|
||||
|
||||
Then, in Remotely Save's setting, set these (auth type should always be `Basic`):
|
||||
|
||||
```
|
||||
Server: http://127.0.0.1:8080
|
||||
User: user1
|
||||
Password: password1
|
||||
Auth Type: Basic
|
||||
Depth Header Sent To Servers: only supports depth='1'
|
||||
```
|
||||
|
||||

|
||||
|
||||
Then the server should be connected! You can sync now!
|
||||
|
||||
In you host machine's file system, you should find some files and folders were added into the folder `./dav1`.
|
||||
|
||||
```
|
||||
ls ./dav1/
|
||||
## data DavLock DavLock.dir DavLock.pag
|
||||
|
||||
ls ./dav1/data/
|
||||
## <your vault name or your base dir>
|
||||
```
|
||||
|
||||
# Auth type
|
||||
|
||||
You can change the auth type while calling Docker, between `Basic` and `Digest`. And please rememberto adjust the Remotely Save's settings. Both works.
|
||||
|
||||
# Notice
|
||||
|
||||
1. **Never expose your webdav server to public networks without protections or without strong passwords!**
|
||||
2. I personally recommend using tailscale to build a LAN instead of expoing the service to public.
|
||||
3. If you want to connect to the server from iOS (iPhone / iPad), the https is required. I personally recommend using caddy as the reverse proxy. Caddy can also be combined with tailscale.
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:264e50d3adaeb4fc4e76b00273459d7d021f1b44af7f07b00a5c40741e65194d
|
||||
size 658482
|
||||
@@ -1,22 +1,22 @@
|
||||
# 坚果云 JianGuoYun/NutStore
|
||||
# JianGuoYun/NutStore
|
||||
|
||||
## 链接 Link
|
||||
English | [中文](./README.zh-cn.md)
|
||||
|
||||
## Link
|
||||
|
||||
<https://www.jianguoyun.com/>
|
||||
|
||||
## 注意!!!Attentions!!!
|
||||
|
||||
坚果云有限制 api 数量等设定。本插件会产生若干查询,如果文件较多很容易触发 api 上限,从而工作不正常。这不是插件 bug,也没有办法解决。
|
||||
## Attentions!!!
|
||||
|
||||
JianGuoYun/NutStore has api limits. The plugin may generate many queries, and it's possible to reach the api limits if there are many files, then do not work properly. It's not a bug and there's no way to fix this situation.
|
||||
|
||||
## 步骤 Steps
|
||||
## Steps
|
||||
|
||||
1. **知悉坚果云有 api 限制,本插件可能因此工作不正常。Be aware that JianGuoYun/NutStore has api limits, and the plugin may not work properly because of this.**
|
||||
2. 注册账号,登录。Register an account.
|
||||
3. 去“个人信息”->“安全”,“添加应用”,从而获取了 webDAV 账号(应该是 email)和 WebDAV 密码(一串特殊的字符,不等于网站密码)。Go to "settings"->"Security", click "Add Application", then obtain the WebDAV account (email), and WebDAV password (a string different from web site password).
|
||||
1. **Be aware that JianGuoYun/NutStore has api limits, and the plugin may not work properly because of this.**
|
||||
2. Register an account.
|
||||
3. Go to "settings"->"Security", click "Add Application", then obtain the WebDAV account (email), and WebDAV password (a string different from web site password).
|
||||

|
||||
4. 在 remotely-save 设置,输入网址、账号、密码、**“发送到服务器的 Depth Header”设置为“只支持 depth='1'”**。Input the WebDAV address, account, password, **Depth Header Sent To Servers="only supports depth='1'"** in remotely-save settings.
|
||||
4. Input the WebDAV address, account, password, **Depth Header Sent To Servers="only supports depth='1'"** in remotely-save settings.
|
||||

|
||||
5. 在 remotely-save 设置,检查连接。In remotely-save setting page, click "Check Connectivity".
|
||||
6. 同步文件!Sync!
|
||||
5. In remotely-save setting page, click "Check Connectivity".
|
||||
6. Sync!
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
# 坚果云
|
||||
|
||||
[English](./README.md) | 中文
|
||||
|
||||
## 链接
|
||||
|
||||
<https://www.jianguoyun.com/>
|
||||
|
||||
## 注意!!!
|
||||
|
||||
坚果云有限制 api 数量等设定。本插件会产生若干查询,如果文件较多很容易触发 api 上限,从而工作不正常。这不是插件 bug,也没有办法解决。
|
||||
|
||||
## 步骤
|
||||
|
||||
1. **知悉坚果云有 api 限制,本插件可能因此工作不正常。**
|
||||
2. 注册账号,登录。
|
||||
3. 去“个人信息”->“安全”,“添加应用”,从而获取了 webDAV 账号(应该是 email)和 WebDAV 密码(一串特殊的字符,不等于网站密码)。
|
||||

|
||||
4. 在 remotely-save 设置,输入网址、账号、密码、**“发送到服务器的 Depth Header”设置为“只支持 depth='1'”**。
|
||||

|
||||
5. 在 remotely-save 设置,检查连接。
|
||||
6. 同步文件!
|
||||
@@ -0,0 +1,13 @@
|
||||
# Nextcloud
|
||||
|
||||
## Link
|
||||
|
||||
<https://nextcloud.com/>
|
||||
|
||||
## Steps
|
||||
|
||||
1. Install, or find a hosted version.
|
||||
* The docker version <https://github.com/nextcloud/docker> for internal network, and [Caddy as reverse proxy](https://caddyserver.com/docs/quick-starts/reverse-proxy) (for https), are personally recommended.
|
||||
* If you find installing Nextcloud by yourselves is difficult, you can find some "Nextcloud's trusted, certified providers" on [Nextcloud Sign up page](https://nextcloud.com/sign-up/); For example, [The Good Cloud](https://thegood.cloud/) there generously provides 2 GB free stoarage space.
|
||||
* Remotely Save is tested to be working with the docker version and The Good Cloud.
|
||||
2. Go to Nextcloud's settings. Find the webdav url (something like `https://cloud.example.com/remote.php/dav/files/USERNAME`). Use this (without tailing slash), and your account and your password, in Remotely Save.
|
||||
@@ -0,0 +1,51 @@
|
||||
# Nginx Webdav
|
||||
|
||||
The following tutorial uses Nginx with Docker in Linux, using the image [docker-nginx-webdav-nononsense](https://github.com/dgraziotin/docker-nginx-webdav-nononsense). It contains `ngx_http_dav_module` and `nginx-dav-ext-module`.
|
||||
|
||||
The description is adapted from the pull request [`dgraziotin/docker-nginx-webdav-nononsense#123`](https://github.com/dgraziotin/docker-nginx-webdav-nononsense/pull/123) by Remotely Save author.
|
||||
|
||||
Assuming you want a webdav server on Linux satisfying that:
|
||||
|
||||
1. Data is saved in your host machine's `./dav1` folder,
|
||||
2. WebDAV is accessed by a user `user1` with password `password1`,
|
||||
3. WebDAV is accessed on the host machine and port 8080: `127.0.0.1:8080`.
|
||||
4. (Only Basic auth type is supported.)
|
||||
|
||||
Install docker nd set its permission properly. Then run this in terminal:
|
||||
|
||||
```bash
|
||||
mkdir ./dav1 # create the local folder
|
||||
|
||||
docker container run --rm \
|
||||
-p 127.0.0.1:8080:80 \
|
||||
-v ./dav1:/data \
|
||||
-e WEBDAV_USERNAME=user1 \
|
||||
-e WEBDAV_PASSWORD=password1 \
|
||||
-e PUID=1000 \
|
||||
-e PGID=1000 \
|
||||
dgraziotin/nginx-webdav-nononsense
|
||||
```
|
||||
|
||||
We do not have `--detach` prameter here, so the server will be closed as soon as you terminate the program or close terminal. You might want to adjust the settings further by yourself.
|
||||
|
||||
Then, in Remotely Save's setting, set these (auth type should always be `Basic`):
|
||||
|
||||
```
|
||||
Server: http://127.0.0.1:8080
|
||||
User: user1
|
||||
Password: password1
|
||||
Auth Type: Basic
|
||||
Depth Header Sent To Servers: only supports depth='1'
|
||||
```
|
||||
|
||||

|
||||
|
||||
Then the server should be connected! You can sync now!
|
||||
|
||||
In you host machine's file system, you should find some files and folders were added into the folder `./dav1`.
|
||||
|
||||
# Notice
|
||||
|
||||
1. **Never expose your webdav server to public networks without protections or without strong passwords!**
|
||||
2. I personally recommend using tailscale to build a LAN instead of expoing the service to public.
|
||||
3. If you want to connect to the server from iOS (iPhone / iPad), the https is required. I personally recommend using caddy as the reverse proxy. Caddy can also be combined with tailscale.
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:92059e0819d25640a02d2494ba9da0bfa7a69003cdba36ced985bed9e29b0354
|
||||
size 254978
|
||||
@@ -0,0 +1,21 @@
|
||||
# Open Media Vault WebDAV
|
||||
|
||||
## Link
|
||||
https://www.openmediavault.org
|
||||
|
||||
## Steps
|
||||
|
||||
1. In Open Media Vault's UI, install the WebDAV plugin:
|
||||
* System → Plugins → openmediavault-webdav
|
||||
2. Create a new Shared Folder
|
||||
* Storage → Shared Folders → Create
|
||||
3. Enable WebDAV server
|
||||
* Services → WedDAV → Enable → Select previously created Shared Folder
|
||||
4. Make sure Group is "webdav-users"
|
||||
5. Add {your username} to "webdav-users" group
|
||||
* Users → Groups → webdav-users → Edit → Members
|
||||
6. Set folder permissions
|
||||
* Storage → Shared Folders select the corresponding shared folder → Permissions → Set both {your username} and "webdav-users" group to "Read/Write" permissions
|
||||
7. Back to Shared Folders, set specific Access Control List permissions
|
||||
* Select the shared folder → Access Control List → set {your username}, "webdav-users" and "www-data" to "Read/Write" permissions
|
||||
8. Install Remotely Save in Obsidian, select WebDAV, add the URL http://[your-server-ip]/webdav, use your user credentials and connect.
|
||||
@@ -0,0 +1,55 @@
|
||||
# Synology Webdav Server
|
||||
|
||||
English | [中文](./README.zh-cn.md)
|
||||
|
||||
## Link
|
||||
|
||||
<https://kb.synology.com/en-global/DSM/tutorial/How_to_access_files_on_Synology_NAS_with_WebDAV>
|
||||
|
||||
## Attention
|
||||
|
||||
The tutorial author (the author of Remotely Save) is NOT an expert of NAS / Synology. Please read the doc carefully and change it to accommodate your needs by yourself.
|
||||
|
||||
**It's dangerous to expose your NAS into public Internet if you don't know how to set up firewalls and other protections.**
|
||||
|
||||
## Steps
|
||||
|
||||
Synology DSM 7 is used in this tutorial.
|
||||
|
||||
1. Create a new shared folder if you don't have one. For this tutorial, a new shared folder `share2` is created. You should assing a proper user to read / write the shared folder.
|
||||

|
||||
|
||||
2. Assuming you want to sync your vault into sub folder `哈哈哈/sub folder`, please create the sub folder(s) correspondingly inide the shared folder `share2`.
|
||||
|
||||
3. Install webdav server from package center.
|
||||

|
||||
|
||||
4. Enter the webdav server settings.
|
||||
|
||||
5. If you know how to configure https certificates correctly, you are strongly recommend to enable https.
|
||||
|
||||
For the demonstration purpose, this tutorial enable http server for the later steps.
|
||||
|
||||
Also "Enable DavDepthInfinity", which could speed up the plugin runnings greatly.
|
||||
|
||||
"Apply".
|
||||
|
||||

|
||||
|
||||
6. In Remotely Save settings, you should input your address as:
|
||||
|
||||
`http(s)://<your synology ip or domain>:<port>/<shared folder>/<sub folders>`
|
||||
|
||||
For example, in the tutorial, the proper url should be:
|
||||
|
||||
`http://<ip>:5000/share2/哈哈哈/sub folder`
|
||||
|
||||
Username and password should be the user you configured before with read / write permissions to `share2`.
|
||||
|
||||
Depth header should be "supports depth="infinity"".
|
||||
|
||||
Check connectivity!
|
||||
|
||||

|
||||
|
||||
7. Sync!
|
||||
@@ -0,0 +1,56 @@
|
||||
# 群晖 Webdav Server
|
||||
|
||||
[English](./README.md) | 中文
|
||||
|
||||
## 链接
|
||||
|
||||
<https://kb.synology.cn/zh-cn/DSM/tutorial/How_to_access_files_on_Synology_NAS_with_WebDAV>
|
||||
|
||||
## 注意
|
||||
|
||||
教程作者(Remotely Save 作者)**不是** NAS、群晖专家。请仔细阅读文档,并自行改动以适应您自身需求。
|
||||
|
||||
**没有设置防火墙和其他保护措施的话,将 NAS 暴露到公网上非常危险。**
|
||||
|
||||
## 步骤
|
||||
|
||||
本教程有用到群晖 DSM 7。
|
||||
|
||||
1. 创建共享文件夹。本教程示例创建了 `share2`。你需要允许某个账号对此的读写权限。
|
||||
|
||||

|
||||
|
||||
2. 假设之后你想同步你的库到子文件夹,`哈哈哈/sub folder`,请先在共享文件夹 `share2` 底下创建好。
|
||||
|
||||
3. 从套件中心安装 webdav server 。
|
||||

|
||||
|
||||
4. 进入 webdav server 设置。
|
||||
|
||||
5. 如果你知道如何正确配置 https 证书的话,强烈建议开启 https。
|
||||
|
||||
本教程简化示例,开启了 http。
|
||||
|
||||
也设置“Enable DavDepthInfinity”,这可以加速插件连接速度。
|
||||
|
||||
“Apply”。
|
||||
|
||||

|
||||
|
||||
6. 在 Remotely Save 设置页,你的地址应如下格式输入:
|
||||
|
||||
`http(s)://<your synology ip or domain>:<port>/<shared folder>/<sub folders>`
|
||||
|
||||
比如说,本教程里,正确的地址类似于:
|
||||
|
||||
`http://<ip>:5000/share2/哈哈哈/sub folder`
|
||||
|
||||
用户名和密码是你之前配置了允许读写 `share2` 的那个账号。
|
||||
|
||||
Depth 设置应为“supports depth="infinity"”。
|
||||
|
||||
检查连接!
|
||||
|
||||

|
||||
|
||||
7. 同步!
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:71e61c25db793c00d4406ea0f46745941e16e268a41b7328b03a183ab0706ec8
|
||||
size 59700
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:0f0725099989b5496048c0e3cb284b4f6537d66866b4618c8e73ee758cb2b642
|
||||
size 174986
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:7bc6d03a9deb0e8babd2ed102e7b85ee1062797abf1146ae71f80237a852ff10
|
||||
size 522084
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:ba3781f24b5d65ee6915d496f7542c569116141cdced24ca505f4373d9efa9df
|
||||
size 536163
|
||||
@@ -0,0 +1,9 @@
|
||||
# The Good Cloud
|
||||
|
||||
## Link
|
||||
|
||||
<https://thegood.cloud/>
|
||||
|
||||
## Steps
|
||||
|
||||
It's a hosted version of Nextcloud providing 2GB free spaces. See [NextCloud](../webdav_nextcloud/README.md) for more instructions.
|
||||
@@ -0,0 +1,35 @@
|
||||
# Webdis
|
||||
|
||||
## Links
|
||||
|
||||
- Webdis: <https://github.com/nicolasff/webdis>
|
||||
- Redis®: <https://redis.io/>
|
||||
|
||||
## Explanation and Background
|
||||
|
||||
I like the Redis® software very much, and would like to experiment using it as a "file storage". It seems to be nature by using path as the key and the content as the value (Sort of..., see below).
|
||||
|
||||
However, Redis® works by using TCP connections, and browser js cannot establish raw TCP connections. We need a HTTP gateway, to provide the HTTP api. Wedis seems to be the most famous open source one.
|
||||
|
||||
And of course, this method should work for Redis® alternatives: Valkey, Redict, KeyDB, Dragonfly, Garnet, ...
|
||||
|
||||
## Disclaimer
|
||||
|
||||
This app is NOT an official Redis® Ltd / Redis® OSS / Webdis product. Redis is a registered trademark of Redis Ltd.
|
||||
|
||||
**Never expose your Redis® or Webdis to public without security protection!!!** You are response for protecting your server.
|
||||
|
||||
## Usage
|
||||
|
||||
1. Install Redis®.
|
||||
2. Install Webdis.
|
||||
3. In `webdis.json`, configure the ACL for using password and username, and / or ip filters. **Never expose your Redis® or Webdis to public without security protection!!!**.
|
||||
4. Install and configure reverse proxy, firewall, https, etc. (You have to configure HTTPS correctly if you want to use it on iOS)
|
||||
5. In Remotely Save settings, enter your server address, username, password, and adjust the "base dir". Check connection.
|
||||
6. Sync!
|
||||
7. Serveral keys and values will be generated in your Redis® database:
|
||||
|
||||
```
|
||||
rs:fs:v1:${encodeURIComponent(vaultName+'/'+folderStructure+'/'+fileName)}:meta # you can HGETALL it
|
||||
rs:fs:v1:${encodeURIComponent(vaultName+'/'+folderStructure+'/'+fileName)}:content # you can GET it
|
||||
```
|
||||
@@ -0,0 +1,44 @@
|
||||
# Yandex Disk (PRO)
|
||||
|
||||
# Links
|
||||
|
||||
<https://disk.yandex.com/client/disk>
|
||||
|
||||
# Intro
|
||||
|
||||
* It's a PRO feature of Remotely Save plugin.
|
||||
* **This plugin is NOT an official Yandex Disk or Yandex product, and just uses Yandex Disk'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 Yandex Disk" 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 Yandex Disk should be detected.
|
||||
|
||||
## Steps of Connecting to your Yandex Disk
|
||||
|
||||
After you enabled the PRO feature in your Remotely Save plugin, you can connect to your Yandex Disk account now.
|
||||
|
||||
1. In Remotely Save settings, change your sync service to Yandex Disk.
|
||||
2. Click Auth, visit the link, go to Yandex Disk website to start.
|
||||
3. Follow the instruction on Yandex Disk, 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 Yandex Disk 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.**
|
||||
|
||||
# Why not use webdav?
|
||||
|
||||
1. The Remotely Save PRO feture "sync with Yandex Disk" is developed using Yandex Disk's native API, instead of webdav interface. It brings benefits such that the last modified time can be preserved.
|
||||
2. Some users prefer oauth2 method to authorize themselves.
|
||||
|
||||
# Bonus: where to register the app
|
||||
|
||||
* <https://oauth.yandex.com/client/new/> or <https://oauth.yandex.ru/client/new/>
|
||||
* redirect uri can be set to <https://oauth.yandex.com/verification_code> or <https://oauth.yandex.ru/verification_code>.
|
||||
@@ -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. |
|
||||
| <https://put.io/> | ? | | | ? |
|
||||
| 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. |
|
||||
|
||||
@@ -0,0 +1,7 @@
|
||||
# Sync Algorithm
|
||||
|
||||
- [v1](./v1/README.md)
|
||||
- [v2](./v2/README.md)
|
||||
- v3
|
||||
- [intro doc for end users](./v3/intro.md)
|
||||
- [design doc](./v3/design.md)
|
||||
@@ -0,0 +1,4 @@
|
||||
# Sync Algorithm V3
|
||||
|
||||
- [intro doc for end users](./intro.md)
|
||||
- [design doc](./design.md)
|
||||
@@ -0,0 +1,89 @@
|
||||
# Sync Algorithm V3
|
||||
|
||||
Drafted on 20240117.
|
||||
|
||||
An absolutely better sync algorithm. Better for tracking deletions and better for subbranching.
|
||||
|
||||
## Huge Thanks
|
||||
|
||||
Basically a combination of algorithm v2 + [synclone](https://github.com/Jwink3101/syncrclone/blob/master/docs/algorithm.md) + [rsinc](https://github.com/ConorWilliams/rsinc) + (some of rclone [bisync](https://rclone.org/bisync/)). All of the later three are released under MIT License so no worries about the licenses.
|
||||
|
||||
## Features
|
||||
|
||||
Must have
|
||||
|
||||
1. true deletion detection
|
||||
2. deletion protection (blocking) with a setting
|
||||
3. transaction from the old algorithm
|
||||
4. user warning show up, **new algorithm needs all clients to be updated!** (deliberately corrput the metadata file??)
|
||||
5. filters
|
||||
6. conflict warning
|
||||
7. partial sync
|
||||
|
||||
Nice to have
|
||||
|
||||
1. true time and hash
|
||||
2. conflict rename
|
||||
|
||||
## Description
|
||||
|
||||
We have _five_ input sources:
|
||||
|
||||
1. local all files
|
||||
2. remote all files
|
||||
3. _local previous succeeded sync history_
|
||||
4. local deletions
|
||||
5. remote deletions.
|
||||
|
||||
Init run, consuming remote deletions :
|
||||
|
||||
Change history data into _local previous succeeded sync history_.
|
||||
|
||||
Later runs, use the first, second, third sources **only**.
|
||||
|
||||
Bidirectional table is modified based on synclone and rsinc. Incremental push / pull only tables is further modified based on the bidirectional table. The number inside the table cell is the decision branch in the code.
|
||||
|
||||
Bidirectional:
|
||||
|
||||
| local\remote | remote unchanged | remote modified | remote deleted | remote created |
|
||||
| --------------- | ------------------ | ------------------------- | ------------------ | ------------------------- |
|
||||
| local unchanged | (02/21) do nothing | (09) pull | (07) delete local | (??) conflict |
|
||||
| local modified | (10) push | (16/17/18/19/20) conflict | (08) push | (??) conflict |
|
||||
| local deleted | (04) delete remote | (05) pull | (01) clean history | (03) pull |
|
||||
| local created | (??) conflict | (??) conflict | (06) push | (11/12/13/14/15) conflict |
|
||||
|
||||
Incremental push:
|
||||
|
||||
| local\remote | remote unchanged | remote modified | remote deleted | remote created |
|
||||
| --------------- | ---------------------------- | ---------------------------- | ---------------------- | ---------------------------- |
|
||||
| local unchanged | (02/21) do nothing | **(26) conflict push** | **(32) conflict push** | (??) conflict |
|
||||
| local modified | (10) push | **(25) conflict push** | (08) push | (??) conflict |
|
||||
| local deleted | **(29) conflict do nothing** | **(30) conflict do nothing** | (01) clean history | **(28) conflict do nothing** |
|
||||
| local created | (??) conflict | (??) conflict | (06) push | **(23) conflict push** |
|
||||
|
||||
Incremental pull:
|
||||
|
||||
| local\remote | remote unchanged | remote modified | remote deleted | remote created |
|
||||
| --------------- | ---------------------- | ---------------------- | ---------------------------- | ---------------------- |
|
||||
| local unchanged | (02/21) do nothing | (09) pull | **(33) conflict do nothing** | (??) conflict |
|
||||
| local modified | **(27) conflict pull** | **(24) conflict pull** | **(34) conflict do nothing** | (??) conflict |
|
||||
| local deleted | **(35) conflict pull** | (05) pull | (01) clean history | (03) pull |
|
||||
| local created | (??) conflict | (??) conflict | **(31) conflict do nothing** | **(22) conflict pull** |
|
||||
|
||||
Incremental push and delete (diff decisionBranch: 38):
|
||||
|
||||
| local\remote | remote unchanged | remote modified | remote deleted | remote created |
|
||||
| --------------- | ---------------------------- | ---------------------------- | ---------------------- | ---------------------------- |
|
||||
| local unchanged | (02/21) do nothing | **(26) conflict push** | **(32) conflict push** | (??) conflict |
|
||||
| local modified | (10) push | **(25) conflict push** | (08) push | (??) conflict |
|
||||
| local deleted | **(38) delete remote** | **(30) conflict do nothing** | (01) clean history | **(28) conflict do nothing** |
|
||||
| local created | (??) conflict | (??) conflict | (06) push | **(23) conflict push** |
|
||||
|
||||
Incremental pull and delete (diff decisionBranch: 39):
|
||||
|
||||
| local\remote | remote unchanged | remote modified | remote deleted | remote created |
|
||||
| --------------- | ---------------------- | ---------------------- | ---------------------------- | ---------------------- |
|
||||
| local unchanged | (02/21) do nothing | (09) pull | **(39) delete local** | (??) conflict |
|
||||
| local modified | **(27) conflict pull** | **(24) conflict pull** | **(34) conflict do nothing** | (??) conflict |
|
||||
| local deleted | **(35) conflict pull** | (05) pull | (01) clean history | (03) pull |
|
||||
| local created | (??) conflict | (??) conflict | **(31) conflict do nothing** | **(22) conflict pull** |
|
||||
@@ -0,0 +1,14 @@
|
||||
# Introduction To Sync Algorithm V3
|
||||
|
||||
- [x] sync conflict: keep newer
|
||||
- [x] sync conflict: keep larger
|
||||
- [ ] sync conflict: keep both and rename
|
||||
- [ ] sync conflict: show warning
|
||||
- [x] deletion: true deletion status computation
|
||||
- [x] meta data: no remote meta data any more
|
||||
- [x] migration: old data auto transfer to new db (hopefully)
|
||||
- [x] sync direction: incremental push only
|
||||
- [x] sync direction: incremental pull only
|
||||
- [x] sync protection: warning based on the threshold
|
||||
- [ ] partial sync: better sync on save
|
||||
- [x] encrpytion: new encryption method, see [this](../../encryption/)
|
||||
+30
-1
@@ -1,5 +1,6 @@
|
||||
import dotenv from "dotenv/config";
|
||||
import "dotenv/config";
|
||||
import esbuild from "esbuild";
|
||||
import inlineWorkerPlugin from "esbuild-plugin-inline-worker";
|
||||
import process from "process";
|
||||
// import builtins from 'builtin-modules'
|
||||
|
||||
@@ -16,6 +17,20 @@ const prod = process.argv[2] === "production";
|
||||
const DEFAULT_DROPBOX_APP_KEY = process.env.DROPBOX_APP_KEY || "";
|
||||
const DEFAULT_ONEDRIVE_CLIENT_ID = process.env.ONEDRIVE_CLIENT_ID || "";
|
||||
const DEFAULT_ONEDRIVE_AUTHORITY = process.env.ONEDRIVE_AUTHORITY || "";
|
||||
const DEFAULT_REMOTELYSAVE_WEBSITE = process.env.REMOTELYSAVE_WEBSITE || "";
|
||||
const DEFAULT_REMOTELYSAVE_CLIENT_ID = process.env.REMOTELYSAVE_CLIENT_ID || "";
|
||||
const DEFAULT_GOOGLEDRIVE_CLIENT_ID = process.env.GOOGLEDRIVE_CLIENT_ID || "";
|
||||
const DEFAULT_GOOGLEDRIVE_CLIENT_SECRET =
|
||||
process.env.GOOGLEDRIVE_CLIENT_SECRET || "";
|
||||
const DEFAULT_BOX_CLIENT_ID = process.env.BOX_CLIENT_ID || "";
|
||||
const DEFAULT_BOX_CLIENT_SECRET = process.env.BOX_CLIENT_SECRET || "";
|
||||
const DEFAULT_PCLOUD_CLIENT_ID = process.env.PCLOUD_CLIENT_ID || "";
|
||||
const DEFAULT_PCLOUD_CLIENT_SECRET = process.env.PCLOUD_CLIENT_SECRET || "";
|
||||
const DEFAULT_YANDEXDISK_CLIENT_ID = process.env.YANDEXDISK_CLIENT_ID || "";
|
||||
const DEFAULT_YANDEXDISK_CLIENT_SECRET =
|
||||
process.env.YANDEXDISK_CLIENT_SECRET || "";
|
||||
const DEFAULT_KOOFR_CLIENT_ID = process.env.KOOFR_CLIENT_ID || "";
|
||||
const DEFAULT_KOOFR_CLIENT_SECRET = process.env.KOOFR_CLIENT_SECRET || "";
|
||||
|
||||
esbuild
|
||||
.context({
|
||||
@@ -35,6 +50,7 @@ esbuild
|
||||
"net",
|
||||
"http",
|
||||
"https",
|
||||
"vm",
|
||||
// ...builtins
|
||||
],
|
||||
inject: ["./esbuild.injecthelper.mjs"],
|
||||
@@ -50,10 +66,23 @@ esbuild
|
||||
"process.env.DEFAULT_DROPBOX_APP_KEY": `"${DEFAULT_DROPBOX_APP_KEY}"`,
|
||||
"process.env.DEFAULT_ONEDRIVE_CLIENT_ID": `"${DEFAULT_ONEDRIVE_CLIENT_ID}"`,
|
||||
"process.env.DEFAULT_ONEDRIVE_AUTHORITY": `"${DEFAULT_ONEDRIVE_AUTHORITY}"`,
|
||||
"process.env.DEFAULT_REMOTELYSAVE_WEBSITE": `"${DEFAULT_REMOTELYSAVE_WEBSITE}"`,
|
||||
"process.env.DEFAULT_REMOTELYSAVE_CLIENT_ID": `"${DEFAULT_REMOTELYSAVE_CLIENT_ID}"`,
|
||||
"process.env.DEFAULT_GOOGLEDRIVE_CLIENT_ID": `"${DEFAULT_GOOGLEDRIVE_CLIENT_ID}"`,
|
||||
"process.env.DEFAULT_GOOGLEDRIVE_CLIENT_SECRET": `"${DEFAULT_GOOGLEDRIVE_CLIENT_SECRET}"`,
|
||||
"process.env.DEFAULT_BOX_CLIENT_ID": `"${DEFAULT_BOX_CLIENT_ID}"`,
|
||||
"process.env.DEFAULT_BOX_CLIENT_SECRET": `"${DEFAULT_BOX_CLIENT_SECRET}"`,
|
||||
"process.env.DEFAULT_PCLOUD_CLIENT_ID": `"${DEFAULT_PCLOUD_CLIENT_ID}"`,
|
||||
"process.env.DEFAULT_PCLOUD_CLIENT_SECRET": `"${DEFAULT_PCLOUD_CLIENT_SECRET}"`,
|
||||
"process.env.DEFAULT_YANDEXDISK_CLIENT_ID": `"${DEFAULT_YANDEXDISK_CLIENT_ID}"`,
|
||||
"process.env.DEFAULT_YANDEXDISK_CLIENT_SECRET": `"${DEFAULT_YANDEXDISK_CLIENT_SECRET}"`,
|
||||
"process.env.DEFAULT_KOOFR_CLIENT_ID": `"${DEFAULT_KOOFR_CLIENT_ID}"`,
|
||||
"process.env.DEFAULT_KOOFR_CLIENT_SECRET": `"${DEFAULT_KOOFR_CLIENT_SECRET}"`,
|
||||
global: "window",
|
||||
"process.env.NODE_DEBUG": `undefined`, // ugly fix
|
||||
"process.env.DEBUG": `undefined`, // ugly fix
|
||||
},
|
||||
plugins: [inlineWorkerPlugin()],
|
||||
})
|
||||
.then((context) => {
|
||||
if (process.argv.includes("--watch")) {
|
||||
|
||||
@@ -1,2 +1,2 @@
|
||||
export let Buffer = require("buffer").Buffer;
|
||||
export let process = require("process/browser");
|
||||
export const Buffer = require("buffer").Buffer;
|
||||
export const process = require("process/browser");
|
||||
|
||||
+3
-2
@@ -1,10 +1,11 @@
|
||||
{
|
||||
"id": "remotely-save",
|
||||
"name": "Remotely Save",
|
||||
"version": "0.3.32",
|
||||
"version": "0.5.6",
|
||||
"minAppVersion": "0.13.21",
|
||||
"description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
|
||||
"author": "fyears",
|
||||
"authorUrl": "https://github.com/fyears",
|
||||
"isDesktopOnly": false
|
||||
"isDesktopOnly": false,
|
||||
"fundingUrl": "https://remotelysave.com"
|
||||
}
|
||||
|
||||
+3
-2
@@ -1,10 +1,11 @@
|
||||
{
|
||||
"id": "remotely-save",
|
||||
"name": "Remotely Save",
|
||||
"version": "0.3.25",
|
||||
"version": "0.5.6",
|
||||
"minAppVersion": "0.13.21",
|
||||
"description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
|
||||
"author": "fyears",
|
||||
"authorUrl": "https://github.com/fyears",
|
||||
"isDesktopOnly": false
|
||||
"isDesktopOnly": false,
|
||||
"fundingUrl": "https://remotelysave.com"
|
||||
}
|
||||
|
||||
+44
-36
@@ -1,87 +1,96 @@
|
||||
{
|
||||
"name": "remotely-save",
|
||||
"version": "0.3.25",
|
||||
"version": "0.5.6",
|
||||
"description": "This is yet another sync plugin for Obsidian app.",
|
||||
"scripts": {
|
||||
"dev2": "node esbuild.config.mjs --watch",
|
||||
"build2": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
|
||||
"build": "webpack --mode production",
|
||||
"dev": "webpack --mode development --watch",
|
||||
"format": "npx prettier --trailing-comma es5 --write .",
|
||||
"format": "npx @biomejs/biome check --apply .",
|
||||
"clean": "npx rimraf main.js",
|
||||
"test": "cross-env TS_NODE_COMPILER_OPTIONS={\\\"module\\\":\\\"commonjs\\\"} mocha -r ts-node/register 'tests/**/*.ts'"
|
||||
"test": "cross-env TS_NODE_COMPILER_OPTIONS={\\\"module\\\":\\\"commonjs\\\"} mocha -r ts-node/register 'tests/**/*.ts' 'pro/tests/**/*.ts'"
|
||||
},
|
||||
"browser": {
|
||||
"path": "path-browserify",
|
||||
"process": "process/browser",
|
||||
"stream": "stream-browserify",
|
||||
"crypto": "crypto-browserify",
|
||||
"url": "url/"
|
||||
"url": "url/",
|
||||
"fs": false,
|
||||
"vm": false
|
||||
},
|
||||
"source": "main.ts",
|
||||
"keywords": [],
|
||||
"author": "",
|
||||
"license": "Apache-2.0",
|
||||
"license": "SEE LICENSE IN LICENSE",
|
||||
"devDependencies": {
|
||||
"@biomejs/biome": "1.7.3",
|
||||
"@microsoft/microsoft-graph-types": "^2.40.0",
|
||||
"@types/chai": "^4.3.11",
|
||||
"@types/chai": "^4.3.14",
|
||||
"@types/chai-as-promised": "^7.1.8",
|
||||
"@types/jsdom": "^21.1.6",
|
||||
"@types/lodash": "^4.14.202",
|
||||
"@types/lodash": "^4.17.0",
|
||||
"@types/mime-types": "^2.1.4",
|
||||
"@types/mocha": "^10.0.6",
|
||||
"@types/mustache": "^4.2.5",
|
||||
"@types/node": "^20.10.4",
|
||||
"@types/node": "^20.12.7",
|
||||
"@types/qrcode": "^1.5.5",
|
||||
"builtin-modules": "^3.3.0",
|
||||
"chai": "^4.3.10",
|
||||
"chai-as-promised": "^7.1.1",
|
||||
"cross-env": "^7.0.3",
|
||||
"dotenv": "^16.3.1",
|
||||
"esbuild": "^0.19.9",
|
||||
"jsdom": "^23.0.1",
|
||||
"mocha": "^10.2.0",
|
||||
"npm-check-updates": "^16.14.12",
|
||||
"obsidian": "^1.4.11",
|
||||
"prettier": "^3.1.1",
|
||||
"dotenv": "^16.4.5",
|
||||
"esbuild": "^0.20.2",
|
||||
"esbuild-plugin-inline-worker": "^0.1.1",
|
||||
"jsdom": "^24.0.0",
|
||||
"mocha": "^10.4.0",
|
||||
"npm-check-updates": "^16.14.20",
|
||||
"obsidian": "^1.5.7",
|
||||
"openapi-typescript": "^7.0.0-rc.0",
|
||||
"ts-loader": "^9.5.1",
|
||||
"ts-node": "^10.9.2",
|
||||
"tslib": "^2.6.2",
|
||||
"typescript": "^5.3.3",
|
||||
"typescript": "^5.4.5",
|
||||
"webdav-server": "^2.6.2",
|
||||
"webpack": "^5.89.0",
|
||||
"webpack-cli": "^5.1.4"
|
||||
"webpack": "^5.91.0",
|
||||
"webpack-cli": "^5.1.4",
|
||||
"worker-loader": "^3.0.8"
|
||||
},
|
||||
"dependencies": {
|
||||
"@aws-sdk/client-s3": "^3.474.0",
|
||||
"@aws-sdk/lib-storage": "^3.474.0",
|
||||
"@aws-sdk/signature-v4-crt": "^3.474.0",
|
||||
"@aws-sdk/types": "^3.468.0",
|
||||
"@azure/msal-node": "^2.6.0",
|
||||
"@aws-sdk/client-s3": "^3.563.0",
|
||||
"@aws-sdk/lib-storage": "^3.563.0",
|
||||
"@aws-sdk/signature-v4-crt": "^3.556.0",
|
||||
"@aws-sdk/types": "^3.535.0",
|
||||
"@azure/msal-node": "^2.7.0",
|
||||
"@fyears/rclone-crypt": "^0.0.7",
|
||||
"@fyears/tsqueue": "^1.0.1",
|
||||
"@microsoft/microsoft-graph-client": "^3.0.7",
|
||||
"@smithy/fetch-http-handler": "^2.3.1",
|
||||
"@smithy/protocol-http": "^3.0.11",
|
||||
"@smithy/querystring-builder": "^2.0.15",
|
||||
"acorn": "^8.11.2",
|
||||
"@sanity/diff-match-patch": "^3.1.1",
|
||||
"@smithy/fetch-http-handler": "^2.5.0",
|
||||
"@smithy/protocol-http": "^3.3.0",
|
||||
"@smithy/querystring-builder": "^2.2.0",
|
||||
"acorn": "^8.11.3",
|
||||
"aggregate-error": "^5.0.0",
|
||||
"assert": "^2.1.0",
|
||||
"aws-crt": "^1.20.0",
|
||||
"aws-crt": "^1.21.2",
|
||||
"box-typescript-sdk-gen": "^1.0.0",
|
||||
"buffer": "^6.0.3",
|
||||
"crypto-browserify": "^3.12.0",
|
||||
"delay": "^6.0.0",
|
||||
"dropbox": "^10.34.0",
|
||||
"emoji-regex": "^10.3.0",
|
||||
"http-status-codes": "^2.3.0",
|
||||
"localforage": "^1.10.0",
|
||||
"localforage-getitems": "^1.4.2",
|
||||
"localforage-removeitems": "^1.4.0",
|
||||
"lodash": "^4.17.21",
|
||||
"loglevel": "^1.8.1",
|
||||
"lucide": "^0.298.0",
|
||||
"lucide": "^0.376.1",
|
||||
"mime-types": "^2.1.35",
|
||||
"mustache": "^4.2.0",
|
||||
"nanoid": "^5.0.4",
|
||||
"nanoid": "^5.0.7",
|
||||
"node-diff3": "^3.1.2",
|
||||
"openapi-fetch": "^0.9.7",
|
||||
"p-queue": "^8.0.1",
|
||||
"path-browserify": "^1.0.1",
|
||||
"pcloud-sdk-js": "^2.0.0",
|
||||
"process": "^0.11.10",
|
||||
"qrcode": "^1.5.3",
|
||||
"rfc4648": "^1.5.3",
|
||||
@@ -89,8 +98,7 @@
|
||||
"stream-browserify": "^3.0.0",
|
||||
"url": "^0.11.3",
|
||||
"util": "^0.12.5",
|
||||
"webdav": "^5.3.1",
|
||||
"webdav-fs": "^4.0.1",
|
||||
"webdav": "^5.6.0",
|
||||
"xregexp": "^5.1.1"
|
||||
}
|
||||
}
|
||||
|
||||
+104
@@ -0,0 +1,104 @@
|
||||
# PolyForm Strict License 1.0.0
|
||||
|
||||
<https://polyformproject.org/licenses/strict/1.0.0>
|
||||
|
||||
## Acceptance
|
||||
|
||||
In order to get any license under these terms, you must agree
|
||||
to them as both strict obligations and conditions to all
|
||||
your licenses.
|
||||
|
||||
## Copyright License
|
||||
|
||||
The licensor grants you a copyright license for the software
|
||||
to do everything you might do with the software that would
|
||||
otherwise infringe the licensor's copyright in it for any
|
||||
permitted purpose, other than distributing the software or
|
||||
making changes or new works based on the software.
|
||||
|
||||
## Patent License
|
||||
|
||||
The licensor grants you a patent license for the software that
|
||||
covers patent claims the licensor can license, or becomes able
|
||||
to license, that you would infringe by using the software.
|
||||
|
||||
## Noncommercial Purposes
|
||||
|
||||
Any noncommercial purpose is a permitted purpose.
|
||||
|
||||
## Personal Uses
|
||||
|
||||
Personal use for research, experiment, and testing for
|
||||
the benefit of public knowledge, personal study, private
|
||||
entertainment, hobby projects, amateur pursuits, or religious
|
||||
observance, without any anticipated commercial application,
|
||||
is use for a permitted purpose.
|
||||
|
||||
## Noncommercial Organizations
|
||||
|
||||
Use by any charitable organization, educational institution,
|
||||
public research organization, public safety or health
|
||||
organization, environmental protection organization,
|
||||
or government institution is use for a permitted purpose
|
||||
regardless of the source of funding or obligations resulting
|
||||
from the funding.
|
||||
|
||||
## Fair Use
|
||||
|
||||
You may have "fair use" rights for the software under the
|
||||
law. These terms do not limit them.
|
||||
|
||||
## No Other Rights
|
||||
|
||||
These terms do not allow you to sublicense or transfer any of
|
||||
your licenses to anyone else, or prevent the licensor from
|
||||
granting licenses to anyone else. These terms do not imply
|
||||
any other licenses.
|
||||
|
||||
## Patent Defense
|
||||
|
||||
If you make any written claim that the software infringes or
|
||||
contributes to infringement of any patent, your patent license
|
||||
for the software granted under these terms ends immediately. If
|
||||
your company makes such a claim, your patent license ends
|
||||
immediately for work on behalf of your company.
|
||||
|
||||
## Violations
|
||||
|
||||
The first time you are notified in writing that you have
|
||||
violated any of these terms, or done anything with the software
|
||||
not covered by your licenses, your licenses can nonetheless
|
||||
continue if you come into full compliance with these terms,
|
||||
and take practical steps to correct past violations, within
|
||||
32 days of receiving notice. Otherwise, all your licenses
|
||||
end immediately.
|
||||
|
||||
## No Liability
|
||||
|
||||
***As far as the law allows, the software comes as is, without
|
||||
any warranty or condition, and the licensor will not be liable
|
||||
to you for any damages arising out of these terms or the use
|
||||
or nature of the software, under any kind of legal claim.***
|
||||
|
||||
## Definitions
|
||||
|
||||
The **licensor** is the individual or entity offering these
|
||||
terms, and the **software** is the software the licensor makes
|
||||
available under these terms.
|
||||
|
||||
**You** refers to the individual or entity agreeing to these
|
||||
terms.
|
||||
|
||||
**Your company** is any legal entity, sole proprietorship,
|
||||
or other kind of organization that you work for, plus all
|
||||
organizations that have control over, are under the control of,
|
||||
or are under common control with that organization. **Control**
|
||||
means ownership of substantially all the assets of an entity,
|
||||
or the power to direct its management and policies by vote,
|
||||
contract, or otherwise. Control can be direct or indirect.
|
||||
|
||||
**Your licenses** are all the licenses granted to you for the
|
||||
software under these terms.
|
||||
|
||||
**Use** means anything you do with the software requiring one
|
||||
of your licenses.
|
||||
@@ -0,0 +1,25 @@
|
||||
# Pro Features
|
||||
|
||||
## What?
|
||||
|
||||
Remotely Save has some "pro features", which users have to pay for using them.
|
||||
|
||||
## Sign Up / Sign In And Connect
|
||||
|
||||
See the tutorial about your PRO account [here](../docs/pro/README.md).
|
||||
|
||||
## Smart Conflict
|
||||
|
||||
Basic (free) version can detect conflicts, but users have to choose to keep newer version or larger version of the files.
|
||||
|
||||
PRO (paid) feature "Smart Conflict" gives users one more option: merge small markdown files, or duplicate large markdown files or non-markdown files.
|
||||
|
||||
## Sync With Google Drive
|
||||
|
||||
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).
|
||||
|
||||
## License
|
||||
|
||||
The codes or files or subfolders inside the current folder (`pro` in the repo), are released under "source available" license: "PolyForm Strict License 1.0.0".
|
||||
|
||||
Suggestions are welcome.
|
||||
@@ -0,0 +1,318 @@
|
||||
import { nanoid } from "nanoid";
|
||||
import {
|
||||
OAUTH2_FORCE_EXPIRE_MILLISECONDS,
|
||||
type RemotelySavePluginSettings,
|
||||
type SUPPORTED_SERVICES_TYPE,
|
||||
} from "../../src/baseTypes";
|
||||
import {
|
||||
COMMAND_CALLBACK_PRO,
|
||||
type FeatureInfo,
|
||||
PRO_CLIENT_ID,
|
||||
type PRO_FEATURE_TYPE,
|
||||
PRO_WEBSITE,
|
||||
type ProConfig,
|
||||
} from "./baseTypesPro";
|
||||
import { codeVerifier2CodeChallenge } from "./oauth2";
|
||||
|
||||
const site = PRO_WEBSITE;
|
||||
console.debug(`remotelysave official website: ${site}`);
|
||||
|
||||
export const DEFAULT_PRO_CONFIG: ProConfig = {
|
||||
accessToken: "",
|
||||
accessTokenExpiresInMs: 0,
|
||||
accessTokenExpiresAtTimeMs: 0,
|
||||
refreshToken: "",
|
||||
enabledProFeatures: [],
|
||||
email: "",
|
||||
};
|
||||
|
||||
export const generateAuthUrlAndCodeVerifierChallenge = async (
|
||||
hasCallback: boolean
|
||||
) => {
|
||||
const appKey = PRO_CLIENT_ID ?? "cli-"; // hard-code
|
||||
const codeVerifier = nanoid(128);
|
||||
const codeChallenge = await codeVerifier2CodeChallenge(codeVerifier);
|
||||
let authUrl = `${site}/oauth2/authorize?response_type=code&client_id=${appKey}&token_access_type=offline&code_challenge_method=S256&code_challenge=${codeChallenge}&scope=pro.list.read`;
|
||||
if (hasCallback) {
|
||||
authUrl += `&redirect_uri=obsidian://${COMMAND_CALLBACK_PRO}`;
|
||||
}
|
||||
return {
|
||||
authUrl,
|
||||
codeVerifier,
|
||||
codeChallenge,
|
||||
};
|
||||
};
|
||||
|
||||
export const sendAuthReq = async (
|
||||
verifier: string,
|
||||
authCode: string,
|
||||
errorCallBack: any
|
||||
) => {
|
||||
const appKey = PRO_CLIENT_ID ?? "cli-"; // hard-code
|
||||
try {
|
||||
const k = {
|
||||
code: authCode,
|
||||
grant_type: "authorization_code",
|
||||
code_verifier: verifier,
|
||||
client_id: appKey,
|
||||
// redirect_uri: `obsidian://${COMMAND_CALLBACK_PRO}`,
|
||||
scope: "pro.list.read",
|
||||
};
|
||||
// console.debug(k);
|
||||
const resp1 = await fetch(`${site}/api/v1/oauth2/token`, {
|
||||
method: "POST",
|
||||
body: new URLSearchParams(k),
|
||||
});
|
||||
const resp2 = await resp1.json();
|
||||
return resp2;
|
||||
} catch (e) {
|
||||
console.error(e);
|
||||
if (errorCallBack !== undefined) {
|
||||
await errorCallBack(e);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
export const sendRefreshTokenReq = async (refreshToken: string) => {
|
||||
const appKey = PRO_CLIENT_ID ?? "cli-"; // hard-code
|
||||
try {
|
||||
console.info("start auto getting refreshed Remotely Save access token.");
|
||||
const resp1 = await fetch(`${site}/api/v1/oauth2/token`, {
|
||||
method: "POST",
|
||||
body: new URLSearchParams({
|
||||
grant_type: "refresh_token",
|
||||
refresh_token: refreshToken,
|
||||
client_id: appKey,
|
||||
scope: "pro.list.read",
|
||||
}),
|
||||
});
|
||||
const resp2: AuthResError | AuthResSucc = await resp1.json();
|
||||
console.info("finish auto getting refreshed Remotely Save access token.");
|
||||
return resp2;
|
||||
} catch (e) {
|
||||
console.error(e);
|
||||
throw e;
|
||||
}
|
||||
};
|
||||
|
||||
interface AuthResError {
|
||||
error: "invalid_request";
|
||||
}
|
||||
|
||||
interface AuthResSucc {
|
||||
error: undefined; // needed for typescript
|
||||
refresh_token?: string;
|
||||
access_token: string;
|
||||
expires_in: number;
|
||||
}
|
||||
|
||||
export const setConfigBySuccessfullAuthInplace = async (
|
||||
config: ProConfig,
|
||||
authRes: AuthResError | AuthResSucc,
|
||||
saveUpdatedConfigFunc: () => Promise<any> | undefined
|
||||
) => {
|
||||
if (authRes.error !== undefined) {
|
||||
throw Error(`you should not save the setting for ${authRes.error}`);
|
||||
}
|
||||
|
||||
config.accessToken = authRes.access_token;
|
||||
config.accessTokenExpiresAtTimeMs =
|
||||
Date.now() + authRes.expires_in * 1000 - 5 * 60 * 1000;
|
||||
config.accessTokenExpiresInMs = authRes.expires_in * 1000;
|
||||
config.refreshToken = authRes.refresh_token || config.refreshToken;
|
||||
|
||||
// manually set it expired after 80 days;
|
||||
config.credentialsShouldBeDeletedAtTimeMs =
|
||||
Date.now() + OAUTH2_FORCE_EXPIRE_MILLISECONDS;
|
||||
|
||||
await saveUpdatedConfigFunc?.();
|
||||
|
||||
console.info(
|
||||
"finish updating local info of Remotely Save official website token"
|
||||
);
|
||||
};
|
||||
|
||||
export const getAccessToken = async (
|
||||
config: ProConfig,
|
||||
saveUpdatedConfigFunc: () => Promise<any> | undefined
|
||||
) => {
|
||||
const ts = Date.now();
|
||||
if (
|
||||
config.accessToken !== undefined &&
|
||||
config.accessToken !== "" &&
|
||||
config.accessTokenExpiresAtTimeMs > ts &&
|
||||
(config.credentialsShouldBeDeletedAtTimeMs ?? ts + 1000 * 1000) > ts
|
||||
) {
|
||||
return config.accessToken;
|
||||
}
|
||||
|
||||
console.debug(
|
||||
`currently, accessToken=${config.accessToken}, accessTokenExpiresAtTimeMs=${
|
||||
config.accessTokenExpiresAtTimeMs
|
||||
}, credentialsShouldBeDeletedAtTimeMs=${
|
||||
config.credentialsShouldBeDeletedAtTimeMs
|
||||
},comp1=${config.accessTokenExpiresAtTimeMs > ts}, comp2=${
|
||||
(config.credentialsShouldBeDeletedAtTimeMs ?? ts + 1000 * 1000) > ts
|
||||
}`
|
||||
);
|
||||
|
||||
// try to get it again??
|
||||
const res = await sendRefreshTokenReq(config.refreshToken ?? "refresh-");
|
||||
await setConfigBySuccessfullAuthInplace(config, res, saveUpdatedConfigFunc);
|
||||
|
||||
if (res.error !== undefined) {
|
||||
throw Error("cannot update accessToken");
|
||||
}
|
||||
return res.access_token;
|
||||
};
|
||||
|
||||
export const getAndSaveProFeatures = async (
|
||||
config: ProConfig,
|
||||
pluginVersion: string,
|
||||
saveUpdatedConfigFunc: () => Promise<any> | undefined
|
||||
) => {
|
||||
const access = await getAccessToken(config, saveUpdatedConfigFunc);
|
||||
|
||||
const resp1 = await fetch(`${site}/api/v1/pro/list`, {
|
||||
method: "GET",
|
||||
headers: {
|
||||
Authorization: `Bearer ${access}`,
|
||||
"REMOTELYSAVE-API-Plugin-Ver": pluginVersion,
|
||||
},
|
||||
});
|
||||
const rsp2: {
|
||||
proFeatures: FeatureInfo[];
|
||||
} = await resp1.json();
|
||||
|
||||
config.enabledProFeatures = rsp2.proFeatures;
|
||||
await saveUpdatedConfigFunc?.();
|
||||
return rsp2;
|
||||
};
|
||||
|
||||
export const getAndSaveProEmail = async (
|
||||
config: ProConfig,
|
||||
pluginVersion: string,
|
||||
saveUpdatedConfigFunc: () => Promise<any> | undefined
|
||||
) => {
|
||||
const access = await getAccessToken(config, saveUpdatedConfigFunc);
|
||||
|
||||
const resp1 = await fetch(`${site}/api/v1/profile/list`, {
|
||||
method: "GET",
|
||||
headers: {
|
||||
Authorization: `Bearer ${access}`,
|
||||
"REMOTELYSAVE-API-Plugin-Ver": pluginVersion,
|
||||
},
|
||||
});
|
||||
const rsp2: {
|
||||
email: string;
|
||||
} = await resp1.json();
|
||||
|
||||
config.email = rsp2.email;
|
||||
await saveUpdatedConfigFunc?.();
|
||||
return rsp2;
|
||||
};
|
||||
|
||||
/**
|
||||
* If the check doesn't pass, the function should throw the error
|
||||
* @returns
|
||||
*/
|
||||
export const checkProRunnableAndFixInplace = async (
|
||||
config: RemotelySavePluginSettings,
|
||||
pluginVersion: string,
|
||||
saveUpdatedConfigFunc: () => Promise<any> | undefined
|
||||
): Promise<true> => {
|
||||
console.debug(`checkProRunnableAndFixInplace`);
|
||||
|
||||
// many checks if status is valid
|
||||
|
||||
// no account
|
||||
if (config.pro === undefined || config.pro.refreshToken === undefined) {
|
||||
throw Error(`you need to "connect" to your account to use PRO features`);
|
||||
}
|
||||
|
||||
// every features should have at most 40 days expiration dates
|
||||
// and if the time has expired, we also check
|
||||
const msIn40Days = 1000 * 60 * 60 * 24 * 40;
|
||||
for (const f of config.pro.enabledProFeatures) {
|
||||
const tooFarInTheFuture = f.expireAtTimeMs >= Date.now() + msIn40Days;
|
||||
const alreadyExpired = f.expireAtTimeMs <= Date.now();
|
||||
if (tooFarInTheFuture || alreadyExpired) {
|
||||
console.info(
|
||||
`the pro feature is too far in the future and has expired, check again.`
|
||||
);
|
||||
await getAndSaveProFeatures(
|
||||
config.pro,
|
||||
pluginVersion,
|
||||
saveUpdatedConfigFunc
|
||||
);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
const errorMsgs = [];
|
||||
|
||||
// check for smart_conflict
|
||||
if (config.conflictAction === "smart_conflict") {
|
||||
if (
|
||||
config.pro.enabledProFeatures.filter(
|
||||
(x) => x.featureName === "feature-smart_conflict"
|
||||
).length === 1
|
||||
) {
|
||||
// good to go
|
||||
} else {
|
||||
errorMsgs.push(
|
||||
`You're trying to use "smart conflict" PRO feature but you haven't subscribe to it.`
|
||||
);
|
||||
}
|
||||
} else {
|
||||
// good to go
|
||||
}
|
||||
|
||||
const toChecked: {
|
||||
feature: PRO_FEATURE_TYPE;
|
||||
service: SUPPORTED_SERVICES_TYPE;
|
||||
name: string;
|
||||
}[] = [
|
||||
{
|
||||
feature: "feature-google_drive",
|
||||
service: "googledrive",
|
||||
name: "Google Drive",
|
||||
},
|
||||
{ feature: "feature-box", service: "box", name: "Box" },
|
||||
{ feature: "feature-pcloud", service: "pcloud", name: "pCloud" },
|
||||
{
|
||||
feature: "feature-yandex_disk",
|
||||
service: "yandexdisk",
|
||||
name: "Yandex Disk",
|
||||
},
|
||||
{
|
||||
feature: "feature-koofr",
|
||||
service: "koofr",
|
||||
name: "Koofr",
|
||||
},
|
||||
];
|
||||
|
||||
for (const { feature, service, name } of toChecked) {
|
||||
console.debug(`checking "${feature}", serviceType=${config.serviceType}`);
|
||||
if (config.serviceType === service) {
|
||||
if (
|
||||
config.pro.enabledProFeatures.filter((x) => x.featureName === feature)
|
||||
.length === 1
|
||||
) {
|
||||
// good to go
|
||||
} else {
|
||||
errorMsgs.push(
|
||||
`You're trying to use "sync with ${name}" PRO feature but you haven't subscribe to it.`
|
||||
);
|
||||
}
|
||||
} else {
|
||||
// good to go
|
||||
}
|
||||
}
|
||||
|
||||
if (errorMsgs.length !== 0) {
|
||||
throw Error(errorMsgs.join("\n\n"));
|
||||
}
|
||||
|
||||
return true;
|
||||
};
|
||||
@@ -0,0 +1,17 @@
|
||||
# checklist for adding new service
|
||||
|
||||
1. `fsXxx.ts`
|
||||
2. `settingsXxx.ts`
|
||||
3. add callback and `xxxConfig` in `baseTypesPro.ts`
|
||||
4. add `xxxConfig` to `DEFAULT_SETTINGS` and `RemotelySavePluginSettings` in `main.ts`
|
||||
5. add `registerObsidianProtocolHandler`, if undefinded, `let xxxExpired`, expired notice in `main.ts`
|
||||
6. add `langs/`
|
||||
7. add css into `styles.css`
|
||||
8. general `settings.ts` add: config part, chooser, import export
|
||||
9. `generateProSettingsPart.ts`
|
||||
10. `importExport.ts`
|
||||
11. `fsGetter.ts`
|
||||
12. `sync.ts` checking for PRO: `checkProRunnableAndFixInplace`
|
||||
13. `configPersist.test.ts`
|
||||
14. `README.md` add service at menu and detail
|
||||
15. `docs/` add service
|
||||
@@ -0,0 +1,138 @@
|
||||
///////////////////////////////////////////////////////////
|
||||
// PRO
|
||||
//////////////////////////////////////////////////////////
|
||||
|
||||
export const COMMAND_CALLBACK_PRO = "remotely-save-cb-pro";
|
||||
export const PRO_CLIENT_ID = process.env.DEFAULT_REMOTELYSAVE_CLIENT_ID;
|
||||
export const PRO_WEBSITE = process.env.DEFAULT_REMOTELYSAVE_WEBSITE;
|
||||
|
||||
export type PRO_FEATURE_TYPE =
|
||||
| "feature-smart_conflict"
|
||||
| "feature-google_drive"
|
||||
| "feature-box"
|
||||
| "feature-pcloud"
|
||||
| "feature-yandex_disk"
|
||||
| "feature-koofr";
|
||||
|
||||
export interface FeatureInfo {
|
||||
featureName: PRO_FEATURE_TYPE;
|
||||
enableAtTimeMs: bigint;
|
||||
expireAtTimeMs: bigint;
|
||||
}
|
||||
|
||||
export interface ProConfig {
|
||||
email?: string;
|
||||
refreshToken?: string;
|
||||
accessToken: string;
|
||||
accessTokenExpiresInMs: number;
|
||||
accessTokenExpiresAtTimeMs: number;
|
||||
enabledProFeatures: FeatureInfo[];
|
||||
credentialsShouldBeDeletedAtTimeMs?: number;
|
||||
}
|
||||
|
||||
///////////////////////////////////////////////////////////
|
||||
// smart conflict
|
||||
//////////////////////////////////////////////////////////
|
||||
|
||||
export const MERGABLE_SIZE = 1000 * 1000; // 1 MB
|
||||
|
||||
///////////////////////////////////////////////////////////
|
||||
// Google Drive
|
||||
//////////////////////////////////////////////////////////
|
||||
|
||||
export interface GoogleDriveConfig {
|
||||
accessToken: string;
|
||||
accessTokenExpiresInMs: number;
|
||||
accessTokenExpiresAtTimeMs: number;
|
||||
refreshToken: string;
|
||||
remoteBaseDir?: string;
|
||||
credentialsShouldBeDeletedAtTimeMs?: number;
|
||||
scope: "https://www.googleapis.com/auth/drive.file";
|
||||
kind: "googledrive";
|
||||
}
|
||||
|
||||
export const DEFAULT_GOOGLEDRIVE_CLIENT_ID =
|
||||
process.env.DEFAULT_GOOGLEDRIVE_CLIENT_ID;
|
||||
export const DEFAULT_GOOGLEDRIVE_CLIENT_SECRET =
|
||||
process.env.DEFAULT_GOOGLEDRIVE_CLIENT_SECRET;
|
||||
|
||||
///////////////////////////////////////////////////////////
|
||||
// box
|
||||
//////////////////////////////////////////////////////////
|
||||
|
||||
export const COMMAND_CALLBACK_BOX = "remotely-save-cb-box";
|
||||
export const BOX_CLIENT_ID = process.env.DEFAULT_BOX_CLIENT_ID;
|
||||
export const BOX_CLIENT_SECRET = process.env.DEFAULT_BOX_CLIENT_SECRET;
|
||||
|
||||
export interface BoxConfig {
|
||||
accessToken: string;
|
||||
accessTokenExpiresInMs: number;
|
||||
accessTokenExpiresAtTimeMs: number;
|
||||
refreshToken: string;
|
||||
remoteBaseDir?: string;
|
||||
credentialsShouldBeDeletedAtTimeMs?: number;
|
||||
kind: "box";
|
||||
}
|
||||
|
||||
///////////////////////////////////////////////////////////
|
||||
// pCloud
|
||||
//////////////////////////////////////////////////////////
|
||||
|
||||
export const COMMAND_CALLBACK_PCLOUD = "remotely-save-cb-pcloud";
|
||||
export const PCLOUD_CLIENT_ID = process.env.DEFAULT_PCLOUD_CLIENT_ID;
|
||||
export const PCLOUD_CLIENT_SECRET = process.env.DEFAULT_PCLOUD_CLIENT_SECRET;
|
||||
|
||||
export interface PCloudConfig {
|
||||
accessToken: string;
|
||||
hostname: "eapi.pcloud.com" | "api.pcloud.com";
|
||||
locationid: 1 | 2;
|
||||
remoteBaseDir?: string;
|
||||
credentialsShouldBeDeletedAtTimeMs?: number;
|
||||
kind: "pcloud";
|
||||
|
||||
/**
|
||||
* @deprecated
|
||||
*/
|
||||
emptyFile: "skip" | "error";
|
||||
}
|
||||
|
||||
///////////////////////////////////////////////////////////
|
||||
// Yandex Disk
|
||||
//////////////////////////////////////////////////////////
|
||||
|
||||
export const COMMAND_CALLBACK_YANDEXDISK = "remotely-save-cb-yandexdisk";
|
||||
export const YANDEXDISK_CLIENT_ID = process.env.DEFAULT_YANDEXDISK_CLIENT_ID;
|
||||
export const YANDEXDISK_CLIENT_SECRET =
|
||||
process.env.DEFAULT_YANDEXDISK_CLIENT_SECRET;
|
||||
|
||||
export interface YandexDiskConfig {
|
||||
accessToken: string;
|
||||
accessTokenExpiresInMs: number;
|
||||
accessTokenExpiresAtTimeMs: number;
|
||||
refreshToken: string;
|
||||
remoteBaseDir?: string;
|
||||
credentialsShouldBeDeletedAtTimeMs?: number;
|
||||
scope: string;
|
||||
kind: "yandexdisk";
|
||||
}
|
||||
|
||||
///////////////////////////////////////////////////////////
|
||||
// Koofr
|
||||
//////////////////////////////////////////////////////////
|
||||
|
||||
export const COMMAND_CALLBACK_KOOFR = "remotely-save-cb-koofr";
|
||||
export const KOOFR_CLIENT_ID = process.env.DEFAULT_KOOFR_CLIENT_ID;
|
||||
export const KOOFR_CLIENT_SECRET = process.env.DEFAULT_KOOFR_CLIENT_SECRET;
|
||||
|
||||
export interface KoofrConfig {
|
||||
accessToken: string;
|
||||
accessTokenExpiresInMs: number;
|
||||
accessTokenExpiresAtTimeMs: number;
|
||||
refreshToken: string;
|
||||
remoteBaseDir?: string;
|
||||
credentialsShouldBeDeletedAtTimeMs?: number;
|
||||
scope: string;
|
||||
api: string;
|
||||
mountID: string;
|
||||
kind: "koofr";
|
||||
}
|
||||
@@ -0,0 +1,257 @@
|
||||
import isEqual from "lodash/isEqual";
|
||||
// import {
|
||||
// makePatches,
|
||||
// applyPatches,
|
||||
// stringifyPatches,
|
||||
// parsePatch,
|
||||
// } from "@sanity/diff-match-patch";
|
||||
import {
|
||||
LCS,
|
||||
diff3Merge,
|
||||
diffComm,
|
||||
diffPatch,
|
||||
mergeDiff3,
|
||||
mergeDigIn,
|
||||
patch,
|
||||
} from "node-diff3";
|
||||
import type { Entity } from "../../src/baseTypes";
|
||||
import { copyFile } from "../../src/copyLogic";
|
||||
import type { FakeFs } from "../../src/fsAll";
|
||||
import { MERGABLE_SIZE } from "./baseTypesPro";
|
||||
|
||||
export function isMergable(a: Entity, b?: Entity) {
|
||||
if (b !== undefined && a.keyRaw !== b.keyRaw) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return (
|
||||
!a.keyRaw.endsWith("/") &&
|
||||
a.sizeRaw <= MERGABLE_SIZE &&
|
||||
(a.keyRaw.endsWith(".md") || a.keyRaw.endsWith(".markdown"))
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* slightly modify to adjust in markdown context
|
||||
* @param a
|
||||
* @param o
|
||||
* @param b
|
||||
*/
|
||||
function mergeDigInModified(a: string, o: string, b: string) {
|
||||
const { conflict, result } = mergeDigIn(a, o, b);
|
||||
for (let index = 0; index < result.length; ++index) {
|
||||
if (["<<<<<<<", "=======", ">>>>>>>"].contains(result[index])) {
|
||||
result[index] = "`" + result[index] + "`";
|
||||
}
|
||||
}
|
||||
return {
|
||||
conflict,
|
||||
result,
|
||||
};
|
||||
}
|
||||
|
||||
function getLCSText(a: string, b: string) {
|
||||
const aa = a.split("\n");
|
||||
const bb = b.split("\n");
|
||||
let raw = LCS(aa, bb);
|
||||
|
||||
const k: string[] = [];
|
||||
|
||||
do {
|
||||
k.unshift(aa[raw.buffer1index]);
|
||||
|
||||
raw = raw.chain as any;
|
||||
} while (raw !== null && raw !== undefined && raw.buffer1index !== -1);
|
||||
|
||||
return k.join("\n");
|
||||
}
|
||||
|
||||
/**
|
||||
* It's tricky. We find LCS then pretend it's the original text
|
||||
* @param a
|
||||
* @param b
|
||||
* @returns
|
||||
*/
|
||||
function twoWayMerge(a: string, b: string): string {
|
||||
// const c = getLCSText(a, b);
|
||||
// const patches = makePatches(c, a);
|
||||
// const [d] = applyPatches(patches, b);
|
||||
const c = getLCSText(a, b);
|
||||
const d = mergeDigInModified(a, c, b).result.join("\n");
|
||||
return d;
|
||||
}
|
||||
|
||||
/**
|
||||
* Originally three way merge.
|
||||
* @param a
|
||||
* @param b
|
||||
* @param orig
|
||||
* @returns
|
||||
*/
|
||||
function threeWayMerge(a: string, b: string, orig: string) {
|
||||
return mergeDigInModified(a, orig, b).result.join("\n");
|
||||
}
|
||||
|
||||
export async function mergeFile(
|
||||
key: string,
|
||||
left: FakeFs,
|
||||
right: FakeFs,
|
||||
contentOrig: ArrayBuffer | null | undefined
|
||||
) {
|
||||
// console.debug(
|
||||
// `mergeFile: key=${key}, left=${left.kind}, right=${right.kind}`
|
||||
// );
|
||||
if (key.endsWith("/")) {
|
||||
throw Error(`should not call ${key} in mergeFile`);
|
||||
}
|
||||
|
||||
if (!key.endsWith(".md") && !key.endsWith(".markdown")) {
|
||||
throw Error(`currently only support markdown files in mergeFile`);
|
||||
}
|
||||
|
||||
const [contentLeft, contentRight] = await Promise.all([
|
||||
left.readFile(key),
|
||||
right.readFile(key),
|
||||
]);
|
||||
|
||||
let newArrayBuffer: ArrayBuffer | undefined = undefined;
|
||||
const decoder = new TextDecoder("utf-8");
|
||||
|
||||
if (isEqual(contentLeft, contentRight)) {
|
||||
// we are lucky enough
|
||||
newArrayBuffer = contentLeft;
|
||||
// TODO: save the write
|
||||
} else {
|
||||
if (contentOrig === null || contentOrig === undefined) {
|
||||
const newText = twoWayMerge(
|
||||
decoder.decode(contentLeft),
|
||||
decoder.decode(contentRight)
|
||||
);
|
||||
// no need to worry about the offset here because the array is new and not sliced
|
||||
newArrayBuffer = new TextEncoder().encode(newText).buffer;
|
||||
} else {
|
||||
const newText = threeWayMerge(
|
||||
decoder.decode(contentLeft),
|
||||
decoder.decode(contentRight),
|
||||
decoder.decode(contentOrig)
|
||||
);
|
||||
newArrayBuffer = new TextEncoder().encode(newText).buffer;
|
||||
}
|
||||
}
|
||||
|
||||
const mtime = Date.now();
|
||||
|
||||
// left (local) must wait for the right
|
||||
// because the mtime might be different after upload
|
||||
// upload firstly
|
||||
const rightEntity = await right.writeFile(key, newArrayBuffer, mtime, mtime);
|
||||
// write local secondly
|
||||
const leftEntity = await left.writeFile(
|
||||
key,
|
||||
newArrayBuffer,
|
||||
rightEntity.mtimeCli ?? mtime,
|
||||
rightEntity.mtimeCli ?? mtime
|
||||
);
|
||||
|
||||
return {
|
||||
entity: rightEntity,
|
||||
content: newArrayBuffer,
|
||||
};
|
||||
}
|
||||
|
||||
export function getFileRename(key: string) {
|
||||
if (
|
||||
key === "" ||
|
||||
key === "." ||
|
||||
key === ".." ||
|
||||
key === "/" ||
|
||||
key.endsWith("/")
|
||||
) {
|
||||
throw Error(`we cannot rename key=${key}`);
|
||||
}
|
||||
|
||||
const segsPath = key.split("/");
|
||||
const name = segsPath[segsPath.length - 1];
|
||||
const segsName = name.split(".");
|
||||
|
||||
if (segsName.length === 0) {
|
||||
throw Error(`we cannot rename key=${key}`);
|
||||
} else if (segsName.length === 1) {
|
||||
// name = "kkk" without any dot
|
||||
segsPath[segsPath.length - 1] = `${name}.dup`;
|
||||
} else if (segsName.length === 2) {
|
||||
if (segsName[0] === "") {
|
||||
// name = ".kkkk" with leading dot
|
||||
segsPath[segsPath.length - 1] = `${name}.dup`;
|
||||
} else if (segsName[1] === "") {
|
||||
// name = "kkkk." with tailing dot
|
||||
segsPath[segsPath.length - 1] = `${segsName[0]}.dup`;
|
||||
} else {
|
||||
// name = "aaa.bbb" normally
|
||||
segsPath[segsPath.length - 1] = `${segsName[0]}.dup.${segsName[1]}`;
|
||||
}
|
||||
} else {
|
||||
// name = "[...].bbb.ccc"
|
||||
const firstPart = segsName.slice(0, segsName.length - 1).join(".");
|
||||
const thirdPart = segsName[segsName.length - 1];
|
||||
segsPath[segsPath.length - 1] = `${firstPart}.dup.${thirdPart}`;
|
||||
}
|
||||
const res = segsPath.join("/");
|
||||
return res;
|
||||
}
|
||||
|
||||
/**
|
||||
* local: x.md -> x.dup.md -> upload to remote
|
||||
* remote: x.md -> download to local -> using original name x.md
|
||||
*/
|
||||
export async function duplicateFile(
|
||||
key: string,
|
||||
left: FakeFs,
|
||||
right: FakeFs,
|
||||
uploadCallback: (entity: Entity) => Promise<any>,
|
||||
downloadCallback: (entity: Entity) => Promise<any>
|
||||
) {
|
||||
let key2 = getFileRename(key);
|
||||
let usable = false;
|
||||
do {
|
||||
try {
|
||||
const s = await left.stat(key2);
|
||||
if (s === null || s === undefined) {
|
||||
throw Error(`not exist $${key2}`);
|
||||
}
|
||||
console.debug(`key2=${key2} exists, cannot use for new file`);
|
||||
key2 = getFileRename(key2);
|
||||
console.debug(`key2=${key2} is prepared for next try`);
|
||||
} catch (e) {
|
||||
// not exists, exactly what we want
|
||||
console.debug(`key2=${key2} doesn't exist, usable for new file`);
|
||||
usable = true;
|
||||
}
|
||||
} while (!usable);
|
||||
await left.rename(key, key2);
|
||||
|
||||
/**
|
||||
* x.dup.md -> upload to remote
|
||||
*/
|
||||
async function f1() {
|
||||
const k = await copyFile(key2, left, right);
|
||||
await uploadCallback(k.entity);
|
||||
return k.entity;
|
||||
}
|
||||
|
||||
/**
|
||||
* x.md -> download to local
|
||||
*/
|
||||
async function f2() {
|
||||
const k = await copyFile(key, right, left);
|
||||
await downloadCallback(k.entity);
|
||||
return k.entity;
|
||||
}
|
||||
|
||||
const [resUpload, resDownload] = await Promise.all([f1(), f2()]);
|
||||
|
||||
return {
|
||||
upload: resUpload,
|
||||
download: resDownload,
|
||||
};
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user