Commit Graph

358 Commits

Author SHA1 Message Date
Maximilian Hils
76f0b8f65e fix tests 2021-06-15 10:45:26 +02:00
Alexander Prinzhorn
231c8eefe3
Update README.md (#4620)
* Document Cookie header folding issues

* plural: *exists*, me: 😮

* link list

* Update README.md

* fair well modd

* minor wording fix

Co-authored-by: Maximilian Hils <git@maximilianhils.com>
2021-06-04 09:14:11 +00:00
Zoltán Reegn
01c18c109b
docs: requirements for custom mitmproxy-ca.pem (#4601)
* docs: requirements for custom mitmproxy-ca.pem

* docs: fix typos
2021-05-24 12:19:45 +02:00
Maximilian Hils
373609336a mode docs: add invocation examples 2021-05-14 11:03:33 +02:00
Zoltán Reegn
3c4e47dd8c
Merge pull request #4599 from reegnz/patch-1
Add certificate CLI Installation method for MacOS
2021-05-14 08:39:02 +02:00
Maximilian Hils
7df0be34b0 docs++ 2021-05-11 18:05:40 +02:00
Maximilian Hils
518fb94124
Harden CI Pipeline (#4590)
* ci: use actions/checkout@v2

* ci: always specify python version

* ci: pin external actions

* ci: split docs job, pin immediate dependencies

* ci: correct hugo sha256sum

* ci: full repo fetch depth for tests

* ci: use pip-tools to pin all the things

* ci: minor fixes

* ci: fixup

* ci: streamline pinned install

* ci: minor fixes

* ci: fix py3.8 pins

* ci: don't persist checkout credentials

* ci: always run local linter

* ci: test docs deployment from actions-hardening branch

* ci: fix docs job

* ci: pass in credentials

* ci: fix file permissions

* ci: try harder to fix docs deploy

* ci: fix docker artifact name

* Revert "ci: test docs deployment from actions-hardening branch"

This reverts commit 30cfb7a814b61a8926fc0623e3e70b6dd5106d90.

* unpin PyPI dependencies

* ci: install tox first

* ci: fixups

* ci: fixups

* ci: fixups

* ci: fixups
2021-05-11 11:17:09 +02:00
Maximilian Hils
07915421a9
Update overview-installation.md 2021-04-25 22:11:53 +02:00
Maximilian Hils
e7fd050523
Merge pull request #4560 from jannst/update_contribution_readme
docs: add more precise instructions on docs setup
2021-04-21 12:06:26 +02:00
Jannik
d568881a4d
docs: update tutorial for Android CA (#4561) 2021-04-21 12:02:47 +02:00
Maximilian Hils
f1a925642f
do not copy hugo's install instructions
that only creates maintenance burden
2021-04-21 12:00:57 +02:00
Jannik
20655fd4e2 docs: add more precise instructions on docs setup 2021-04-11 17:39:47 +02:00
aesyondu
438567f58c
docs(docs-readme): clarify documentation readme (#4538)
* docs(docs-readme): clarify documentation readme

I was confused what `mitmproxy Python package` meant. At first I did `pipx install mitmproxy`, but that didn't work. Then I realized I needed it as a library/module, not cli.

Changed `build.sh` to `build.py` since it was deleted on commit a7d1f32c89

* Update README.md

Co-authored-by: Maximilian Hils <github@maximilianhils.com>
2021-04-06 15:40:13 +02:00
Peter Dave Hello
b9f9094ec7
docker: clean up tmux dir in clirecording Dockerfile (#4542) 2021-04-05 10:08:57 +02:00
Maximilian Hils
ead33008bc master branch -> main branch 2021-03-30 15:30:45 +02:00
Maximilian Hils
9baaf9dfdb
minor cleanups (#4530) 2021-03-29 17:42:24 +02:00
HereC
de3f089bb0
Add block_list Option to set HTTP status for blocked flows/urls (#4516)
* Add block_list Option which returns a set HTTP status for a blocked flow filter:URL

* Add changelog entry

* Add blocklist to default AddOns

* Add Nginx 444 status code to list, so it is available for validation

* Add overview of blocklists

* Add allow-only, and more tests

* Fix mypy tox issue

* Finish test coverage with test for invalid filter

* Add PR feedback

* Fix type/scope error

* Fix stray blank line

* Delete concepts-blocklist.md

* Feature in overview

* Add flag to metadata for blocklisted flows.

* minor improvements

Co-authored-by: Maximilian Hils <git@maximilianhils.com>
2021-03-29 15:30:21 +00:00
Peter Dave Hello
123342ea0b
Improve Markdown syntax(styling) (#4496)
* Improve Markdown syntax

- Add missing blank lines
- Remove trailing spaces
- Remove additional blank lines
- Fix indentation consistency and correctness

* Update addons-examples.md

Co-authored-by: Maximilian Hils <github@maximilianhils.com>
2021-03-11 19:13:02 +01:00
Peter Dave Hello
aede8849db
Improve Shell Script syntax (#4497) 2021-03-11 19:12:03 +01:00
Maximilian Hils
b8f79ed624
fix #4473 (#4490) 2021-03-10 19:54:54 +00:00
Peter Dave Hello
c3ae2d98db
Refactor docs clirecording Dockerfile (#4484)
* Delete apt-get lists after apt-get install in docs Dockerfile

* Prevent pip install cache in docs Dockerfile

* Prevent additional & unnecessary apt packages in docs Dockerfile
2021-03-08 17:18:39 +01:00
Peter Dave Hello
d0e4a82de8 Speed up git clone in docs Dockerfile 2021-03-03 15:56:23 +08:00
Maximilian Hils
b5d9dcdeee fix docs CI 2021-02-13 12:29:52 +01:00
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