aboutsummaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
...
* | Merge pull request #2914 from kira0204/docs-2913Aldo Cortesi2018-02-251-4/+4
|\| | | | | Updating docs
| * Fixing #2913kira02042018-02-241-4/+4
| |
* | Spelling corrected for think*Monami Sharma2018-02-241-1/+1
|/ | | Replaced "You should thin* of the mitmproxy" to "You should think* of the mitmproxy"
* All new documentationAldo Cortesi2018-02-22168-3959/+12464
| | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* Merge pull request #2841 from aniketpanjwani/fix_linux_transparent_proxy_docsMaximilian Hils2018-02-131-1/+3
|\ | | | | Modify Linux transparent proxy docs to include ipv6 configuration.
| * docs: don't set accept_redirects.Maximilian Hils2018-02-131-2/+0
| | | | | | | | | | | | 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
| * Modify Linux transparent proxy docs to include ipv6 configuration.Aniket Panjwani2018-02-041-0/+4
| |
* | Fix a typo in events.rstEdward Medvedev2018-02-111-4/+4
| | | | | | This PR fixes a tiny typo in the documentation.
* | Updates the pfctl configGokul2018-02-091-2/+1
|/ | | The previous config threw a syntax error when saving.
* docs: minor improvementsMaximilian Hils2018-01-011-1/+1
|
* websocket: docs++ and kill messagesThomas Kriechbaumer2017-12-272-2/+14
| | | | fixes #2724
* cleanup transparent linux docsThomas Kriechbaumer2017-12-211-26/+8
|
* Update linux.rstJim Higson2017-12-211-2/+22
|
* minor docs improvementsMaximilian Hils2017-12-181-6/+3
| | | | 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.
* move extra info for ios to ios sectionjimhigson2017-12-181-5/+8
|
* docs++: add websocket PING/PONGThomas Kriechbaumer2017-12-121-0/+5
|
* docs++: add individual protocol pagesThomas Kriechbaumer2017-12-127-7/+63
|
* docs-certinstall: Certificate pinning update link rst0git2017-10-191-1/+1
| | | Certificate pinning (HTTP Public Key Pinning) is better described on Wikipedia
* docs-install: Fix typorst0git2017-10-181-1/+1
|
* update installation docsThomas Kriechbaumer2017-09-041-82/+75
|
* docs: simplify install instructionsMaximilian Hils2017-08-151-5/+5
| | | | | We only need pip3 now on all OSes as cryptography now ships wheels on Linux :tada:. Also remove `pip3 install --user` recommendation because that won't end up on $PATH.
* docs: Fix typoPaulo Romeira2017-07-291-3/+3
|
* minor docs improvementsMaximilian Hils2017-07-041-12/+11
|
* update streaming docsUjjwal Verma2017-07-045-72/+107
|
* Note to enable `Certificate Trust Settings` in iOS 10.3 or up (#2312)Zhigang Fang2017-05-051-0/+3
|
* prominently link to examples in script docsMaximilian Hils2017-04-271-0/+6
|
* clarify that `--cert` expects a leaf certificateMaximilian Hils2017-04-261-1/+1
| | | refs #2254
* Revamp how addons workAldo Cortesi2017-04-252-20/+4
| | | | | | | | | | | | | | | | | | | - 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.
* Replace phrase "an TLS" with "a TLS"jonathanrfisher12017-03-291-4/+4
| | | 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.
* minor fixesMaximilian Hils2017-03-111-4/+3
|
* Changed docsUjjwal Verma2017-03-111-4/+4
|
* Merge pull request #2124 from mitmproxy/opensuse-docsMaximilian Hils2017-03-081-0/+14
|\ | | | | Add install docs for openSUSE
| * add install docs for openSUSEMaximilian Hils2017-03-081-0/+14
| |
* | Merge pull request #2090 from mitmproxy/fix-pathod-header-docThomas Kriechbaumer2017-03-081-2/+2
|\ \ | |/ |/| pathoc: fix documentation for headers
| * pathoc: fix documentation for headersMaximilian Hils2017-03-021-2/+2
| |
* | fix other occurences of options shortcutMaximilian Hils2017-03-078-10/+10
| |
* | Update tcpproxy.rstYamamori Akihiro2017-03-071-1/+1
| | | | | | Correction in key short cut for TCP Proxy
* | update docs wordingMaximilian Hils2017-03-041-2/+2
| |
* | Merge branch 'master' into on-issuesNikhil Soni2017-03-031-6/+6
|\|
| * docs: fix cert install linkMaximilian Hils2017-03-021-1/+1
| |
| * docs: http -> https where possibleMaximilian Hils2017-03-021-6/+6
| |
| * link to stackoverflow for chrome certificate managementThomas Taschauer2017-03-021-1/+1
| |
* | Updates help msg and docs for --keep-host-headerNikhil Soni2017-03-031-2/+3
|/
* remove zlib1g dependency from install instructionsThomas Kriechbaumer2017-02-151-2/+2
|
* nuke PillowThomas Kriechbaumer2017-02-151-2/+2
|
* Add transparent proxy support for OpenBSDJihyun Yu2017-02-113-1/+55
| | | | Add transparent proxy support for OpenBSD with pf divert-to.
* Merge pull request #1964 from mhils/new-contribution-docsMaximilian Hils2017-01-318-66/+15
|\ | | | | New contribution docs
| * add contributing section that redirects to READMEMaximilian Hils2017-01-293-3/+15
| |
| * remove outdated testing section from docsMaximilian Hils2017-01-292-48/+0
| |
| * remove outdated architecture section from docsMaximilian Hils2017-01-295-15/+0
| |