Skip to content

Commit 29c4b36

Browse files
authored
chore: remove removed debugging endpoint, toggle (#949)
1 parent 0fa14af commit 29c4b36

File tree

5 files changed

+3
-40
lines changed

5 files changed

+3
-40
lines changed

rest/debug.rst

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,6 @@
11
Debug Endpoints
22
================
33

4-
These endpoints require the :stconf:opt:`gui.debugging` configuration option to
5-
be enabled and yield an access denied error code otherwise.
6-
7-
8-
GET /rest/debug/peerCompletion
9-
------------------------------
10-
11-
Summarizes the completion percentage for each remote device. Returns an object
12-
with device IDs as keys and an integer percentage as values.
13-
14-
15-
GET /rest/debug/httpmetrics
16-
---------------------------
17-
18-
Returns statistics about each served REST API endpoint, to diagnose how much
19-
time was spent generating the responses.
20-
21-
224
GET /rest/debug/cpuprof
235
-----------------------
246

rest/system-config-get.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,6 @@ Returns the current configuration.
103103
"apiKey": "k1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1",
104104
"insecureAdminAccess": false,
105105
"theme": "default",
106-
"debugging": false,
107106
"insecureSkipHostcheck": false,
108107
"insecureAllowFrameLoading": false
109108
},

users/config.rst

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ The following shows an example of a default configuration file (IDs will differ)
138138
<untrusted>false</untrusted>
139139
<remoteGUIPort>0</remoteGUIPort>
140140
</device>
141-
<gui enabled="true" tls="false" debugging="false">
141+
<gui enabled="true" tls="false">
142142
<address>127.0.0.1:8384</address>
143143
<apikey>k1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1</apikey>
144144
<theme>default</theme>
@@ -814,7 +814,7 @@ GUI Element
814814

815815
.. code-block:: xml
816816
817-
<gui enabled="true" tls="false" debugging="false">
817+
<gui enabled="true" tls="false">
818818
<address>127.0.0.1:8384</address>
819819
<apikey>k1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1</apikey>
820820
<theme>default</theme>
@@ -836,11 +836,6 @@ set on the ``gui`` element:
836836
be redirected to HTTPS. When set to ``false``, TLS connections are
837837
still possible but not required.
838838

839-
.. option:: gui.debugging
840-
841-
This enables :doc:`/users/profiling` and additional endpoints in the REST
842-
API, see :doc:`/rest/debug`.
843-
844839
The following child elements may be present:
845840

846841
.. option:: gui.address

users/faq-parts/usage.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ For example, the two emphasized lines below would be removed from the file.
281281
.. code-block:: text
282282
:emphasize-lines: 3,4
283283
284-
<gui enabled="true" tls="false" debugging="false">
284+
<gui enabled="true" tls="false">
285285
<address>127.0.0.1:8384</address>
286286
<user>syncguy</user>
287287
<password>$2a$10$s9wWHOQe...Cq7GPye69</password>

users/profiling.rst

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,6 @@ have caused most memory to be allocated.
1515
Neither of the profiles contain any private data about your setup - only
1616
what parts of the program are using resources.
1717

18-
Enable Debugging
19-
----------------
20-
21-
Debugging must be enabled to be able to capture profiles. To enable
22-
debugging, open the advanced settings:
23-
24-
.. image:: advanced-settings.png
25-
26-
Enable the "debugging" setting under "GUI", and then scroll down and **Save**.
27-
No restart is necessary.
28-
29-
.. image:: gui-debugging.png
30-
3118
Capture a CPU profile
3219
---------------------
3320

0 commit comments

Comments
 (0)