Commit Graph

371 Commits

Author SHA1 Message Date
Vane11ope
f7cc067724
the link of wsproto was not displayed right
I just fixed the link attached to wsproto.
2020-06-22 02:42:31 +09:00
jasonruz
5599d3b654
Document default listen port is 8080 2020-06-16 14:41:52 +10:00
Matt Hamilton
4336720a32
add kubernetes howto 2020-05-23 00:26:06 -04:00
Maximilian Hils
67372d26ae simplify hugo config 2020-05-16 17:12:38 +02:00
Thung Han
41d1603f37 Fix #3975 by enabling inline HTML in Markdown docs 2020-05-16 17:11:39 +02:00
Maximilian Hils
30c904fe5f update hugo 2020-05-16 17:10:44 +02:00
Deepanshu Lulla
8d8f4fd752
enable flag pygmentsCodefences = true (#3977)
* enable flag

Co-authored-by: Maximilian Hils <github@maximilianhils.com>
2020-05-08 22:02:19 +02:00
Maximilian Hils
1348ef7de8
docs: fix typo 2020-04-30 11:56:42 +02:00
Maximilian Hils
433c588c4c
fix typo in certificates documentation 2020-04-28 11:30:39 +02:00
Maximilian Hils
e9d5b6d9f5
fix typo 2020-04-26 19:29:02 +02:00
Philipp Johann Fritz
6c10a4e0f6
Update howto-wireshark-tls.md
Wireshark renamed the protocol from SSL to TLS in settings
2020-04-23 17:44:46 +02:00
Thomas Kriechbaumer
39e2278e93 improve getting-started docs 2020-04-13 09:46:45 +02:00
Thomas Kriechbaumer
55527c00eb docs: rename docs scripts and improve template 2020-04-11 12:25:56 +02:00
Thomas Kriechbaumer
5ea75a1a81 examples: reformat to prevent too long lines 2020-04-11 11:12:18 +02:00
Thomas Kriechbaumer
12b37c39e1 docs: render all examples into one markdown page 2020-04-10 14:08:25 +02:00
Thomas Kriechbaumer
467234aa96
Merge pull request #3905 from sarthak212/docsdeprecated
docs update
2020-04-05 22:38:50 +02:00
root
e7839a4320 docs update 2020-04-06 00:20:33 +05:30
Thomas Kriechbaumer
678be7a052 improve scripting docs 2020-04-04 15:36:13 +02:00
Maximilian Hils
7d87154130
Merge pull request #3870 from naivekun/update_document
fix document error
2020-03-30 23:08:17 +02:00
root
b286d35653 c is deprecated 2020-03-31 00:43:22 +05:30
naivekun
fa222dca65 fix document error 2020-03-25 22:02:53 +08:00
Meet Mangukiya
c6393f86d7 Remove yarn/npm from docs
Closes https://github.com/mitmproxy/mitmproxy/issues/3716
2020-02-25 03:38:10 +05:30
2NuFyeat4PZt
6d71a8c0d9
Update concepts-filters.md
Provide a working example for the ~m filter
2020-02-07 13:41:47 +00:00
Massimo Prencipe
34ab180bad
Fix broken link with link to similar addon. This fixes issue #3775. 2020-01-19 23:08:57 +02:00
Maximilian Hils
184384af57
docs: document no websocket replay
this refs #3564
2020-01-03 13:47:09 +01:00
Maximilian Hils
13a7f18084
docs: update Windows cert import instructions
as per https://github.com/mitmproxy/mitmproxy/issues/3622#issuecomment-561968523
2020-01-03 13:17:25 +01:00
pasanr
e3c5505540
Minor typo of 'with' 2019-12-25 08:23:05 +05:30
Maximilian Hils
e48c91b0a4 update release instructions 2019-12-21 02:57:53 +01:00
Maximilian Hils
6ad7b575bb simplify install instructions 2019-11-20 18:45:36 +01:00
Maximilian Hils
e92b957e3a
Use Github Actions for CI (#3713)
switch to github actions for CI
2019-11-19 18:15:08 +01:00
Thomas Kriechbaumer
e7c3975bfc
Merge pull request #3669 from jannst/add_howto_install_android_system_ca
Add howto insert mitmproxy CA cert into the android system certificate store
2019-11-11 19:13:15 +01:00
Will
45e3ae0f9c grammer correction (#3670) 2019-10-15 19:59:42 +02:00
jannst
a4ff65e321 Adding tutorial on how to insert mitmproxy CA cert into the android system certificate store 2019-10-13 22:03:24 +02:00
Maximilian Hils
68a7d37d53
improve wording 2019-10-13 18:20:38 +02:00
jannst
f580e0ea97 hugo server -D fails if html file in docs/src/generated are not present 2019-10-13 17:48:23 +02:00
Nirusu
7ef91f46a3 Update howto-transparent-vms.md for newer versions (#3597)
Update howto-transparent-vms.md for newer versions
2019-09-30 11:41:49 +02:00
Thomas Kriechbaumer
f6405abda2
Merge pull request #3329 from Kriechi/readme-slogan
update readme slogan
2019-09-28 16:45:00 +02:00
Thomas Kriechbaumer
16bc62bd77
Merge pull request #3603 from tomsaleeba/patch-1
Transparent proxy on Linux for local originating traffic
2019-09-28 11:38:30 +02:00
Thomas Kriechbaumer
079374dec8
Merge pull request #3600 from king6cong/master
fix pf.conf on macOS
2019-09-28 11:33:32 +02:00
Adam Hopkins
6ba39ede08
Update concepts-certificates.md
Update to direct people to using Safari instead of another browser on iOS.
2019-09-24 14:59:26 +03:00
Tom Saleeba
f47608c85e
docs: correct command to install mitmproxy 2019-08-01 22:04:58 +09:30
Tom Saleeba
ba848e2040
docs: add instructions for transparent proxy on Linux for traffic originating from the mitmproxy host itself 2019-08-01 15:37:25 +09:30
king6cong
586f8d2044 fix pf.conf on macOS 2019-07-30 20:26:51 +08:00
Maximilian Hils
d64ec3072d
Merge pull request #3542 from ZHRhodes/patch-1
Typo in howto-wireshark-tls.md
2019-07-17 22:49:37 +02:00
Lucio Paiva
a4f8457dd3
Minor fix re. macOS steps 2019-06-26 18:39:23 +01:00
ZHRhodes
1410bdd9ca
Update howto-wireshark-tls.md
Fixed a typo in describing the master keys
2019-05-16 23:21:47 -07:00
Rob Wills
fad326a85f
Fix markdown typo on addons-scripting.md 2019-03-29 15:11:17 -07:00
Maximilian Hils
139a385900
Merge pull request #3441 from petersmythe/patch-1
Fix spelling issues
2019-01-23 13:08:51 +01:00
Jihyun Yu
c331ba91fc openbsd: divert-to requires exact listen address
divert-to does not work with '0.0.0.0' or similar listen address, so we
need to specify listen address that we provided to `pf`.
2019-01-18 15:59:58 +09:00
Peter Smythe
2223520403
Fix space 2019-01-03 08:48:09 +02:00
Peter Smythe
d6445fa5ba
Fix spelling 2019-01-03 07:54:57 +02:00
Maximilian Hils
08f2459cbd
docs: don't make links extra bold 2018-11-09 08:56:48 +01:00
Abhigyan Khaund
80f5cf5437 docs: Add mitm.it link in the certificates docs. 2018-11-05 02:15:48 +05:30
Tey
1752fac0d8
Fixed doc about domain whitelisting 2018-10-05 04:05:18 +02:00
Thomas Kriechbaumer
f95784ba9d update readme slogan 2018-09-21 10:38:25 +02:00
Aldo Cortesi
9829fe150e
Merge pull request #3186 from andersonvom/master
Add scripting example to intercept & change requests
2018-07-11 10:24:52 +12:00
bunnyhero
e5121ee977
Update howto-transparent.md
i got a syntax error on macOS high sierra with the existing example pf.conf line. based on sample pf rules i found online, i believe it was missing the `pass` keyword, which i added.

also, the surrounding text refers to "two lines," when there is only one, so i've updated that too.
2018-07-05 12:35:55 -04:00
Anderson Mesquita
ba02a0b8b9 Add example to intercept/change specific requests
This example captures requests to a specific URL and returns an
arbitrary response instead.  It's common enough that is useful to have
in the docs.

It also adds links to the Request and Response classes to help
developers writing scripts.
2018-06-16 09:16:38 +02:00
Anderson Mesquita
4fdc3d9e15 Rename scripting file
In order to add the more scripting examples, it makes sense to rename
this file and avoid confusion.
2018-06-08 08:04:53 +02:00
Maximilian Hils
0f981bff25 docs: fix minimum page height 2018-05-25 15:29:25 +02:00
Maximilian Hils
615d606da9
docs: minor improvements to Windows installation 2018-05-16 15:35:37 +02:00
Aldo Cortesi
dc2ac88871 docs: complete, informative documentation on our SOCKS5 mode 2018-05-16 10:15:54 +12:00
Aldo Cortesi
17dd7e2bd6 docs: installation, WSL 2018-05-16 10:07:03 +12:00
Aldo Cortesi
56010ebcb7 docs: clarify binary packaage admonition 2018-05-15 10:46:30 +12:00
Aldo Cortesi
2db223decb docs: console key binding docs and example 2018-05-15 10:34:55 +12:00
Aldo Cortesi
fe4c371001 docs: split out tool documentation 2018-05-15 10:07:09 +12:00
Aldo Cortesi
9830e5b597 cadir -> confdir
We store a lot more than just the CAs in our configuration directory. Clarify
the option name.
2018-05-10 11:40:33 +12:00
Thomas Kriechbaumer
44d788ff96
Merge pull request #2986 from miheerdew/patch-1
Workaround for MacOS transparent proxy
2018-05-06 12:24:24 +02:00
Simon Elvery
48ba4eb737
Fix typo in addons-overview.md 2018-05-05 20:24:49 +10:00
p1uymi
93a59acaeb
Changed syntax from v2 to v3
--client-certs = v2 syntax --> --set client_certs=value = v3 syntax
--cadir = v2 syntax --> --set cadir=value = v3 syntax
2018-04-26 16:14:27 +02:00
Maximilian Hils
660aa87a24
fix GA id 2018-04-11 16:58:09 -06:00
Aldo Cortesi
53827a36ae
Merge pull request #3025 from Kriechi/py36
Python 3.5 is dead -- long live Python 3.6!
2018-04-01 08:59:47 +12:00
ghillu
673b58c79f
Update addons-overview.md
Fixed a typo
2018-04-01 00:09:45 +05:30
Thomas Kriechbaumer
46f8901b8c Python 3.5 is dead -- long live Python 3.6!
fixes #2266
2018-03-31 18:46:32 +02:00
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