Maximilian Hils
18f2009074
update installation page
...
We emphasize the binary installation because that is usually the simplest
method to install mitmproxy on all major platforms.
2016-12-20 17:37:20 +01:00
Maximilian Hils
7de3507f9a
docs: add mitmweb stub
2016-12-20 17:37:12 +01:00
Maximilian Hils
98a079aa69
rename logging.py example. this conflicted with Python's stdlib
2016-12-19 16:21:17 +01:00
Aldo Cortesi
aa90fd359d
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.
2016-12-17 10:57:13 +13:00
Aldo Cortesi
007aeef770
Addon test docs, remove stray deprecated events
...
Fixes #1572
2016-12-17 10:03:35 +13:00
Maximilian Hils
8f04225450
fix install.rst
2016-12-11 17:49:07 +01:00
Thomas Kriechbaumer
81b5788dfc
docs: update installation
2016-12-11 11:14:00 +01:00
Thomas Kriechbaumer
3353aa3cfd
fix docs
2016-11-23 10:18:45 +01:00
Thomas Kriechbaumer
aaa4ccc284
websocket: add event documentation
2016-11-23 10:18:45 +01:00
Thomas Kriechbaumer
ffb3988dc9
rename WebSocket{s,} protocol
2016-11-23 10:18:45 +01:00
Maximilian Hils
9af8f4bb31
organize examples
...
This commit is largely based on work by Thiago Arrais (@thiagoarrais)
and Shane Bradfield (@l33tLumberjack). I wasn't really able to get their
PR reasonably merged onto the latest master, so I reapplied their changes
manually here and did some further improvements on that.
2016-11-21 02:28:10 +01:00
Quentin Pradet
eb7bcb37ec
docs: Fix typos
2016-11-14 08:43:32 +04:00
Aldo Cortesi
9b08279c7c
addons.proxyauth: out with the old, in with the new
...
- Strip out old auth mechanisms, and enable addon
- Disable web app auth for now - this should just use the Tornado auth stuff
2016-11-13 19:59:59 +13:00
Aldo Cortesi
a9b4560187
Refine handling of HTTP CONNECT
...
- CONNECT requests do not generate the usual http events. Instead, they
generate the http_connect event and handlers then have the option of setting an
error response to abort the connect.
- The connect handler is called for both upstream proxy and regular proxy CONNECTs.
2016-11-12 18:28:37 +13:00
Naveen Pai
a43e2047b0
[MINOR] fix link in documentation
2016-11-04 03:04:55 +05:30
Andrew Orr
bff75f4ff6
Update for Ubuntu 16.04
2016-10-31 17:11:51 -05:00
Aldo Cortesi
0b2a2ad2a6
docs: examples/logging -> examples/context_logging
2016-10-30 16:58:50 +13:00
Aldo Cortesi
ed9b40040b
docs: fix broken version
2016-10-21 11:18:55 +13:00
Aldo Cortesi
8430f857b5
The final piece: netlib -> mitproxy.net
2016-10-20 11:56:38 +13:00
Aldo Cortesi
7440232f60
netlib.version -> mitmproxy.version
2016-10-20 09:20:44 +13:00
Aldo Cortesi
e73c7fe77e
mitmproxy.protocol -> mitmproxy.proxy.protocol
...
The protocols here are compltely proxy-specific, are only used from within the
proxy module, and are not exposed to users.
2016-10-19 23:11:56 +13:00
Aldo Cortesi
24cf8da27e
Move all tools into mitmproxy.tools, move models/* to top level
...
The primary motivation here (and for all the other moving around) is to present
a clean "front of house" to library users, and to migrate primary objects to
the top of the module hierarchy.
2016-10-19 20:26:05 +13:00
Aldo Cortesi
22eebfd574
addons.Addons -> addonmanager, builtins -> addons
2016-10-19 14:39:39 +13:00
Aldo Cortesi
8360f70024
First-order conversion to Python3-only
...
- Zap various occurrences of Python2 in docs and scripts
- Remove six from netlib, and some other places where obvious project-wide
search and replace works.
2016-10-17 15:18:47 +13:00
Aldo Cortesi
00603021d9
docs: concurrency, developing scripts
2016-10-16 20:39:34 +13:00
Aldo Cortesi
57b8ed21a9
docs: scripts on saved flows
2016-10-16 20:26:06 +13:00
Maximilian Hils
072fff90f1
docs: link to correct tag
2016-10-16 20:26:06 +13:00
Aldo Cortesi
55cb2a8547
docs: logging and the context
2016-10-16 20:26:06 +13:00
Aldo Cortesi
fb69c9c345
docs: overview, classes, arguments
2016-10-16 20:26:06 +13:00
Aldo Cortesi
61040a7bcd
docs: improve external source links, tweak code docs
2016-10-16 20:26:06 +13:00
Aldo Cortesi
fdb6a44245
docs: cleanups improvements and fighting sphinx
...
- Hide links to internal code listings, and link to github instead
- Improve formatting of code/example captions
- Fix outdated documentation of command-line options
- Complete documentation of all events + improved formatting
- tcp_open -> tcp_start, tcp_close -> tcp_end to reduce confusion
2016-10-16 20:26:06 +13:00
Sanchit Sokhey
61a1b96ca4
Issue 1461 ( #1609 )
...
* doc changes
* doc changes
* doc changes
* doc changes
* Documentation updated
* Documentation for custom certificate updated
2016-10-13 19:46:12 -07:00
Thomas Kriechbaumer
90898f9084
use flt instead of filt for flowfilter expressions
2016-10-04 14:51:04 +02:00
Aldo Cortesi
b735694653
websockets_handshake -> websocket_handshake
...
The plural feels awkward.
2016-10-04 08:13:56 +11:00
Thomas Kriechbaumer
ba84248910
rename mitmproxy.filt -> mitmproxy.flowfilter
2016-10-03 11:45:54 +02:00
Maximilian Hils
19abb54919
fix docs
2016-10-02 23:08:51 -07:00
Aldo Cortesi
6d1f036021
Merge remote-tracking branch 'upstream/master'
2016-09-30 11:02:08 +10:00
Aldo Cortesi
825b0917bd
docs: minor formatting/cleanups
2016-09-30 10:59:40 +10:00
Aldo Cortesi
e8aca92ef1
docs: remove auto-generated stubs
...
These are too verbose/low info for these docs. We should include pointers to
where to start reading the code, and perhaps later we can include full
auto-generated API docs separately.
2016-09-30 09:54:35 +10:00
Aldo Cortesi
7998c1ff86
docs: make sidebar headings more legible
2016-09-30 09:34:24 +10:00
Maximilian Hils
d068000f16
fix typo
2016-09-28 17:44:48 -07:00
Ryan Laughlin
e0f9aef89c
Update reverse proxy host header docs
2016-09-26 22:30:01 -07:00
smill
2d4e4eafe1
Fixed restructuredText error.
2016-09-15 18:54:55 +00:00
smill
fad6ee6437
Improved the documentation.
2016-09-05 14:19:08 +00:00
smill
fbfedbdc8f
Improved error-handling / supplemented documention.
2016-09-04 01:30:27 +00:00
Aldo Cortesi
46143ba004
Merge pull request #1482 from Kriechi/improve-docs
...
update docs: how mitmproxy works
2016-09-03 09:59:54 +12:00
Thomas Kriechbaumer
823d8a5da8
add docs for websocket_handshake hook
2016-09-01 09:57:36 +02:00
Maximilian Hils
f27028f58e
introduce Response.make for simple response creation
2016-08-23 00:17:06 -07:00
Thomas Kriechbaumer
9671fd8d62
update docs: introduction
2016-08-17 05:13:49 +02:00
Thomas Kriechbaumer
709ed0c0be
update docs: how mitmproxy works
2016-08-15 13:08:10 +02:00
Maximilian Hils
3aa2d59f62
Update install.rst
2016-08-02 23:20:58 -07:00
Drake Caraker
2fde1d0b53
Update gamecenter.rst
...
Typo fix: changed plist score value from '0' to '55', aligning with the subsequent explanatory text.
2016-07-16 15:24:56 -07:00
Maximilian Hils
3602fd7a36
Merge remote-tracking branch 'origin/master' into message-body-encoding
2016-07-15 23:17:57 -07:00
Maximilian Hils
7c67faa8da
remove script contexts
2016-07-07 23:50:55 -07:00
Maximilian Hils
6032c4f235
message.content -> .raw_content, implement .text
...
This PR improves our handling of HTTP message body encodings:
- The unaltered message body is now accessible as `.raw_content`
- The "content-encoding"-decoded content (i.e. gzip removed) content
is not `.content`, as this is what we want in 99% of the cases.
- `.text` now provides the "content-encoding"-decoded and then
"content-type charset"-decoded message body.
- The decoded values for `.content` and `.text` are cached,
so that repeated access and `x.text = x.text` is cheap.
- The `decoded()` decorator is now deprecated, as we can now just use
`.content`. Similarly `HTTPMessage.get_decoded_content()` is
deprecated.
2016-07-02 01:51:47 -07:00
Maximilian Hils
ac860c6fc0
improve docs, fix #1290
2016-06-29 00:38:11 -07:00
Maximilian Hils
588dad1bc7
minor docs fix
2016-06-26 14:42:12 -07:00
Maximilian Hils
ed05d3f858
Merge pull request #1285 from westurner/patch-1
...
DOC: install.rst: Installation on Fedora, Ubuntu
2016-06-23 15:44:29 -07:00
BSalita
a77e850b6f
Show how to upgrade pip.
...
Windows install failed due to out of date pip. Show how to upgrade to latest pip.
2016-06-22 14:49:41 +02:00
Wes Turner
514d75cedd
DOC: install.rst: Installation on Fedora, Ubuntu
2016-06-21 19:14:13 -05:00
Maximilian Hils
63c6660895
update examples, tests, docs
2016-06-13 18:17:09 -07:00
Aldo Cortesi
728d5caa22
Fold mitmproxy.version and pathod.version into netlib.version
2016-06-12 10:29:12 +12:00
Aldo Cortesi
c421c41307
Remove odict
...
- Adds default implementations for _kconv and _reduce_values to MultiDict.
Without these, operations fail in really, really non-obvious ways.
- Replace the remaining few instances of ODict
Fixes #1159
2016-06-09 13:28:43 +12:00
Maximilian Hils
b180bfcf35
fix docs
2016-06-06 19:30:45 -07:00
Maximilian Hils
83f8522981
docs: remove option directive
...
inserting " .. option::" tags create ugly markup, so we just ditch this
entirely and continue using refs.
2016-06-06 19:10:19 -07:00
Maximilian Hils
9a1cc16643
fix MultiView docs
2016-06-06 19:10:19 -07:00
Aldo Cortesi
9b7de5c98f
docs: adjust theme override inclusion
...
https://github.com/rtfd/readthedocs.org/issues/2116
2016-06-07 13:54:40 +12:00
Aldo Cortesi
e037fe05ff
Migrate pathod docs to Sphinx
...
All the content of the pathod docs are moved into Sphinx. The interactive
format has not translated well to static docs, and there's still a lot of
rewriting, format fixing, structuring, etc to be done.
2016-06-07 12:55:32 +12:00
Maximilian Hils
56b9ec0974
docs++
2016-05-18 22:50:45 -07:00
Maximilian Hils
d84fc645a7
docs: minor fixes
2016-04-30 15:25:02 -07:00
Maximilian Hils
613a05b5b7
Update certinstall.rst
2016-04-28 15:22:23 -07:00
Maximilian Hils
228197185e
Merge branch 'master' of https://github.com/mitmproxy/mitmproxy
2016-04-11 14:14:27 -07:00
Maximilian Hils
14e9b0a0ac
docs: better data structure docs
2016-04-11 14:13:48 -07:00
Felix Yan
5dc7b11229
Add installation instructions for Arch Linux ( #1079 )
2016-04-11 11:47:48 -07:00
Maximilian Hils
7208a7543f
docs: fix logo
2016-04-10 00:07:51 -07:00
Matthew Shao
53e15f778d
update document for the removal of CONTENT_MISSING
2016-03-26 16:17:55 +08:00
Aldo Cortesi
08f44b9fad
Doc tweaks
...
This patch does the following:
- Fixes all warnings in the doc tree
- Adds a modd + devd conf file that renders HTML and treats doc warnings as
errors. This lets you send warning output to your desktop notifier, and gives
livereload similar to the livehtml entry in the Makefile.
- Some small tweaks
Sphinx currently has a bug that causes unknown options to generate a warning:
https://github.com/sphinx-doc/sphinx/issues/2229
This is fixed in stable, but not yet released. You can update Sphinx to the
latest stable like so:
pip install --upgrade https://github.com/sphinx-doc/sphinx/archive/stable.zip
2016-02-21 11:47:17 +13:00
Aldo Cortesi
92597f82ea
Docs and examples to top level
2016-02-18 09:27:08 +13:00
Maximilian Hils
33fa49277a
move mitmproxy
2016-02-15 14:58:46 +01:00
Maximilian Hils
8d8ae74102
workaround for RTD issue rtfd/readthedocs.org#152
2016-02-11 00:38:49 +01:00
Maximilian Hils
b0dc44428e
fix #823
2016-02-10 19:42:41 +01:00
Maximilian Hils
db719f1673
remove compatible version specifiers
2016-02-05 22:59:24 +01:00
David Weinstein
4be8d148b1
Add SNI ignore docs and have code match it
2016-01-26 13:09:22 -05:00
Michael J. Bazzinotti
e766838a1a
Add Inline Script Hooks to TCP mode
2016-01-10 13:05:01 -05:00
Michael J. Bazzinotti
80690b7906
[docs/libmproxy/test] Support single client-side cert file as argument to
...
--client-certs
2015-12-28 15:20:45 -05:00
Jakub Wilk
c8f9f4c17e
docs: fix typos
2015-12-12 11:18:56 +01:00
Maximilian Hils
59d3e9d954
docs++
2015-11-07 20:43:10 +01:00
David Dworken
96465075f4
Added information on cert pinning ( Fixes #689 )
2015-11-06 21:23:10 -05:00
Maximilian Hils
c62abd67d2
docs: fix broken graphic
2015-11-02 13:04:35 +01:00
Maximilian Hils
96db5edc5c
docs: improve mode flowchart
2015-11-02 11:50:08 +01:00
Maximilian Hils
51a3378290
improve reverse proxy docs
2015-11-02 10:47:14 +01:00
Nick Badger
4537d561c6
Ubuntu install missing libjpeg8-dev, zlib1g-dev
...
As per https://pillow.readthedocs.org/en/3.0.0/installation.html#linux-installation , to avoid missing install dependencies.
2015-10-22 18:11:06 -07:00
Nick Badger
a6fee43384
Update ubuntu installation to includ libjpeg
...
Otherwise install fails with error "--enable-jpeg requested but jpeg not found"
2015-10-22 17:38:55 -07:00
Ben Lerner
22191d63ab
doc typo fix
2015-10-13 21:09:56 -04:00
Maximilian Hils
1b6ea5caf3
adjust to netlib response changes + docs
2015-09-26 17:41:14 +02:00
Maximilian Hils
b13acd7956
adjust to netlib request changes + docs
2015-09-26 01:23:59 +02:00
Maximilian Hils
bba5ec7144
experimental: run tests using py.tests
2015-09-21 18:31:30 +02:00
Maximilian Hils
774d5b42a2
improve readme
2015-09-16 03:59:22 +02:00
Maximilian Hils
c3ba98b681
docs: update documentedlist, add filter table headers
2015-09-08 15:36:24 +02:00
Maximilian Hils
c4286b15dc
docs: minor fixes
2015-09-07 10:52:18 +02:00