diff options
| author | Aldo Cortesi <aldo@nullcube.com> | 2016-12-17 10:57:13 +1300 |
|---|---|---|
| committer | Aldo Cortesi <aldo@nullcube.com> | 2016-12-17 10:57:13 +1300 |
| commit | aa90fd359dc69481907bacd0406294a1f842497c (patch) | |
| tree | 3a3f3e19adefababa7a8d79c1301c05af11d28c1 /docs/config.rst | |
| parent | 2fe7cf448de8a87f7d1ed96ec753d440723536a3 (diff) | |
| download | mitmproxy-aa90fd359dc69481907bacd0406294a1f842497c.tar.gz mitmproxy-aa90fd359dc69481907bacd0406294a1f842497c.tar.bz2 mitmproxy-aa90fd359dc69481907bacd0406294a1f842497c.zip | |
Administrivia: docs for new config file, minor adjustments
For now, the config file docs basically say "it's YAML, read the source". We
should do better for the next release.
Diffstat (limited to 'docs/config.rst')
| -rw-r--r-- | docs/config.rst | 85 |
1 files changed, 6 insertions, 79 deletions
diff --git a/docs/config.rst b/docs/config.rst index ad55baed..1b0921ec 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -3,84 +3,11 @@ Configuration ============= -Mitmproxy is configured through a set of files in the users ~/.mitmproxy -directory. +Mitmproxy is configured with a YAML_ file, located at +``~/.mitmproxy/config.yaml``. We'll have complete documentation for all +supported options in the next release in the meantime, please consult the +source_ for a complete list of options and types. -mitmproxy.conf - Settings for the :program:`mitmproxy`. This file can contain any options supported by - mitmproxy. -mitmdump.conf - Settings for the :program:`mitmdump`. This file can contain any options supported by mitmdump. - -common.conf - Settings shared between all command-line tools. Settings in this file are over-ridden by those - in the tool-specific files. Only options shared by mitmproxy and mitmdump should be used in - this file. - -Syntax ------- - -Comments -^^^^^^^^ - -.. code-block:: none - - # this is a comment - ; this is also a comment (.ini style) - --- and this is a comment too (yaml style) - -Key/Value pairs -^^^^^^^^^^^^^^^ - -- Keys and values are case-sensitive -- Whitespace is ignored -- Lists are comma-delimited, and enclosed in square brackets - -.. code-block:: none - - name = value # (.ini style) - name: value # (yaml style) - --name value # (command-line option style) - - fruit = [apple, orange, lemon] - indexes = [1, 12, 35 , 40] - -Flags -^^^^^ - -These are boolean options that take no value but true/false. - -.. code-block:: none - - name = true # (.ini style) - name - --name # (command-line option style) - -Options -------- - -The options available in the config files are precisely those available as -command-line flags, with the key being the option's long name. To get a -complete list of these, use the ``--help`` option on each of the tools. Be -careful to only specify common options in the **common.conf** file - -unsupported options in this file will be detected as an error on startup. - -Examples --------- - -common.conf -^^^^^^^^^^^ - -Note that ``--port`` is an option supported by all tools. - -.. code-block:: none - - port = 8080 - -mitmproxy.conf -^^^^^^^^^^^^^^ - -.. code-block:: none - - palette = light +.. _YAML: http://www.yaml.org/start.html +.. _source: https://github.com/mitmproxy/mitmproxy/blob/master/mitmproxy/options.py |