aboutsummaryrefslogtreecommitdiffstats
path: root/doc-src
diff options
context:
space:
mode:
Diffstat (limited to 'doc-src')
-rw-r--r--doc-src/02-docstyle.css58
-rw-r--r--doc-src/_layout.html22
-rw-r--r--doc-src/index.html22
-rw-r--r--doc-src/index.py24
-rw-r--r--doc-src/intro.html2
-rw-r--r--doc-src/mitmdump/index.py5
-rw-r--r--doc-src/mitmdump/tutorial.html0
-rw-r--r--doc-src/mitmproxy/index.py5
-rw-r--r--doc-src/mitmproxy/tutorial.html0
-rw-r--r--doc-src/screenshots/firefox3-import.jpgbin0 -> 79780 bytes
-rw-r--r--doc-src/screenshots/firefox3-trust.jpgbin0 -> 46279 bytes
-rw-r--r--doc-src/screenshots/firefox3.jpgbin0 -> 81573 bytes
-rw-r--r--doc-src/ssl.html41
13 files changed, 121 insertions, 58 deletions
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 @@
-<div class="yui-t2" id="doc3">
+<div id="doc3">
<div style="" id="hd">
- $!head!$
+
+ <div id="nav">
+ <!--(block pb)-->
+ <a href="@!urlTo(previous)!@">prev</a>
+ <!--(end)-->
+ <!--(block nb)-->
+ <a href="@!urlTo(next)!@">next</a>
+ <!--(end)-->
+
+ $!pb if previous else "prev"!$ |
+ <a href="@!urlTo('index.html')!@">index</a> |
+ $!nb if next else "next"!$
+ </div>
+
+ $!title!$
+
</div>
<div id="bd">
<div id="yui-main">
<div style="" class="yui-b">$!body!$</div>
</div>
- <div style="" class="yui-b">
- <div>@!sidebar!@</div>
- </div>
</div>
<div style="" id="ft">
<p>@!copyright!@</p>
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, "<h1> @!docTitle!@ - @!this.title!@ </h1>")
-ns.sidebar = countershape.widgets.SiblingPageIndex(
- '/index.html',
- exclude=['countershape']
- )
+ns.copyright = u"\u00a9 mitmproxy project, 2011"
+ns.title = countershape.template.Template(None, "<h1> @!docTitle!@ - @!this.title!@ </h1>")
+
+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
--- /dev/null
+++ b/doc-src/mitmdump/tutorial.html
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
--- /dev/null
+++ b/doc-src/mitmproxy/tutorial.html
diff --git a/doc-src/screenshots/firefox3-import.jpg b/doc-src/screenshots/firefox3-import.jpg
new file mode 100644
index 00000000..2ccfc490
--- /dev/null
+++ b/doc-src/screenshots/firefox3-import.jpg
Binary files differ
diff --git a/doc-src/screenshots/firefox3-trust.jpg b/doc-src/screenshots/firefox3-trust.jpg
new file mode 100644
index 00000000..ec780dc3
--- /dev/null
+++ b/doc-src/screenshots/firefox3-trust.jpg
Binary files differ
diff --git a/doc-src/screenshots/firefox3.jpg b/doc-src/screenshots/firefox3.jpg
new file mode 100644
index 00000000..439fb9ad
--- /dev/null
+++ b/doc-src/screenshots/firefox3.jpg
Binary files 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
+
+<a name="firefox"></a>
+## Firefox 3.x
+
+### 1: Open preferences, click on "Advanced", then select"Encryption":
+
+<img src="@!urlTo('firefox3.jpg')!@"/>
+
+### 2: Click "View Certificates", "Import", and select the certificate file:
+
+<img src="@!urlTo('firefox3-import.jpg')!@"/>
+
+### 3: Tick "Trust this CS to identify web sites", and click "Ok":
+
+<img src="@!urlTo('firefox3-trust.jpg')!@"/>
+
+You should now see the mitmproxy certificate listed in the Authorities tab.
+
+
+<a name="chrome"></a>
+## Chrome
+
+<a name="safari"></a>
+## Safari
+
+<a name="ie"></a>
+## Internet Explorer 8
+
+
+# Global installation
+
+<a name="windows"></a>
+## Windows 7
+
+<a name="ios"></a>
+## iPhone/iPad
+
+
+