self-hosted/obsidian-livesync
1
0
Fork 0
mirror of https://github.com/vrtmrz/obsidian-livesync.git synced 2024-12-12 09:04:06 +02:00
Code Issues Releases Activity

Update the doc

Browse Source
This commit is contained in:
vorotamoroz 2024-12-09 00:40:15 +00:00
parent 2d0dc2a389
commit 29229f809b
1 changed files with 73 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

133
docs/settings.md
View File

@ -6,7 +6,7 @@ There are many settings in Self-hosted LiveSync. This document describes each se
| Icon | Description | | Icon | Description |
| :--: | ------------------------------------------------------------------ | | :--: | ------------------------------------------------------------------ |
| 💬 | [0. Update Information](#0-update-information) | | 💬 | [0. Change Log](#0-change-log) |
| 🧙‍♂️ | [1. Setup](#1-setup) | | 🧙‍♂️ | [1. Setup](#1-setup) |
| ⚙️ | [2. General Settings](#2-general-settings) | | ⚙️ | [2. General Settings](#2-general-settings) |
| 🛰️ | [3. Remote Configuration](#3-remote-configuration) | | 🛰️ | [3. Remote Configuration](#3-remote-configuration) |
@ -19,7 +19,7 @@ There are many settings in Self-hosted LiveSync. This document describes each se
| 🩹 | [10. Patches (Edge Case)](#10-patches-edge-case) | | 🩹 | [10. Patches (Edge Case)](#10-patches-edge-case) |
| 🎛️ | [11. Maintenance](#11-maintenance) | | 🎛️ | [11. Maintenance](#11-maintenance) |
## 0. Update Information ## 0. Change Log
This pane shows version up information. You can check what has been changed in recent versions. This pane shows version up information. You can check what has been changed in recent versions.
@ -31,21 +31,21 @@ This pane is used for setting up Self-hosted LiveSync. There are several options
Most preferred method to setup Self-hosted LiveSync. You can setup Self-hosted LiveSync with a few clicks. Most preferred method to setup Self-hosted LiveSync. You can setup Self-hosted LiveSync with a few clicks.
#### Use the copied setup URI #### Connect with Setup URI
Setup the Self-hosted LiveSync with the `setup URI` which is [copied from another device](#copy-current-settings-as-a-new-setup-uri) or the setup script. Setup the Self-hosted LiveSync with the `setup URI` which is [copied from another device](#copy-current-settings-as-a-new-setup-uri) or the setup script.
#### Minimal setup #### Manual setup
Step-by-step setup for Self-hosted LiveSync. You can setup Self-hosted LiveSync manually with Minimal setting items. Step-by-step setup for Self-hosted LiveSync. You can setup Self-hosted LiveSync manually with Minimal setting items.
#### Enable LiveSync on this device as the setup was completed manually #### Enable LiveSync
This button only appears when the setup was not completed. If you have completed the setup manually, you can enable LiveSync on this device by this button. This button only appears when the setup was not completed. If you have completed the setup manually, you can enable LiveSync on this device by this button.
### 2. To setup the other devices ### 2. To setup other devices
#### Copy current settings as a new setup URI #### Copy the current settings to a Setup URI
You can copy the current settings as a new setup URI. And this URI can be used to setup the other devices as [Use the copied setup URI](#use-the-copied-setup-uri). You can copy the current settings as a new setup URI. And this URI can be used to setup the other devices as [Use the copied setup URI](#use-the-copied-setup-uri).
@ -71,7 +71,7 @@ Following panes will be shown when you enable this setting.
| 🔌 | [6. Customization sync (Advanced)](#6-customization-sync-advanced) | | 🔌 | [6. Customization sync (Advanced)](#6-customization-sync-advanced) |
| 🔧 | [8. Advanced (Advanced)](#8-advanced-advanced) | | 🔧 | [8. Advanced (Advanced)](#8-advanced-advanced) |
#### Enable power user features #### Enable poweruser features
Setting key: usePowerUserMode Setting key: usePowerUserMode
@ -152,7 +152,7 @@ Setting key: notifyThresholdOfRemoteStorageSize
MB (0 to disable). We can get a notification when the estimated remote storage size exceeds this value. MB (0 to disable). We can get a notification when the estimated remote storage size exceeds this value.
### 3. Confidentiality ### 3. Privacy & Encryption
#### End-to-End Encryption #### End-to-End Encryption
@ -184,7 +184,13 @@ This is an experimental feature and not recommended. If you enable this, the ite
--- ---
### 4. Minio,S3,R2 ### 4. Fetch settings
#### Fetch config from remote server
Fetch necessary settings from already configured remote server.
### 5. Minio,S3,R2
#### Endpoint URL #### Endpoint URL
@ -209,15 +215,15 @@ Setting key: bucket
#### Use Custom HTTP Handler #### Use Custom HTTP Handler
Setting key: useCustomRequestHandler Setting key: useCustomRequestHandler
If your Object Storage could not configured accepting CORS, enable this. Enable this if your Object Storage doesn't support CORS
#### Test Connection #### Test Connection
#### Apply Settings #### Apply Settings
### 5. CouchDB ### 6. CouchDB
#### URI #### Server URI
Setting key: couchDB_URI Setting key: couchDB_URI
@ -231,17 +237,17 @@ username
Setting key: couchDB_PASSWORD Setting key: couchDB_PASSWORD
password password
#### Database name #### Database Name
Setting key: couchDB_DBNAME Setting key: couchDB_DBNAME
#### Test Database Connection #### Test Database Connection
Open database connection. If the remote database is not found and you have the privilege to create a database, the database will be created. Open database connection. If the remote database is not found and you have permission to create a database, the database will be created.
#### Check and fix database configuration #### Validate Database Configuration
Check the database configuration, and fix if there are any problems. Checks and fixes any potential issues with the database config.
#### Apply Settings #### Apply Settings
@ -254,7 +260,7 @@ Check the database configuration, and fix if there are any problems.
Setting key: preset Setting key: preset
Apply preset configuration Apply preset configuration
### 2. Synchronization Methods ### 2. Synchronization Method
#### Sync Mode #### Sync Mode
@ -268,22 +274,22 @@ Interval (sec)
#### Sync on Save #### Sync on Save
Setting key: syncOnSave Setting key: syncOnSave
When you save a file, sync automatically Starts synchronisation when a file is saved.
#### Sync on Editor Save #### Sync on Editor Save
Setting key: syncOnEditorSave Setting key: syncOnEditorSave
When you save a file in the editor, sync automatically When you save a file in the editor, start a sync automatically
#### Sync on File Open #### Sync on File Open
Setting key: syncOnFileOpen Setting key: syncOnFileOpen
When you open a file, sync automatically Forces the file to be synced when opened.
#### Sync on Start #### Sync on Startup
Setting key: syncOnStart Setting key: syncOnStart
Start synchronization after launching Obsidian. Automatically Sync all files when opening Obsidian.
#### Sync after merging file #### Sync after merging file
@ -312,34 +318,36 @@ Saving will be performed forcefully after this number of seconds.
#### Use the trash bin #### Use the trash bin
Setting key: trashInsteadDelete Setting key: trashInsteadDelete
Do not delete files that are deleted in remote, just move to trash. Move remotely deleted files to the trash, instead of deleting.
#### Keep empty folder #### Keep empty folder
Setting key: doNotDeleteFolder Setting key: doNotDeleteFolder
Normally, a folder is deleted when it becomes empty after a synchronization. Enabling this will prevent it from getting deleted Should we keep folders that don't have any files inside?
### 5. Conflict resolution (Advanced) ### 5. Conflict resolution (Advanced)
#### Always overwrite with a newer file (beta) #### (BETA) Always overwrite with a newer file
Setting key: resolveConflictsByNewerFile Setting key: resolveConflictsByNewerFile
(Def off) Resolve conflicts by newer files automatically. Testing only - Resolve file conflicts by syncing newer copies of the file, this can overwrite modified files. Be Warned.
#### Postpone resolution of inactive files #### Delay conflict resolution of inactive files
Setting key: checkConflictOnlyOnOpen Setting key: checkConflictOnlyOnOpen
Should we only check for conflicts when a file is opened?
#### Postpone manual resolution of inactive files #### Delay merge conflict prompt for inactive files.
Setting key: showMergeDialogOnlyOnActive Setting key: showMergeDialogOnlyOnActive
Should we prompt you about conflicting files when a file is opened?
### 6. Sync settings via markdown (Advanced) ### 6. Sync settings via markdown (Advanced)
#### Filename #### Filename
Setting key: settingSyncFile Setting key: settingSyncFile
If you set this, all settings are saved in a markdown file. You will be notified when new settings arrive. You can set different files by the platform. Save settings to a markdown file. You will be notified when new settings arrive. You can set different files by the platform.
#### Write credentials in the file #### Write credentials in the file
@ -350,7 +358,7 @@ Setting key: writeCredentialsForSettingSync
Setting key: notifyAllSettingSyncFile Setting key: notifyAllSettingSyncFile
### 7. Hidden files (Advanced) ### 7. Hidden Files (Advanced)
#### Hidden file synchronization #### Hidden file synchronization
@ -390,7 +398,7 @@ If this is set, changes to local files which are matched by the ignore files wil
#### Ignore files #### Ignore files
Setting key: ignoreFiles Setting key: ignoreFiles
We can use multiple ignore files, e.g.) `.gitignore, .dockerignore` Comma separated `.gitignore, .dockerignore`
### 2. Hidden Files (Advanced) ### 2. Hidden Files (Advanced)
@ -451,7 +459,7 @@ Warning! This will have a serious impact on performance. And the logs will not b
#### Suspend file watching #### Suspend file watching
Setting key: suspendFileWatching Setting key: suspendFileWatching
Stop watching for file change. Stop watching for file changes.
#### Suspend database reflecting #### Suspend database reflecting
@ -464,6 +472,10 @@ Stop reflecting database changes to storage files.
This will recreate chunks for all files. If there were missing chunks, this may fix the errors. This will recreate chunks for all files. If there were missing chunks, this may fix the errors.
#### Resolve All conflicted files by the newer one
Resolve all conflicted files by the newer one. Caution: This will overwrite the older one, and cannot resurrect the overwritten one.
#### Verify and repair all files #### Verify and repair all files
Compare the content of files between on local database and storage. If not matched, you will be asked which one you want to keep. Compare the content of files between on local database and storage. If not matched, you will be asked which one you want to keep.
@ -520,16 +532,6 @@ Setting key: concurrencyOfReadChunksOnline
Setting key: minimumIntervalOfReadChunksOnline Setting key: minimumIntervalOfReadChunksOnline
#### Send chunks in bulk
Setting key: sendChunksBulk
If this enabled, all chunks will be sent in bulk. This is useful for the environment that has a high latency.
#### Maximum size of chunks to send in one request
Setting key: sendChunksBulkMaxSize
MB
## 9. Power users (Power User) ## 9. Power users (Power User)
### 1. Remote Database Tweak ### 1. Remote Database Tweak
@ -563,7 +565,7 @@ Setting key: enableCompression
#### Batch size #### Batch size
Setting key: batch_size Setting key: batch_size
Number of change feed items to process at a time. Defaults to 50. Minimum is 2. Number of changes to sync at a time. Defaults to 50. Minimum is 2.
#### Batch limit #### Batch limit
@ -586,6 +588,13 @@ Setting key: configPassphraseStore
Setting key: configPassphrase Setting key: configPassphrase
This passphrase will not be copied to another device. It will be set to `Default` until you configure it again. This passphrase will not be copied to another device. It will be set to `Default` until you configure it again.
### 4. Developer
#### Enable Developers' Debug Tools.
Setting key: enableDebugTools
Requires restart of Obsidian
## 10. Patches (Edge Case) ## 10. Patches (Edge Case)
### 1. Compatibility (Metadata) ### 1. Compatibility (Metadata)
@ -601,15 +610,15 @@ Setting key: automaticallyDeleteMetadataOfDeletedFiles
### 2. Compatibility (Conflict Behaviour) ### 2. Compatibility (Conflict Behaviour)
#### Always resolve conflicts manually #### Always prompt merge conflicts
Setting key: disableMarkdownAutoMerge Setting key: disableMarkdownAutoMerge
If this switch is turned on, a merge dialog will be displayed, even if the sensible-merge is possible automatically. (Turn on to previous behavior) Should we prompt you for every single merge, even if we can safely merge automatcially?
#### Always reflect synchronized changes even if the note has a conflict #### Apply Latest Change if Conflicting
Setting key: writeDocumentsIfConflicted Setting key: writeDocumentsIfConflicted
Turn on to previous behavior Enable this option to automatically apply the most recent change to documents even when it conflicts
### 3. Compatibility (Database structure) ### 3. Compatibility (Database structure)
@ -655,7 +664,7 @@ Setting key: doNotSuspendOnFetching
#### Keep empty folder #### Keep empty folder
Setting key: doNotDeleteFolder Setting key: doNotDeleteFolder
Normally, a folder is deleted when it becomes empty after a synchronization. Enabling this will prevent it from getting deleted Should we keep folders that don't have any files inside?
### 7. Edge case addressing (Processing) ### 7. Edge case addressing (Processing)
@ -679,15 +688,15 @@ Setting key: disableCheckingConfigMismatch
### 1. Scram! ### 1. Scram!
#### Lock remote #### Lock Server
Lock remote to prevent synchronization with other devices. Lock the remote server to prevent synchronization with other devices.
#### Emergency restart #### Emergency restart
place the flag file to prevent all operation and restart. Disables all synchronization and restart.
### 2. Data-complementary Operations ### 2. Syncing
#### Resend #### Resend
@ -719,9 +728,9 @@ Rebuild local and remote database with local files.
### 5. Rebuilding Operations (Remote Only) ### 5. Rebuilding Operations (Remote Only)
#### Perform compaction #### Perform cleanup
Compaction discards all of Eden in the non-latest revisions, reducing the storage usage. However, this operation requires the same free space on the remote as the current database. Reduces storage space by discarding all non-latest revisions. This requires the same amount of free space on the remote server and the local client.
#### Overwrite remote #### Overwrite remote
@ -733,18 +742,18 @@ Initialise all journal history, On the next sync, every item will be received an
#### Purge all journal counter #### Purge all journal counter
Purge all sending and downloading cache. Purge all download/upload cache.
#### Make empty the bucket #### Fresh Start Wipe
Delete all data on the remote. Delete all data on the remote server.
### 6. Niches ### 6. Deprecated
#### (Obsolete) Clean up databases #### Run database cleanup
Delete unused chunks to shrink the database. However, this feature could be not effective in some cases. Please use rebuild everything instead. Attempt to shrink the database by deleting unused chunks. This may not work consistently. Use the 'Rebuild everything' under Total Overhaul.
### 7. Reset ### 7. Reset
#### Discard local database to reset or uninstall Self-hosted LiveSync #### Delete local database to reset or uninstall Self-hosted LiveSync