neil/silverbullet
1
0
Fork 0
Code

Better docs on client modes

Browse Source
This commit is contained in:
Zef Hemel 2023-09-07 12:47:52 +02:00
parent a2779f5719
commit a98c74eba2
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
website/Client Modes.md
View File

@ -1,21 +1,23 @@
SilverBullet currently supports two modes for its client: SilverBullet currently supports two modes for its client (the part of SilverBullet that runs in the browser):
1. _Online mode_ (the default): keeps all content on the server 1. _Online mode_ (the default): keeps all content on the server and only loads content to the client on-demand.
2. _Synced mode_ (offline capable): syncs all content to the client 2. _Synced mode_ (offline capable): syncs all content to the client.
You can toggle between these two modes by clicking the 🔄 button in the top bar. You can toggle between these two modes by toggling the 🔄 button in the top bar.
You can switch modes anytime, so try them both to decide what works best for you. You can switch modes any time, and use different modes on different devices.
**Note:** It is technically possible to _switch off online mode_ (and allow synced mode only) by running the SilverBullet server with the `--sync-only` flag (or setting the `SB_SYNC_ONLY` environment variable to something). With this flag on, the sync button will not appear in the UI.
## Online mode ## Online mode
In online mode, all content in your space is kept on the server, and a lot of the heavy lifting (such as indexing of pages) happens on the server. In online mode, all content in your space is kept on the server, and a lot of the heavy lifting (such as indexing of pages) happens on the server as well. Content will only be loaded to the client on-demand.
Advantages: Advantages:
* **Keeps content on the server**: this mode does not synchronize all your content to your client (browser), making this a better fit for large spaces. * **Keeps content on the server**: this mode does not synchronize all your content to your client (browser), making this a better fit for large spaces or for cases where you only need to quickly login to SilverBullet to check something, e.g. on a device you don’t usually use. This use case is the reason why this is the default mode.
* **Lighter-weight** in terms of memory and CPU use of the client * **Lighter-weight** in terms of memory and CPU use of the client.
Disadvantages: Disadvantages:
* **Requires a working network connection** to the server. * **Requires a working network connection** to the server. You can not load pages, nor successfully persist changes without it.
* **Higher latency**, since more interactions require calls to the server, this may be notable e.g., when completing page names. * **Higher latency**, since more interactions require calls to the server, this may be notable e.g., when completing page names.
## Synced mode ## Synced mode