aboutsummaryrefslogtreecommitdiffstats
path: root/docs/install.rst
Commit message (Collapse)AuthorAgeFilesLines
* All new documentationAldo Cortesi2018-02-221-159/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* 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.
* Revamp how addons workAldo Cortesi2017-04-251-3/+3
| | | | | | | | | | | | | | | | | | | - 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.
* add install docs for openSUSEMaximilian Hils2017-03-081-0/+14
|
* remove zlib1g dependency from install instructionsThomas Kriechbaumer2017-02-151-2/+2
|
* nuke PillowThomas Kriechbaumer2017-02-151-2/+2
|
* add contributing section that redirects to READMEMaximilian Hils2017-01-291-2/+2
|
* fix link to macOS and Linux binariesEric Hanchrow2017-01-231-2/+3
|
* provide git information with --versionThomas Kriechbaumer2017-01-191-1/+1
| | | | fixes #1848
* clarify windows install docsMaximilian Hils2017-01-101-3/+3
|
* reflow docsThomas Kriechbaumer2016-12-211-21/+39
|
* update installation pageMaximilian Hils2016-12-201-60/+69
| | | | | We emphasize the binary installation because that is usually the simplest method to install mitmproxy on all major platforms.
* fix install.rstMaximilian Hils2016-12-111-0/+4
|
* docs: update installationThomas Kriechbaumer2016-12-111-49/+37
|
* First-order conversion to Python3-onlyAldo Cortesi2016-10-171-3/+3
| | | | | | - 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.
* Update install.rstMaximilian Hils2016-08-021-1/+1
|
* Merge pull request #1285 from westurner/patch-1Maximilian Hils2016-06-231-2/+18
|\ | | | | DOC: install.rst: Installation on Fedora, Ubuntu
| * DOC: install.rst: Installation on Fedora, UbuntuWes Turner2016-06-211-2/+18
| |
* | Show how to upgrade pip.BSalita2016-06-221-1/+3
|/ | | Windows install failed due to out of date pip. Show how to upgrade to latest pip.
* docs: minor fixesMaximilian Hils2016-04-301-1/+1
|
* Add installation instructions for Arch Linux (#1079)Felix Yan2016-04-111-0/+11
|
* Docs and examples to top levelAldo Cortesi2016-02-181-0/+103
|
* move mitmproxyMaximilian Hils2016-02-151-103/+0
|
* remove compatible version specifiersMaximilian Hils2016-02-051-0/+3
|
* Ubuntu install missing libjpeg8-dev, zlib1g-devNick Badger2015-10-221-1/+1
| | | As per https://pillow.readthedocs.org/en/3.0.0/installation.html#linux-installation, to avoid missing install dependencies.
* Update ubuntu installation to includ libjpegNick Badger2015-10-221-1/+1
| | | Otherwise install fails with error "--enable-jpeg requested but jpeg not found"
* improve readmeMaximilian Hils2015-09-161-1/+1
|
* docs: minor fixesMaximilian Hils2015-09-071-1/+1
|
* rewrite basic docs for readthedocsMaximilian Hils2015-09-041-0/+100