Revert "Move the doc tree out into its own repo."

This reverts commit 8f88fcedd601c0033b4469b66626a83011879baf.

11 files changed, 170 insertions, 0 deletions

diff --git a/doc-src/certinstall/android-settingssecurityinstallca.png b/doc-src/certinstall/android-settingssecurityinstallca.png
new file mode 100644
index 00000000..f0f97273
--- /dev/null
+++ b/doc-src/certinstall/android-settingssecurityinstallca.png
diff --git a/doc-src/certinstall/android-settingssecuritymenu.png b/doc-src/certinstall/android-settingssecuritymenu.png
new file mode 100644
index 00000000..fea412fe
--- /dev/null
+++ b/doc-src/certinstall/android-settingssecuritymenu.png
diff --git a/doc-src/certinstall/android-settingssecurityuserinstalledca.png b/doc-src/certinstall/android-settingssecurityuserinstalledca.png
new file mode 100644
index 00000000..1f7717ad
--- /dev/null
+++ b/doc-src/certinstall/android-settingssecurityuserinstalledca.png
diff --git a/doc-src/certinstall/android-shellwgetmitmproxyca.png b/doc-src/certinstall/android-shellwgetmitmproxyca.png
new file mode 100644
index 00000000..4a4e326f
--- /dev/null
+++ b/doc-src/certinstall/android-shellwgetmitmproxyca.png
diff --git a/doc-src/certinstall/android.html b/doc-src/certinstall/android.html
new file mode 100644
index 00000000..9b0c5d71
--- /dev/null
+++ b/doc-src/certinstall/android.html
@@ -0,0 +1,45 @@
+The proxy situation on Android is [an
+embarrasment](http://code.google.com/p/android/issues/detail?id=1273).  It's
+scarcely credible, but Android didn't have a global proxy setting at all until
+quite recently, and it's still not supported on many common Android versions.
+In the meantime the app ecosystem has grown used to life without this basic
+necessity, and many apps merrily ignore it even if it's there. This situation
+is improving, but in many circumstances using [transparent
+mode](@!urlTo("transparent.html")!@) is mandatory for testing Android apps.
+
+We used an Asus Transformer Prime TF201 with Android 4.0.3 in the examples
+below - your device may differ, but the broad process should be similar. 
+
+
+## Getting the certificate onto the device
+
+First we need to get the __mitmproxy-ca-cert.cer__ file into the
+__/sdcard__ folder on the device (/sdcard/Download on older devices). There are a number of ways to do
+this. If you have the Android Developer Tools installed, you can use [__adb
+push__](http://developer.android.com/tools/help/adb.html) to accomplish this.
+Depending on your device, you could also transfer the file using external media
+like an SD Card. In this example, we're using wget from within a terminal
+emulator to transfer the certificate from a local HTTP server: 
+
+<img src="android-shellwgetmitmproxyca.png"/>
+
+
+## Installing the certificate
+
+Once we have the certificate on the local disk, we need to import it into the
+list of trusted CAs. Go to Settings -&gt; Security -&gt; Credential Storage,
+and select "Install from storage":
+
+<img src="android-settingssecuritymenu.png"/>
+
+The certificate in /sdcard is automatically located and offered for
+installation. Installing the cert will delete the download file from the local
+disk:
+
+<img src="android-settingssecurityinstallca.png"/>
+
+Afterwards, you should see the certificate listed in the Trusted Credentials
+store:
+
+<img src="android-settingssecurityuserinstalledca.png"/>
+
diff --git a/doc-src/certinstall/firefox.html b/doc-src/certinstall/firefox.html
new file mode 100644
index 00000000..66fa9d79
--- /dev/null
+++ b/doc-src/certinstall/firefox.html
@@ -0,0 +1,23 @@
+
+How to install the __mitmproxy__ certificate authority in Firefox:
+
+<ol class="tlist">
+    <li> If needed, copy the ~/.mitmproxy/mitmproxy-ca-cert.pem file to the target. </li>
+
+    <li>Open preferences, click on "Advanced", then select"Encryption":
+        <img src="@!urlTo('firefox3.jpg')!@"/>
+    </li>
+
+    <li> Click "View Certificates", "Import", and select the certificate file: 
+        <img src="@!urlTo('firefox3-import.jpg')!@"/>
+    </li>
+
+    <li>Tick "Trust this CS to identify web sites", and click "Ok":
+        <img src="@!urlTo('firefox3-trust.jpg')!@"/>
+    </li>
+
+    <li> You should now see the mitmproxy certificate listed in the Authorities
+    tab.</li>
+
+</ol>
+
diff --git a/doc-src/certinstall/index.py b/doc-src/certinstall/index.py
new file mode 100644
index 00000000..3f145fbc
--- /dev/null
+++ b/doc-src/certinstall/index.py
@@ -0,0 +1,10 @@
+from countershape import Page
+
+pages = [
+    Page("firefox.html", "Firefox"),
+    Page("osx.html", "OSX"),
+    Page("windows7.html", "Windows 7"),
+    Page("ios.html", "IOS"),
+    Page("ios-simulator.html", "IOS Simulator"),
+    Page("android.html", "Android"),
+]
diff --git a/doc-src/certinstall/ios-simulator.html b/doc-src/certinstall/ios-simulator.html
new file mode 100644
index 00000000..9eb98108
--- /dev/null
+++ b/doc-src/certinstall/ios-simulator.html
@@ -0,0 +1,23 @@
+
+How to install the __mitmproxy__ certificate authority in the IOS simulator:
+
+<ol class="tlist">
+
+    <li> First, check out the <a
+    href="https://github.com/ADVTOOLS/ADVTrustStore">ADVTrustStore</a> tool
+    from github.</li>
+
+    <li> Now, run the following command:
+
+    <pre class="terminal">./iosCertTrustManager.py -a ~/.mitmproxy/mitmproxy-ca-cert.pem</pre>
+
+    </li>
+
+</ol>
+
+
+Note that although the IOS simulator has its own certificate store, it shares
+the proxy settings of the host operating system. You will therefore to have
+configure your OSX host's proxy settings to use the mitmproxy instance you want
+to test with.
+
diff --git a/doc-src/certinstall/ios.html b/doc-src/certinstall/ios.html
new file mode 100644
index 00000000..fd14e65a
--- /dev/null
+++ b/doc-src/certinstall/ios.html
@@ -0,0 +1,21 @@
+
+How to install the __mitmproxy__ certificate authority on IOS devices:
+
+<ol class="tlist">
+    <li>Set up the Mail app on the device to receive email.</li>
+
+    <li>Mail the mitmproxy-ca-cert.pem file to the device, and tap on the attachment.</li>
+
+    <li>You will be prompted to install a profile. Click "Install":
+
+    <img src="@!urlTo('ios-profile.png')!@"/></li>
+
+    <li>Accept the warning by clicking "Install" again:
+
+    <img src="@!urlTo('ios-warning.png')!@"/></li>
+
+    <li>The certificate should now be trusted:
+
+    <img src="@!urlTo('ios-installed.png')!@"/></li>
+
+</ol>
diff --git a/doc-src/certinstall/osx.html b/doc-src/certinstall/osx.html
new file mode 100644
index 00000000..a532d538
--- /dev/null
+++ b/doc-src/certinstall/osx.html
@@ -0,0 +1,16 @@
+
+How to install the __mitmproxy__ certificate authority in OSX:
+
+<ol class="tlist">
+
+    <li>Open Finder, and double-click on the mitmproxy-ca-cert.pem file.</li>
+
+    <li>You will be prompted to add the certificate. Click "Always Trust": 
+
+        <img src="@!urlTo('osx-addcert-alwaystrust.png')!@"/>
+    </li>
+
+    <li> You may be prompted for your password. You should now see the
+    mitmproxy cert listed under "Certificates".</li>
+</ol>
+
diff --git a/doc-src/certinstall/windows7.html b/doc-src/certinstall/windows7.html
new file mode 100644
index 00000000..47c807c6
--- /dev/null
+++ b/doc-src/certinstall/windows7.html
@@ -0,0 +1,32 @@
+
+How to install the __mitmproxy__ certificate authority in Windows 7:
+
+<ol class="tlist">
+
+    <li> Copy the ~/.mitmproxy/mitmproxy-ca-cert.p12 file to the target system. </li>
+
+    <li> 
+        Double-click the certificate file. You should see a certificate import wizard: 
+
+        <img src="@!urlTo('win7-wizard.png')!@"/>
+    </li>
+
+    <li> 
+        Click "Next" until you're prompted for the certificate store:
+
+        <img src="@!urlTo('win7-certstore.png')!@"/>
+
+    </li>
+
+
+    <li> 
+        <p>Select "Place all certificates in the following store", and select "Trusted Root Certification Authorities":</p>
+
+        <img src="@!urlTo('win7-certstore-trustedroot.png')!@"/>
+
+    </li>
+
+    <li> Click "Next" and "Finish". </li>
+
+</ol>
+