Custom Sync Server URL by hoellen · Pull Request #12459 · logseq/logseq

hoellen · 2026-03-18T00:58:15Z

This PR adds a setting to configure a custom sync server URL for self-hosted sync. The URL is persisted in localStorage and used to derive both the WebSocket and HTTP base URLs at runtime, replacing the previous compile-time constants.

What changed

Settings UI: New "Sync server URL" entry in the advanced settings section (desktop + mobile). Opens a dialog to enter, save, or reset the URL. Changes are pushed to the db worker immediately so they take effect without restarting.

handler/user.cljs: rtc-group? returns true when a custom sync server is configured, bypassing group membership checks. Self-hosted servers don't enforce group membership, so this is intentional.

Tests

Unit tests for new functions in config_test.cljs.

CLAassistant · 2026-03-18T00:58:23Z

All committers have signed the CLA.

Copilot

Pull request overview

This PR adds support for configuring a custom DB-sync server base URL (persisted in localStorage) to enable self-hosted sync servers, and adjusts runtime URL derivation for both HTTP and WebSocket sync endpoints. It also updates snapshot streaming to avoid double-gzip decompression issues when fetch() auto-decompresses but leaves the content-encoding: gzip header intact.

Changes:

Add a new “Sync server URL” advanced setting (desktop + mobile) and a dialog to save/reset the custom URL; immediately pushes updated sync config to the DB worker.
Replace compile-time DB-sync URL constants with runtime functions that derive WS/HTTP URLs from the optional custom base.
Simplify response-body-stream to always use resp.body and update tests to match real-world fetch() decompression behavior.

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
src/main/frontend/config.cljs	Adds custom sync server URL persistence + URL derivation helpers and runtime getters for WS/HTTP bases.
src/main/frontend/components/settings.cljs	Adds desktop settings row + dialog UI; pushes updated sync config to worker.
src/main/mobile/components/settings.cljs	Adds mobile settings entry that opens the same dialog and shows current/default URL.
src/main/frontend/handler/events/ui.cljs	Adds event handler to open the sync server settings dialog.
src/main/frontend/handler/user.cljs	Updates `rtc-group?` gating to allow RTC when a custom sync server is configured.
src/main/frontend/persist_db/browser.cljs	Updates worker init to call runtime URL getters.
src/main/frontend/components/repo.cljs	Updates worker sync-config setup to call runtime URL getters.
src/main/frontend/handler/db_based/sync.cljs	Uses runtime sync base getters; simplifies response body streaming to avoid double-decompression.
src/main/frontend/spec/storage.cljc	Adds local-storage spec entry for the sync server URL key.
src/resources/dicts/en.edn	Adds i18n strings for the new sync server URL settings UI.
src/test/frontend/config_test.cljs	Adds unit tests for URL normalization/derivation helpers and defaults.
src/test/frontend/handler/db_based/sync_test.cljs	Updates snapshot streaming test to reflect real-world `fetch()` auto-decompression behavior.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-30T09:34:31Z

