From 9ba4d008f2f4a7f78dde863e262cef16bfcbee0b Mon Sep 17 00:00:00 2001 From: Patrik Stenmark Date: Fri, 16 Feb 2024 10:23:44 +0100 Subject: [PATCH] Add note about https requirements (#714) --- website/Client Modes.md | 2 +- website/Install/Docker.md | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/website/Client Modes.md b/website/Client Modes.md index 171e406d..a7562285 100644 --- a/website/Client Modes.md +++ b/website/Client Modes.md @@ -23,7 +23,7 @@ Disadvantages: # Synced mode $sync -In this mode, all content is synchronized to the client, and all processing happens there. The server effectively acts as a “dumb data store.” All SilverBullet functionality is available even when there is no network connection available. +In this mode, all content is synchronized to the client, and all processing happens there. The server effectively acts as a “dumb data store.” All SilverBullet functionality is available even when there is no network connection available. This requires SilverBullet to be served with HTTPS, otherwise the service worker responsible for sync won't launch. Advantages: * **100% offline capable**: disconnect your client from the network, shutdown the server, and everything still works. Changes synchronize automatically once a network connection is re-established. diff --git a/website/Install/Docker.md b/website/Install/Docker.md index 2a69a421..11f4171a 100644 --- a/website/Install/Docker.md +++ b/website/Install/Docker.md @@ -35,6 +35,8 @@ $ docker run -d --restart unless-stopped --name silverbullet -p 3000:3000 -v ./s There you go! +Note that to get offline mode to work you need to serve SilverBullet with HTTPS, via for example a reverse proxy. + # Versions The `zefhemel/silverbullet` image will give you the latest released version. This is equivalent to `zefhemel/silverbullet:latest`. If you prefer, you can also pin to a specific release, e.g. `zefhemel/silverbullet:0.6.0`. If you prefer to live on the bleeding edge, you can use the `zefhemel/silverbullet:edge` image, which is updated on every commit to the `main` brain. This is the YOLO option.