From 8de5abfe24a5519b78990947321cd9484710f1c7 Mon Sep 17 00:00:00 2001 From: Jakob Borg Date: Sun, 10 Aug 2025 08:33:40 +0200 Subject: [PATCH 1/2] chore: remove removed debug endpoints --- rest/debug.rst | 18 ------------------ 1 file changed, 18 deletions(-) diff --git a/rest/debug.rst b/rest/debug.rst index 49de41d66..5ff1a5cc2 100644 --- a/rest/debug.rst +++ b/rest/debug.rst @@ -1,24 +1,6 @@ Debug Endpoints ================ -These endpoints require the :stconf:opt:`gui.debugging` configuration option to -be enabled and yield an access denied error code otherwise. - - -GET /rest/debug/peerCompletion ------------------------------- - -Summarizes the completion percentage for each remote device. Returns an object -with device IDs as keys and an integer percentage as values. - - -GET /rest/debug/httpmetrics ---------------------------- - -Returns statistics about each served REST API endpoint, to diagnose how much -time was spent generating the responses. - - GET /rest/debug/cpuprof ----------------------- From dd2879e455f228179dc1795f409f02b53c618f33 Mon Sep 17 00:00:00 2001 From: Jakob Borg Date: Sun, 10 Aug 2025 08:34:52 +0200 Subject: [PATCH 2/2] wip --- rest/system-config-get.rst | 1 - users/config.rst | 9 ++------- users/faq-parts/usage.rst | 2 +- users/profiling.rst | 13 ------------- 4 files changed, 3 insertions(+), 22 deletions(-) diff --git a/rest/system-config-get.rst b/rest/system-config-get.rst index 17a3891b1..b1897a110 100644 --- a/rest/system-config-get.rst +++ b/rest/system-config-get.rst @@ -103,7 +103,6 @@ Returns the current configuration. "apiKey": "k1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1", "insecureAdminAccess": false, "theme": "default", - "debugging": false, "insecureSkipHostcheck": false, "insecureAllowFrameLoading": false }, diff --git a/users/config.rst b/users/config.rst index 3d1f2bcc6..592ec2e41 100644 --- a/users/config.rst +++ b/users/config.rst @@ -138,7 +138,7 @@ The following shows an example of a default configuration file (IDs will differ) false 0 - +
127.0.0.1:8384
k1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1 default @@ -814,7 +814,7 @@ GUI Element .. code-block:: xml - +
127.0.0.1:8384
k1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1 default @@ -836,11 +836,6 @@ set on the ``gui`` element: be redirected to HTTPS. When set to ``false``, TLS connections are still possible but not required. -.. option:: gui.debugging - - This enables :doc:`/users/profiling` and additional endpoints in the REST - API, see :doc:`/rest/debug`. - The following child elements may be present: .. option:: gui.address diff --git a/users/faq-parts/usage.rst b/users/faq-parts/usage.rst index a12e598cc..2744239ee 100644 --- a/users/faq-parts/usage.rst +++ b/users/faq-parts/usage.rst @@ -281,7 +281,7 @@ For example, the two emphasized lines below would be removed from the file. .. code-block:: text :emphasize-lines: 3,4 - +
127.0.0.1:8384
syncguy $2a$10$s9wWHOQe...Cq7GPye69 diff --git a/users/profiling.rst b/users/profiling.rst index c6f6966e6..29af793bc 100644 --- a/users/profiling.rst +++ b/users/profiling.rst @@ -15,19 +15,6 @@ have caused most memory to be allocated. Neither of the profiles contain any private data about your setup - only what parts of the program are using resources. -Enable Debugging ----------------- - -Debugging must be enabled to be able to capture profiles. To enable -debugging, open the advanced settings: - -.. image:: advanced-settings.png - -Enable the "debugging" setting under "GUI", and then scroll down and **Save**. -No restart is necessary. - -.. image:: gui-debugging.png - Capture a CPU profile ---------------------