+  "Return true when `url` looks like a valid HTTP(S) base URL."
+  [url]
+  (and (string? url)
+       (re-find #"^https?://" url)))


valid-sync-server-url? is currently a simple regex prefix check, which will accept strings like "https://" (no host) and other malformed URLs that will later fail at fetch/WebSocket time. Consider validating via js/URL parsing (and ensuring protocol is http/https and hostname is present) so the UI can reliably reject invalid inputs.

Suggested change

"Return true when `url` looks like a valid HTTP(S) base URL."

[url]

(and (string? url)

(re-find #"^https?://" url)))

"Return true when `url` is a syntactically valid HTTP(S) base URL

with a non-empty hostname."

[url]

(when (string? url)

(try

(let [u (js/URL. url)

protocol (.-protocol u)

hostname (.-hostname u)]

(and (#{"http:" "https:"} protocol)

(seq hostname)))

(catch :default _

false))))

hoellen · 2026-04-09T11:37:14Z

@tiensonqin I rebased my branch on current master. I removed the commit 9a3b4d8 as you fixed it on master.
Let me know if I need to change something or if I should include any of the suggestions from the Copilot review.

tiensonqin · 2026-04-09T11:41:30Z

@hoellen Sorry for the late reply, I still have some work to finish on sync, mostly to ensure client/server checksum matches. I'll check this PR asap.

tiensonqin

QAed on web/mobile/desktop apps, works great! 🚢 👍

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Add custom sync server Co-authored-by: Tienson Qin <tiensonqin@gmail.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Mirror the Custom Sync Server URL pattern (logseq#12459) for the single-page publish service. Settings -> Advanced -> Publish server URL opens a dialog that writes the URL to localStorage; frontend.config/publish-api-base reads it on each call so URL changes take effect without a restart. Unlike sync, publish does not need a push-config-to-worker step because the handler is purely HTTP request-response with no long-lived connection.

tiensonqin requested review from Copilot and tiensonqin March 30, 2026 09:27

tiensonqin force-pushed the feat/dbsync-custom branch from ee130ca to 9a3b4d8 Compare March 30, 2026 09:27

Copilot started reviewing on behalf of tiensonqin March 30, 2026 09:28 View session

Copilot AI reviewed Mar 30, 2026

View reviewed changes

hoellen force-pushed the feat/dbsync-custom branch from 9a3b4d8 to f338fed Compare April 9, 2026 11:36

tiensonqin force-pushed the feat/dbsync-custom branch from f338fed to 7898280 Compare April 13, 2026 03:07

tiensonqin approved these changes Apr 13, 2026

View reviewed changes

hoellen and others added 3 commits April 13, 2026 12:59

Add custom sync server

325fa1c

Update src/resources/dicts/en.edn

cdd9566

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update src/main/frontend/components/settings.cljs

b508034

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

tiensonqin force-pushed the feat/dbsync-custom branch from 5bf6109 to b508034 Compare April 13, 2026 04:59

tiensonqin merged commit 8997638 into logseq:master Apr 13, 2026
2 checks passed

tiensonqin added a commit that referenced this pull request Apr 14, 2026

Custom Sync Server URL (#12459)

747edf3

* Add custom sync server Co-authored-by: Tienson Qin <tiensonqin@gmail.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

hoellen deleted the feat/dbsync-custom branch April 16, 2026 07:22

deephbz mentioned this pull request Apr 18, 2026

feat: configurable publish server URL #12520

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Custom Sync Server URL#12459

Custom Sync Server URL#12459
tiensonqin merged 3 commits intologseq:masterfrom
hoellen:feat/dbsync-custom

hoellen commented Mar 18, 2026 •

edited

Loading

Uh oh!

CLAassistant commented Mar 18, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI Mar 30, 2026

Uh oh!

Uh oh!

hoellen commented Apr 9, 2026 •

edited

Loading

Uh oh!

tiensonqin commented Apr 9, 2026

Uh oh!

tiensonqin left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

-  "Return true when `url` looks like a valid HTTP(S) base URL."
-  [url]
-  (and (string? url)
-       (re-find #"^https?://" url)))
+  "Return true when `url` is a syntactically valid HTTP(S) base URL
+   with a non-empty hostname."
+  [url]
+  (when (string? url)
+    (try
+      (let [u (js/URL. url)
+            protocol (.-protocol u)
+            hostname (.-hostname u)]
+        (and (#{"http:" "https:"} protocol)
+             (seq hostname)))
+      (catch :default _
+        false))))

Uh oh!

Conversation

hoellen commented Mar 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What changed

Tests

Uh oh!

CLAassistant commented Mar 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

hoellen commented Apr 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tiensonqin commented Apr 9, 2026

Uh oh!

tiensonqin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

hoellen commented Mar 18, 2026 •

edited

Loading

CLAassistant commented Mar 18, 2026 •

edited

Loading

hoellen commented Apr 9, 2026 •

edited

Loading