Aldo Cortesi
3c52ed6ee1
Merge pull request #3012 from Kriechi/docs-options
...
docs: add auto-generated options reference
2018-03-30 09:38:17 +13:00
Michael Shi
f6b616aa89
Fixed Typo in Transparent Proxy Setup for Mac
...
Fixed typo referencing `en2` when it should mention `en0`
2018-03-26 21:30:14 -07:00
Thomas Kriechbaumer
f6699792da
docs: add auto-generated options reference
2018-03-25 13:42:55 +02:00
Maximilian Hils
0e62e386c0
docs: add skeleton for options script
2018-03-24 23:14:58 +01:00
Miheer Dewaskar
9ee96f0227
Merge master
2018-03-24 10:49:08 -04:00
Maximilian Hils
623f9b694d
fix cloudfront invalidation paths
2018-03-21 13:47:15 +01:00
Maximilian Hils
4eb6954c7d
various docs improvements
...
- add clickable anchors for headers
- add "outdated" warning for archived docs
- add "edit on github" button
- beautify template
2018-03-21 00:42:37 +01:00
Maximilian Hils
9748487939
improve transparent mode docs
2018-03-20 16:00:23 +01:00
Maximilian Hils
252684e14e
minor docs fixes
2018-03-20 16:00:02 +01:00
Maximilian Hils
885d3d5da4
add google analytics
2018-03-20 15:58:48 +01:00
Maximilian Hils
7c66c4eb16
abort doc scripts on error
2018-03-20 15:04:31 +01:00
Maximilian Hils
dc3c400b6b
add README for docs install
2018-03-20 15:00:29 +01:00
Miheer Dewaskar
00d51db925
Spelling
2018-03-11 19:03:45 -04:00
Miheer Dewaskar
d866b959fe
Extrac comment and typo
2018-03-11 19:01:14 -04:00
Miheer Dewaskar
6f802274c1
Workaround for MacOS transparent proxy
...
This workaround (adopted from #1261 ) allows MacOS users to redirect their machine's outgoing traffic to mitmproxy transparently.
2018-03-11 18:55:53 -04:00
Aldo Cortesi
760882a3d1
docs: cloudfront invalidation
2018-03-07 22:45:08 +13:00
Aldo Cortesi
fc23deb9f3
release: revamped release upload process
2018-03-07 11:40:45 +13:00
Aldo Cortesi
8792e07210
docs: enable upload to docs.mitmproxy.org/master
2018-03-07 09:01:51 +13:00
Aldo Cortesi
ee6937f948
docs: add robots.txt and error.html
...
- robots.txt prevents crawling of everything but /stable
- error.html has a simple meta refresh to the latest stable docs. This will
also help crawlers find the right path.
2018-03-05 10:57:50 +13:00
Aldo Cortesi
a68c7ffb27
docs: add build and upload scripts
...
The upload scripts might be unified down the track, or might not. CloudFront is
not set up for the docs bucket yet, so CDN invalidation is commented out. This
will be added later.
2018-03-05 10:51:46 +13:00
Aldo Cortesi
08e50aa39b
docs: port changes in .css to .scss source
2018-03-05 10:09:18 +13:00
Aldo Cortesi
5297e66a87
Merge pull request #2949 from Kriechi/docs-protocols
...
docs: add protocols description
2018-03-05 09:10:37 +13:00
Maximilian Hils
47f3a61a5c
Merge pull request #2948 from Kriechi/docs-sidebar-height
...
render sidebar without height limit
2018-03-04 19:46:00 +01:00
Thomas Kriechbaumer
618bd31bd8
docs: add protocols description
2018-03-03 13:36:06 +01:00
Thomas Kriechbaumer
f3a27e2779
render sidebar without height limit
2018-03-03 13:03:14 +01:00
Thomas Kriechbaumer
b4440c4252
make sidebar visually distinct
2018-03-03 13:00:20 +01:00
Thomas Kriechbaumer
a074a1df40
readd Wireshark SSL master secrets docs
2018-03-02 23:03:54 +01:00
Maximilian Hils
7eadd0c6ba
Merge pull request #2920 from kira0204/docs-2913
...
Docs updates
2018-02-25 18:32:15 +01:00
kira0204
302bf9875b
trans-1 update
2018-02-25 23:00:09 +05:30
kira0204
93ce72d0b1
few more fixes,picture mod
2018-02-25 22:52:12 +05:30
Aldo Cortesi
0d43bb550a
Merge pull request #2914 from kira0204/docs-2913
...
Updating docs
2018-02-25 10:09:45 +13:00
kira0204
f31ce49aa5
Fixing #2913
2018-02-24 23:47:55 +05:30
Monami Sharma
35fadd10bf
Spelling corrected for think*
...
Replaced "You should thin* of the mitmproxy" to "You should think* of the mitmproxy"
2018-02-24 11:12:57 -06:00
Aldo Cortesi
982508d30f
All new documentation
...
This patch does a lot.
- Ditch sphinx in favor of hugo. This gives us complete control of the layout
and presentation of our docs. Henceforth, docs will be hosted on our website
rather than ReadTheDocs.
- Create a simple, clean doc layout and theme.
- Remove large parts of the documentaion. I've ditched anything that was a)
woefully out of date, b) too detailed, or c) too hard to maintain in the long
term.
- Huge updates to the docs themselves: completely rewrite addons documentation,
add docs for core concepts like commands and options, and revise and tweak a
lot of the existing docs.
With this patch, we're also changing the way we publish and maintain the docs.
From now on, we don't publish docs for every release. Instead, the website will
contain ONE set of docs for each major release. The online docs will be updated
if needed as minor releases are made. Docs are free to improve during minor
releases, but anything that changes behaviour sufficiently to require a doc
change warrants a new major release. This also leaves us free to progressively
update and improve docs out of step with our release cadence.
With this new scheme, I feel CI over the docs is less important. I've removed
it for now, but won't object if someone wants to add it back in.
2018-02-22 18:07:58 +13:00
Maximilian Hils
baf4b5dc03
Merge pull request #2841 from aniketpanjwani/fix_linux_transparent_proxy_docs
...
Modify Linux transparent proxy docs to include ipv6 configuration.
2018-02-13 20:21:40 +01:00
Maximilian Hils
58a54febf3
docs: don't set accept_redirects.
...
it's not really clear why we are even doing this,
so let's just remove it entirely and see what happens.
Discussion: https://github.com/mitmproxy/mitmproxy/pull/2841#discussion_r165928492
2018-02-13 20:05:58 +01:00
Edward Medvedev
5eb2d8a813
Fix a typo in events.rst
...
This PR fixes a tiny typo in the documentation.
2018-02-11 14:20:53 +01:00
Gokul
2042b32f92
Updates the pfctl config
...
The previous config threw a syntax error when saving.
2018-02-09 10:42:41 +05:30
Aniket Panjwani
bb3e7ee86c
Modify Linux transparent proxy docs to include ipv6 configuration.
2018-02-04 10:42:03 -06:00
Maximilian Hils
68c32d8627
docs: minor improvements
2018-01-01 17:18:30 +01:00
Thomas Kriechbaumer
f123fb600d
websocket: docs++ and kill messages
...
fixes #2724
2017-12-27 22:01:28 +01:00
Thomas Kriechbaumer
e1f4d17ea7
cleanup transparent linux docs
2017-12-21 10:47:41 +01:00
Jim Higson
907ef4a02c
Update linux.rst
2017-12-21 10:47:41 +01:00
Maximilian Hils
b19eb333d3
minor docs improvements
...
1. The way the certificate is installed (mitm.it or not) does not matter.
2. Instructions are a bit shorter now and match those provided by Apple at https://support.apple.com/en-us/HT204477 .
2017-12-18 20:00:19 +01:00
jimhigson
4c4ca96017
move extra info for ios to ios section
2017-12-18 18:28:02 +00:00
Thomas Kriechbaumer
70e1409261
docs++: add websocket PING/PONG
2017-12-12 22:09:46 +01:00
Thomas Kriechbaumer
3cb459d56d
docs++: add individual protocol pages
2017-12-12 22:09:46 +01:00
rst0git
6853f72b38
docs-certinstall: Certificate pinning update link
...
Certificate pinning (HTTP Public Key Pinning) is better described on Wikipedia
2017-10-19 17:10:41 +01:00
rst0git
e689291377
docs-install: Fix typo
2017-10-18 20:39:12 +01:00
Thomas Kriechbaumer
f9d4d5f19c
update installation docs
2017-09-04 09:51:14 +02:00
Maximilian Hils
ad42e9ce96
docs: simplify install instructions
...
We only need pip3 now on all OSes as cryptography now ships wheels on Linux 🎉 .
Also remove `pip3 install --user` recommendation because that won't end up on $PATH.
2017-08-15 14:19:51 +02:00
Paulo Romeira
92daeeb026
docs: Fix typo
2017-07-29 04:54:52 -03:00
Maximilian Hils
f4eba8dd34
minor docs improvements
2017-07-04 10:53:23 +02:00
Ujjwal Verma
6367dcab8e
update streaming docs
2017-07-04 10:53:23 +02:00
Zhigang Fang
fdec51d732
Note to enable Certificate Trust Settings in iOS 10.3 or up ( #2312 )
2017-05-05 14:26:48 +02:00
Maximilian Hils
75d952c46c
prominently link to examples in script docs
2017-04-27 18:23:36 +02:00
Maximilian Hils
07cb83597b
clarify that --cert expects a leaf certificate
...
refs #2254
2017-04-26 11:18:27 +02:00
Aldo Cortesi
e6eeab6094
Revamp how addons work
...
- Addons now nest, which means that addons can manage addons. This has a number
of salutary effects - the scripts addon no longer has to poke into the global
addons list, we no longer have to replace/remove/boot-outof parent addons when
we load scripts, and this paves the way for making our top-level tools into
addons themselves.
- All addon calls are now wrapped in a safe execution environment where
exceptions are caught, and output to stdout/stderr are intercepted and turned
into logs.
- We no longer support script arguments in sys.argv - creating an option
properly is the only way to pass arguments. This means that all scripts are
always directly controllable from interctive tooling, and that arguments are
type-checked.
For now, I've disabled testing of the har dump example - it needs to be moved
to the new argument handling, and become a class addon. I'll address that in a
separate patch.
2017-04-25 22:13:44 +12:00
jonathanrfisher1
677b9186ae
Replace phrase "an TLS" with "a TLS"
...
Updating usage of 'a' or 'an' to be more consistent with general English grammatical rules. TLS is pronounced with a consonant sound for both the expanded and abbreviated versions.
2017-03-29 14:12:33 -04:00
Maximilian Hils
74f2a28e41
minor fixes
2017-03-11 14:46:33 +01:00
Ujjwal Verma
e0382fde2f
Changed docs
2017-03-11 11:14:22 +05:30
Maximilian Hils
44c3c3ed86
Merge pull request #2124 from mitmproxy/opensuse-docs
...
Add install docs for openSUSE
2017-03-08 20:06:35 +01:00
Thomas Kriechbaumer
69f7ad21fe
Merge pull request #2090 from mitmproxy/fix-pathod-header-doc
...
pathoc: fix documentation for headers
2017-03-08 18:21:56 +01:00
Maximilian Hils
ca819fb923
add install docs for openSUSE
2017-03-08 17:42:19 +01:00
Maximilian Hils
bda39335b0
fix other occurences of options shortcut
2017-03-07 12:16:23 +01:00
Yamamori Akihiro
7ca2913c1a
Update tcpproxy.rst
...
Correction in key short cut for TCP Proxy
2017-03-07 14:15:29 +09:00
Maximilian Hils
50ebdf3081
update docs wording
2017-03-04 11:42:30 +01:00
Nikhil Soni
0081d9b828
Merge branch 'master' into on-issues
2017-03-03 12:58:44 +05:30
Nikhil Soni
2e90373e4b
Updates help msg and docs for --keep-host-header
2017-03-03 12:34:20 +05:30
Maximilian Hils
f1417dd859
pathoc: fix documentation for headers
2017-03-02 19:24:48 +01:00
Maximilian Hils
bae4cdf8d5
docs: fix cert install link
2017-03-02 19:10:11 +01:00
Maximilian Hils
b6eda9ed0a
docs: http -> https where possible
2017-03-02 19:09:14 +01:00
Thomas Taschauer
fc9b152d06
link to stackoverflow for chrome certificate management
2017-03-02 14:31:41 +01:00
Thomas Kriechbaumer
80113a9d6e
remove zlib1g dependency from install instructions
2017-02-15 14:08:36 +01:00
Thomas Kriechbaumer
8a6f8bd461
nuke Pillow
2017-02-15 00:54:14 +01:00
Jihyun Yu
4adc575bad
Add transparent proxy support for OpenBSD
...
Add transparent proxy support for OpenBSD with pf divert-to.
2017-02-11 14:05:22 +09:00
Maximilian Hils
1523068b03
Merge pull request #1964 from mhils/new-contribution-docs
...
New contribution docs
2017-01-31 09:02:00 +01:00
Markus Unterwaditzer
980b8aedd3
Update shim path ( #1968 )
2017-01-30 20:07:37 +01:00
Maximilian Hils
edb96f69f5
add contributing section that redirects to README
2017-01-29 22:10:37 +01:00
Maximilian Hils
e10fb22f9c
remove outdated testing section from docs
2017-01-29 22:09:45 +01:00
Maximilian Hils
0919e38514
remove outdated architecture section from docs
2017-01-29 22:08:57 +01:00
Eric Hanchrow
ccb8889342
fix link to macOS and Linux binaries
2017-01-23 20:42:03 +01:00
Thomas Kriechbaumer
0022c810e5
replace iOS install instructions for CAs
...
fixes #1898
2017-01-20 22:04:35 +01:00
Thomas Kriechbaumer
72b753c60f
provide git information with --version
...
fixes #1848
2017-01-19 20:27:29 +01:00
tripleee
9cedfa7ddd
reSt verbatim formatting error
...
The rendered code snippets would be rewrapped as if it were prose, which wreaks havoc with the code.
2017-01-13 14:26:04 +02:00
Maximilian Hils
5d0f7e5c41
clarify windows install docs
2017-01-10 11:01:51 +01:00
Rodrigo Senra
d013f7ec8f
Added note about server-side replay for sessions recorded in reverse-proxy mode
2017-01-07 19:58:30 -05:00
Maximilian Hils
4b1224e592
add mitmweb explanation to introduction
2016-12-26 18:33:58 +01:00
Aldo Cortesi
5167d59d63
Merge branch 'master' into admin
2016-12-24 11:20:12 +13:00
Thomas Kriechbaumer
42e9448ade
reflow docs
2016-12-21 22:27:51 +01:00
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
