Better troubleshooting docs

troubleshooting.adoc

@@ -16,8 +16,8 @@ image:images/icons/Discord.png[inline] link:https://discord.gg/jhYWWpNJ3v[Chat o
 
 OliveTin has a useful feature to gather information about your installation that is useful when you're asking for help - when you have a support request. If you are able to provide sosreport, this generally helps others help you a lot. The **sosreport** feature does NOT send any information to the developers or anybody else, it's simply text - **copy and paste it** to where someone is trying to help you!
 
-An example sosreport is here;
-
+[source,yaml]
+.Example SOS Report
 ----
 ### SOSREPORT START (copy all text to SOSREPORT END)
 # Build:
@@ -41,10 +41,23 @@ loglevel: INFO
 
 You can then copy and paste this text into a GitHub issue, discussion, Discord chat, or wherever else someone might be helping you.
 
+
 ==== How do I generate a sosreport?
 
 OliveTin needs to be able to startup and it's API needs to be functional. Once OliveTin is started, simply browse to: http://myserver:1337/api/sosreport
 
+==== Optional: Allow insecure (but easy) dumping of SOS Reports to the browser
+
+There is a configuration option you can set in your config.yaml that allows you to easily dump SOS Reports to your browser when visiting the API. This is turned off by default, as you should not allow anybody to request a sosreport at any time that they like, but you can enable this option temporarily to easily get access to the SOS Report.
+
+[source,yaml]
+.`config.yaml`
+----
+InsecureAllowDumpSos: true
+----
+
+==== Default: SOS Report dump to logs
+
 You should get a simple JSON message saying something like;
 
 ----
@@ -102,3 +115,24 @@ This is most likely because you are using a very old browser, or have some Javas
 This page describes the compatible browsers for Javascript modules; https://caniuse.com/es6-module .
 
 There is no workaround for this apart from updating your browser / using a better browser, as OliveTin wants to be a progressive web app and doesn't intend to support browsers without module support.
+
+[#advanced-troubleshooting]
+=== Advanced Troubleshooting
+
+Sometimes you need to really see what OliveTin is doing, especially when debugging entities. OliveTin has several built-in options for advanced troubleshooting, but enabling these output options can expose sensitive information, so they can be insecure.
+
+NOTE: OliveTin itself is not "insecure" by using these options, they would not let attackers execute different commands or anything like that. It's just that using these options can expose data (like entity files) that maybe you don't want an attacker to see.
+
+[#dump-sos]
+==== Dump SOS Reports
+`InsecureAllowDumpSos: true` - will allow dumping <<sosreport,SOS Reports>> as plain text when visiting `http://server:1337/api/sosreport`
+
+[#dump-action-map]
+==== Dump Action Map
+`InsecureAllowDumpActionMap: true` - will allow dumping all the actions (and those generated with entities) and their public IDs, eg: `http://server:1337/api/DumpPublicActionMap`
+
+[#dump-vars]
+==== Dump Vars
+`InsecureAllowDumpVars: true` - will allow dumping all the "string variables" from a map that is mainly used for entities, eg: `http://server:1337/api/DumpVars`
+
+All these configuration options are `false` by default, and should be deleted from the config or reset back to `false` when you are not using them.