mirror of
https://github.com/remotely-save/remotely-save.git
synced 2024-06-07 21:10:45 +00:00
48 lines
3.7 KiB
Markdown
48 lines
3.7 KiB
Markdown
## Material Source
|
|
|
|
To apply for the production use of Dropbox API, some descriptions are needed to be submitted to Dropbox. Coincidently, this can also be served as a "readme" to use this plugin with Dropbox.
|
|
|
|
## Some Backgrounds
|
|
|
|
1. Obsidian allows users to take notes using markdown files.
|
|
2. The "app", remotely-save. is an unofficial Obsidian plugin, helping users download and upload ("sync") their notes from and to Dropbox.
|
|
3. Technically, remotely-save is developed using web technologies.
|
|
|
|
## Api Usages
|
|
|
|
1. remotely-save uses "App folder", to avoid unnecessary accessing users' other files.
|
|
2. remotely-save uses "account_info.read", to get the displayed username, so that users know which of their accounts has been logged in after OAuth steps.
|
|
3. remotely-save uses "files.content.read", so that it can read the "last modified time", and the content of files on Dropbox. Under some conditions, the plugin would download the files. For example, the plugin would compare the last modified timestamps of the file in the local device and that on Dropbox, and if the timestamp on Dropbox is larger, the plugin would download the "newer" file from Dropbox to local.
|
|
4. remotely-save uses "files.content.write", so that it can upload or overwrite the content of files on Dropbox. Under some conditions, the plugin would do that. For example, the plugin would compare the last modified timestamps of the file in the local device and that on Dropbox, and if the timestamp in the local device is larger, the plugin would upload the "newer" file from local to Dropbox, and overwrite that file on Dropbox.
|
|
|
|
## Steps
|
|
|
|
Here are the steps to see the functionality of remotely-save.
|
|
|
|
Most steps have screenshots.
|
|
|
|
1. Download the note-taking app Obsidian (Windows or Mac versions are both ok) from its official website: https://obsidian.md/ . It's free to download and use. Then install it.
|
|
2. Open Obsidian, click the "Create" button under "Create new vault".
|
|
3. Pick a vault name, "example-vault", and choose a location, then click "Create".
|
|
|
|
4. Close any update new if prompted.
|
|
5. Create a new note by clicking a button on the left. And write something on the note.
|
|
|
|
6. Click "setting" (a gear icon) on the button left of the sidebar.
|
|
|
|
7. In the settings panel, go to the "Community plugins" page, turn off the safe mode, and confirm to turn off the safe mode. Then click the "Browse" button for community plugins.
|
|
|
|
8. Search "Remotely Save" and install on the result.
|
|
|
|
9. After successful installing the plugin, go back to the "Community plugins" page, and enable the plugin.
|
|
|
|
10. Go to newly added "Remotely Save" settings, select "Dropbox" in "Choose service", and click the "Auth" button.
|
|
|
|
11. The standard auth flow address is shown, users should click the address, and finish the auth steps on the website. Finally, the Dropbox website should automatically redirect users back to the Obsidian app.
|
|
|
|
12. The "Auth" button disappears. A new "Revoke Auth" appears.
|
|
|
|
13. Go back to the main interface of Obsidian, a new "switch icon" should appear on the left sidebar. Click this, then the plugin would trigger the sync progress. It would compare meta info of local files and remote files (on Dropbox), and decide to download some files and/or upload some files.
|
|
|
|
14. Create, edit, remove some notes, and repeat step 13, the files on Dropbox should also change to reflect the changes locally.
|