Document proxy config

kpcyrd · Jan 1, 2019 · 6fbebd8 · 6fbebd8
1 parent 86c2b91
commit 6fbebd8
Showing 4 changed files with 21 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -63,6 +63,8 @@ Join us on IRC: <ircs://irc.hackint.org/#sn0int>
   - [Managing the keyring](https://sn0int.readthedocs.io/en/latest/keyring.html#managing-the-keyring)
   - [Using access keys in scripts](https://sn0int.readthedocs.io/en/latest/keyring.html#using-access-keys-in-scripts)
   - [Using access keys as source argument](https://sn0int.readthedocs.io/en/latest/keyring.html#using-access-keys-as-source-argument)
+- [Configuration](https://sn0int.readthedocs.io/en/latest/config.html)
+  - [Configuring a proxy](https://sn0int.readthedocs.io/en/latest/config.html#configuring-a-proxy)
 - [Function reference](https://sn0int.readthedocs.io/en/latest/reference.html)
 
 ## License

diff --git a/docs/config.rst b/docs/config.rst
@@ -0,0 +1,17 @@
+Configuration
+=============
+
+This file documents the config file at ``~/.config/sn0int.toml``. By default
+this file does not exist and a default configuration is used instead.
+
+Configuring a proxy
+-------------------
+
+To enable a proxy, add the following to your config file::
+
+    [network]
+    proxy = "127.0.0.1:9050"
+
+This forces everything through tor and restricts all other functions that
+depend on the network. For example the ``dns`` function is fully disabled if a
+proxy is configured.
diff --git a/docs/index.rst b/docs/index.rst
@@ -40,4 +40,5 @@ Getting Started
    scripting
    database
    keyring
+   config
    reference
diff --git a/docs/man.rst b/docs/man.rst
@@ -10,4 +10,5 @@ todo
     :glob:
 
     usage
+    config
     reference
-Original file line number
+Diff line change
@@ @@ -10,4 +10,5 @@ todo @@
         :glob:
         usage
+        config
         reference