From 58fc0041fa5e37a891314da4a777f8b886d20f06 Mon Sep 17 00:00:00 2001 From: Aldo Cortesi Date: Sat, 19 Feb 2011 19:43:44 +1300 Subject: Stub out doc structure, add screenshots for configuring certs in Firefox. --- doc-src/02-docstyle.css | 58 ++++++++++---------------------- doc-src/_layout.html | 22 +++++++++--- doc-src/index.html | 22 +++++++++++- doc-src/index.py | 24 +++++++------ doc-src/intro.html | 2 ++ doc-src/mitmdump/index.py | 5 +++ doc-src/mitmdump/tutorial.html | 0 doc-src/mitmproxy/index.py | 5 +++ doc-src/mitmproxy/tutorial.html | 0 doc-src/screenshots/firefox3-import.jpg | Bin 0 -> 79780 bytes doc-src/screenshots/firefox3-trust.jpg | Bin 0 -> 46279 bytes doc-src/screenshots/firefox3.jpg | Bin 0 -> 81573 bytes doc-src/ssl.html | 41 ++++++++++++++++++++++ 13 files changed, 121 insertions(+), 58 deletions(-) create mode 100644 doc-src/intro.html create mode 100644 doc-src/mitmdump/index.py create mode 100644 doc-src/mitmdump/tutorial.html create mode 100644 doc-src/mitmproxy/index.py create mode 100644 doc-src/mitmproxy/tutorial.html create mode 100644 doc-src/screenshots/firefox3-import.jpg create mode 100644 doc-src/screenshots/firefox3-trust.jpg create mode 100644 doc-src/screenshots/firefox3.jpg create mode 100644 doc-src/ssl.html (limited to 'doc-src') diff --git a/doc-src/02-docstyle.css b/doc-src/02-docstyle.css index dd61d2e8..b1a90727 100644 --- a/doc-src/02-docstyle.css +++ b/doc-src/02-docstyle.css @@ -2,7 +2,7 @@ body { -x-system-font:none; font-family: Helvetica,Arial,Tahoma,Verdana,Sans-Serif; color: #555555; - font-size: 1.1em; + font-size: 1.2em; } a { @@ -15,7 +15,7 @@ a { } #hd h1 { letter-spacing: 3px; - font-size: 2.5em; + font-size: 2em; line-height: 100%; margin: 0.3em 0; font-weight: normal; @@ -46,56 +46,32 @@ a { letter-spacing: 0.5px; } -.pageindex { - font-size: 1.5em; +.faq .question { + font-size: 1.1em; + font-weight: bold; } -.pageindex ul { - list-style-image:none; - list-style-position:outside; - list-style-type:none; - margin: 0px; +pre { + padding: 10px; + background-color: #e0e0e0; + margin: 10px; } -.pageindex li { - list-style-image:none; - list-style-position:outside; - list-style-type:none; - margin: 0; +ul { + margin-top: 0.1em; + margin-bottom: 0; + margin-left: 2em; } -.pageindex li.active { - padding-left: 4px; - border-left: 5px solid #ff0000; +li a { + text-decoration: none; } -.pageindex li.inactive{ - border-left: none; - margin-left: 9px; -} +#nav { + float: right; -.pageindex li li a { - display: block; - background-color: transparent; - margin: 0; - border-top: none; - border-bottom: none; -} -.pageindex ul ul { - margin-left: 20px; - padding: 0; - list-style-type: none; } -.faq .question { - font-size: 1.1em; - font-weight: bold; -} -pre { - padding: 10px; - background-color: #e0e0e0; - margin: 10px; -} diff --git a/doc-src/_layout.html b/doc-src/_layout.html index 2e706ecd..11d456a0 100644 --- a/doc-src/_layout.html +++ b/doc-src/_layout.html @@ -1,14 +1,26 @@ -
+
- $!head!$ + + + + $!title!$ +
$!body!$
-
-
@!sidebar!@
-

@!copyright!@

diff --git a/doc-src/index.html b/doc-src/index.html index 859ffad0..71e82087 100644 --- a/doc-src/index.html +++ b/doc-src/index.html @@ -1,3 +1,23 @@ -@!index_contents!@ + +* [Introduction](@!urlTo("intro.html")!@) +* [mitmproxy](@!urlTo("mitmproxy.html")!@) - Console-based HTTP Swiss Army Knife. + * [Tutorial](@!urlTo("mitmproxy/tutorial.html")!@) +* [mitmdump](@!urlTo("mitmdump.html")!@) - tcpdump for HTTP conversations + * [Tutorial](@!urlTo("mitmproxy/tutorial.html")!@) +* [Client scripts](@!urlTo("scripts.html")!@) - Writing client scripts for mitmproxy and mitmdump +* [libmproxy](@!urlTo("library.html")!@) - Using the mitmproxy library +* [SSL](@!urlTo("ssl.html")!@) - Installing mitmproxy's SSL certificate + * Browsers: + * [Firefox](@!urlTo("ssl.html")!@#firefox) + * [Chrome](@!urlTo("ssl.html")!@#chrome) + * [Safari](@!urlTo("ssl.html")!@#safari) + * [IE8](@!urlTo("ssl.html")!@#ie) + * Global installation: + * [Windows 7](@!urlTo("ssl.html")!@#windows7) + * [iPhone/iPad](@!urlTo("ssl.html")!@#ios) +* [FAQ](@!urlTo("faq.html")!@) +* [administrivia](@!urlTo("admin.html")!@) + + diff --git a/doc-src/index.py b/doc-src/index.py index c34fcb78..c0546ab1 100644 --- a/doc-src/index.py +++ b/doc-src/index.py @@ -8,12 +8,10 @@ ns.docTitle = "mitmproxy" this.markup = markup.Markdown() ns.docMaintainer = "Aldo Cortesi" ns.docMaintainerEmail = "aldo@corte.si" -ns.copyright = "Aldo Cortesi 2010" -ns.head = countershape.template.Template(None, "

@!docTitle!@ - @!this.title!@

") -ns.sidebar = countershape.widgets.SiblingPageIndex( - '/index.html', - exclude=['countershape'] - ) +ns.copyright = u"\u00a9 mitmproxy project, 2011" +ns.title = countershape.template.Template(None, "

@!docTitle!@ - @!this.title!@

") + +ns.index = countershape.widgets.SiblingPageIndex('/index.html', divclass="pageindex") ns.license = file("../LICENSE").read() ns.index_contents = file("../README.mkd").read() @@ -30,11 +28,15 @@ ns.example = example pages = [ - Page("index.html", "introduction"), + Page("index.html", "Index"), + Page("intro.html", "Introduction"), Page("mitmproxy.html", "mitmproxy"), + Directory("mitmproxy"), Page("mitmdump.html", "mitmdump"), - Page("scripts.html", "scripts"), - Page("library.html", "libmproxy"), - Page("faq.html", "faq"), - Page("admin.html", "administrivia") + Directory("mitmdump"), + Page("scripts.html", "External scripts"), + Page("library.html", "libmproxy: mitmproxy as a library"), + Page("ssl.html", "SSL"), + Page("faq.html", "FAQ"), + Page("admin.html", "Administrivia") ] diff --git a/doc-src/intro.html b/doc-src/intro.html new file mode 100644 index 00000000..c48206c8 --- /dev/null +++ b/doc-src/intro.html @@ -0,0 +1,2 @@ + +@!index_contents!@ diff --git a/doc-src/mitmdump/index.py b/doc-src/mitmdump/index.py new file mode 100644 index 00000000..312ece1d --- /dev/null +++ b/doc-src/mitmdump/index.py @@ -0,0 +1,5 @@ +from countershape import Page, Directory, PythonModule, markup + +pages = [ + Page("tutorial.html", "Tutorial"), +] diff --git a/doc-src/mitmdump/tutorial.html b/doc-src/mitmdump/tutorial.html new file mode 100644 index 00000000..e69de29b diff --git a/doc-src/mitmproxy/index.py b/doc-src/mitmproxy/index.py new file mode 100644 index 00000000..312ece1d --- /dev/null +++ b/doc-src/mitmproxy/index.py @@ -0,0 +1,5 @@ +from countershape import Page, Directory, PythonModule, markup + +pages = [ + Page("tutorial.html", "Tutorial"), +] diff --git a/doc-src/mitmproxy/tutorial.html b/doc-src/mitmproxy/tutorial.html new file mode 100644 index 00000000..e69de29b diff --git a/doc-src/screenshots/firefox3-import.jpg b/doc-src/screenshots/firefox3-import.jpg new file mode 100644 index 00000000..2ccfc490 Binary files /dev/null and b/doc-src/screenshots/firefox3-import.jpg differ diff --git a/doc-src/screenshots/firefox3-trust.jpg b/doc-src/screenshots/firefox3-trust.jpg new file mode 100644 index 00000000..ec780dc3 Binary files /dev/null and b/doc-src/screenshots/firefox3-trust.jpg differ diff --git a/doc-src/screenshots/firefox3.jpg b/doc-src/screenshots/firefox3.jpg new file mode 100644 index 00000000..439fb9ad Binary files /dev/null and b/doc-src/screenshots/firefox3.jpg differ diff --git a/doc-src/ssl.html b/doc-src/ssl.html new file mode 100644 index 00000000..4fe1ee15 --- /dev/null +++ b/doc-src/ssl.html @@ -0,0 +1,41 @@ + +# Browsers + + +## Firefox 3.x + +### 1: Open preferences, click on "Advanced", then select"Encryption": + + + +### 2: Click "View Certificates", "Import", and select the certificate file: + + + +### 3: Tick "Trust this CS to identify web sites", and click "Ok": + + + +You should now see the mitmproxy certificate listed in the Authorities tab. + + + +## Chrome + + +## Safari + + +## Internet Explorer 8 + + +# Global installation + + +## Windows 7 + + +## iPhone/iPad + + + -- cgit v1.2.3