From fe74a776e9a8dfc8821d5028777028f76fe42783 Mon Sep 17 00:00:00 2001 From: "jeremy@jermolene.com" Date: Fri, 9 Sep 2022 10:02:26 +0100 Subject: [PATCH] Docs: Add note for retrieving system tiddlers via HTTP under Node.js See #6866 --- ...den Setting Sync System Tiddlers From Server.tid | 13 +++++++++++++ .../webserver/WebServer API_ Get All Tiddlers.tid | 4 +++- 2 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 editions/tw5.com/tiddlers/hiddensettings/Hidden Setting Sync System Tiddlers From Server.tid diff --git a/editions/tw5.com/tiddlers/hiddensettings/Hidden Setting Sync System Tiddlers From Server.tid b/editions/tw5.com/tiddlers/hiddensettings/Hidden Setting Sync System Tiddlers From Server.tid new file mode 100644 index 000000000..88f82b4b6 --- /dev/null +++ b/editions/tw5.com/tiddlers/hiddensettings/Hidden Setting Sync System Tiddlers From Server.tid @@ -0,0 +1,13 @@ +created: 20220909094340097 +modified: 20220909094340097 +title: Hidden Setting: Sync System Tiddlers From Server +tags: [[Hidden Settings]] + +<<.from-version "5.1.23">> Determines whether system tiddlers are synced from the server under Node.js. (Note that this is a one-way setting; system tiddlers are always synced //to// the server). + +* `no` -- system tiddlers are not synced from the server (default) +* `yes` -- system tiddlers are synced from the server + +Engaging sync of system tiddlers means that tiddlers such as $:/StoryList and $:/HistoryList get synced, which can lead to unexpected outcomes when multiple users are connected to the same server at the same time (it means that the story sequence is synced between all the users). + +$:/config/SyncSystemTiddlersFromServer \ No newline at end of file diff --git a/editions/tw5.com/tiddlers/webserver/WebServer API_ Get All Tiddlers.tid b/editions/tw5.com/tiddlers/webserver/WebServer API_ Get All Tiddlers.tid index 45bd1e27e..9c38f6157 100644 --- a/editions/tw5.com/tiddlers/webserver/WebServer API_ Get All Tiddlers.tid +++ b/editions/tw5.com/tiddlers/webserver/WebServer API_ Get All Tiddlers.tid @@ -1,5 +1,5 @@ created: 20181002131215403 -modified: 2020031109590546 +modified: 20220909094340097 tags: [[WebServer API]] title: WebServer API: Get All Tiddlers type: text/vnd.tiddlywiki @@ -17,6 +17,8 @@ Parameters: In order to avoid denial of service attacks with malformed filters in the default configuration the only filter that is accepted is the default filter "[all[tiddlers]!is[system]sort[title]]"; attempts to use any other filter will result in an HTTP 403 error. +<<.note "System tiddlers will not be returned by this API unless the [[Hidden Setting: Sync System Tiddlers From Server]] is explicitly switched on by setting $:/config/SyncSystemTiddlersFromServer to `yes`">> + To enable a particular filter, create a tiddler with the title "$:/config/Server/ExternalFilters/" concatenated with the filter text, and the text field set to "yes". For example, the TiddlyWeb plugin includes the following shadow tiddler to enable the filter that it requires: ```