summaryrefslogtreecommitdiffstats
path: root/remote/doc/Prefs.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--remote/doc/Prefs.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/remote/doc/Prefs.md b/remote/doc/Prefs.md
new file mode 100644
index 0000000000..44b29b37e2
--- /dev/null
+++ b/remote/doc/Prefs.md
@@ -0,0 +1,32 @@
+Preferences
+===========
+
+There are a couple of preferences associated with the remote agent:
+
+
+Configurable preferences
+------------------------
+
+### `remote.enabled`
+
+Indicates whether the remote agent is enabled. When the remote
+agent is enabled, it exposes a [`--remote-debugging-port` flag] for Firefox.
+When set to false, the remote agent will not be loaded on startup.
+
+[`--remote-debugging` flag]: Usage.html
+
+### `remote.force-local`
+
+Limits the remote agent to be allowed to listen on loopback devices,
+e.g. 127.0.0.1, localhost, and ::1.
+
+### `remote.log.level`
+
+Defines the verbosity of the internal logger. Available levels
+are, in descending order of severity, `Trace`, `Debug`, `Config`,
+`Info`, `Warn`, `Error`, and `Fatal`. Note that the value is
+treated case-sensitively.
+
+### `remote.log.truncate`
+
+Defines whether long log messages should be truncated. Defaults to true.