Commit Graph

385 Commits

Author SHA1 Message Date
Maximilian Hils
d2c9efc98f CI: fail when docs fail to build 2021-02-13 12:26:44 +01:00
Maximilian Hils
805aed4f6a docs++ 2021-02-13 00:13:37 +01:00
Maximilian Hils
0ab59e5524 docs++ 2021-02-05 22:04:45 +01:00
Maximilian Hils
51193f1d20 api docs++ 2021-02-05 09:15:54 +01:00
Maximilian Hils
a7d1f32c89 docs: first prototype to link from events to API reference 2021-02-05 09:15:54 +01:00
Maximilian Hils
09beb1aa13 docs: add api reference using pdoc 2021-02-05 09:15:54 +01:00
zivillian
a793a6256a
fix --certs argument (#4412)
the help output claims that --certs is correct
2021-01-24 22:12:16 +01:00
Thomas Kriechbaumer
9e09b58e78
Merge pull request #4399 from mhils/no-dev-scripts
Make development setup instructions more clear
2021-01-24 11:50:49 +01:00
Maximilian Hils
ea624ae6e3
clean doc folder before building, fixes #4405 (#4406) 2021-01-22 01:40:08 +01:00
Maximilian Hils
05a43572c8 make development setup instructions more clear
Our dev.sh/dev.ps1 scripts feel like an unnecessary layer of abstraction.
The revised docs make the install process transparent to experienced users,
and can also be easily reused for other projects (hi, pdoc!).
2021-01-18 13:56:27 +01:00
Maximilian Hils
81f8f06a11 converge on hooks, events, and commands 2021-01-05 22:00:54 +01:00
Maximilian Hils
6c0e4f1cb7 streamline event/hook/command naming conventions 2021-01-05 21:54:44 +01:00
Maximilian Hils
90df4168f8 coverage++ 2021-01-05 21:54:44 +01:00
Maximilian Hils
667cacba3f generate event documentation from source 2021-01-05 21:54:44 +01:00
Maximilian Hils
ca45548289
Merge pull request #4384 from mhils/mitmproxy.exe
mitmproxy.exe 🎉🥳
2021-01-05 08:18:11 +01:00
Maximilian Hils
605961c57f build mitmproxy.exe 🎉 2021-01-05 07:46:53 +01:00
Maximilian Hils
7941e09016 docs: update protocols section 2021-01-01 22:45:05 +01:00
Maximilian Hils
32c73a8d61 split README.rst into README.md and CONTRIBUTING.md 2020-12-13 18:50:43 +01:00
Thomas Kriechbaumer
ff16fbf71e fix docs ci script running locally 2020-11-08 13:17:38 +01:00
Blake Burkhart
21330f511e is_http10 and is_http11 properties to requests 2020-10-13 09:21:15 -05:00
Blake Burkhart
b17857c7ae Send http/1 request and response trailer headers 2020-10-08 20:43:28 -05:00
Thomas Kriechbaumer
0f96324887 docs: update cert usage instructions 2020-10-07 19:08:34 +02:00
Thomas Kriechbaumer
da6b3b415e
Merge pull request #4186 from simon04/patch-1
Update concepts-certificates.md
2020-10-07 18:40:07 +02:00
Alexander Prinzhorn
8ebfc2cb8f
Update concepts-protocols.md
There is support for HTTP/2 trailers since 5.2
2020-09-26 15:49:26 +02:00
Maximilian Hils
5e4bf9ba88 [docs] minor docs improvements 2020-09-07 19:49:41 +02:00
Martin Plattner
b34eec4f7b fix page id and web-ui tests 2020-09-07 18:09:02 +02:00
Martin Plattner
1c087a47dd reorder tools in docs 2020-09-07 16:36:41 +02:00
Martin Plattner
ed918cca87 fix linting error 2020-09-04 18:51:02 +02:00
Martin Plattner
bc47d69df9 add cli recordings and instructions 2020-09-04 18:47:32 +02:00
Martin Plattner
88d43b51bb tweak cli recordings 2020-09-04 18:45:54 +02:00
Martin Plattner
a8b2cc9df6 restructure docs 2020-09-04 16:48:53 +02:00
Martin Plattner
a465d92215 minor content improvements 2020-09-04 15:38:25 +02:00
Martin Plattner
d305c973f5 merge CliDirector and MitmCliDirector 2020-09-04 15:22:04 +02:00
Martin Plattner
129c03e51a integrate feedback 2020-09-04 15:02:58 +02:00
Martin Plattner
2f434f91ff add recorded casts and instructions 2020-09-03 17:56:08 +02:00
Martin Plattner
cf9b001ccb add tutorials to docs 2020-09-03 17:47:52 +02:00
Martin Plattner
b6d52fc8ab add cli recording scripts 2020-09-03 17:44:00 +02:00
Simon Legner
0ac7833032
Update concepts-certificates.md
Add `keytool -importcert` for Java
2020-08-29 14:52:10 +02:00
Maximilian Hils
901a8dd7d4 docs: add favicon 2020-08-27 15:18:03 +02:00
Maximilian Hils
968f9bf05f disable google analytics for docs 2020-08-27 15:07:53 +02:00
Martin Plattner
6e210f1445 fix docs for Map* addons 2020-07-23 19:27:32 +02:00
Maximilian Hils
366014d0a3
Merge pull request #4069 from mplattner/maplocal-addon
MapLocal addon
2020-07-18 14:24:45 +02:00
Martin Plattner
0c8a46253b map local: align ascii figures in docs 2020-07-17 17:54:46 +02:00
Maximilian Hils
f36dcd8915
revise map local docs
provide a short summary at the start (with easy-to-copy examples) and then discuss the nitty-gritty details below.
2020-07-14 15:55:31 +02:00
Martin Plattner
d6293004e0 map local: update docs 2020-07-10 20:51:18 +02:00
sidahmed-malaoui
ef13270ff2
Command that can generates errors in the documentation
In the title _Work-around to redirect traffic originating from the machine itself_, add the flag `-H` to `sudo` command to avoid errors on certain Linux based OS.
2020-07-10 12:43:37 +01:00
Martin Plattner
8942ae88d5 maplocal addon: update docs 2020-07-08 23:53:44 +02:00
Maximilian Hils
96ce21687e blacklist -> blocklist 2020-07-04 12:09:51 +02:00
Maximilian Hils
c60c3dbb75 docs: consistently use backticks for highlighting 2020-07-04 11:29:53 +02:00
Tedd Johnson
c3d3b75517
Update concepts-certificates.md
{{< highlight bash  >}} doesn't render properly on the wiki, so converted to codeblock
2020-07-04 01:14:21 -07:00
Martin Plattner
cee4da4e8c fix docs and url encoding 2020-07-03 16:31:41 +02:00
Maximilian Hils
417c213dd7
minor docs improvements 2020-07-03 15:29:17 +02:00
Martin Plattner
89fad1e2b1 add mapremote addon to modify request URLs 2020-07-03 14:27:37 +02:00
Martin Plattner
fe662b4282 improve modify addons docs
fixes #3945
2020-07-02 13:49:20 +02:00
Martin Plattner
2a408c9379 refactor modify addons
Use a universal ModifySpec class to represent rules.
ModifyHeaders now supports reading the header value from a  file.
2020-07-01 13:25:28 +02:00
Martin Plattner
2ed7770716 modify body addon: fix typo in docs 2020-06-30 16:54:17 +02:00
Martin Plattner
48dcc6e073 revert modify headers parameter order 2020-06-30 14:57:46 +02:00
Martin Plattner
4cffbec291 modifybody addon: update docs 2020-06-26 20:38:57 +02:00
Maximilian Hils
846889c6f9
Merge pull request #4043 from mplattner/addon-setheaders-improve
SetHeaders -> ModifyHeaders
2020-06-25 18:33:39 +02:00
Martin Plattner
781e0a2e7c rename SetHeaders addon to ModifyHeaders 2020-06-25 18:08:48 +02:00
Martin Plattner
527e5fcd22 fix docs generation 2020-06-25 17:02:12 +02:00
Martin Plattner
b90dded940 setheaders addon: update docs 2020-06-25 16:53:45 +02:00
Maximilian Hils
ed68e0a1ba
Merge pull request #4040 from mhils/restructure-examples
Restructure examples
2020-06-23 20:21:48 +02:00
Maximilian Hils
08895e9ba6 restructure examples
- restructure examples (fix #4031)
 - remove example dependencies from setup.py,
   we do not need special dependencies for our supported addons.
 - unify how we generate docs from code
 - improve example docs
2020-06-23 16:00:14 +02:00
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