From f3767fb85bd357217604bb13d5b347b85b266ca2 Mon Sep 17 00:00:00 2001
From: thevickypedia <vignesh.sivanandarao@gmail.com>
Date: Wed, 25 Oct 2023 17:12:34 -0500
Subject: [PATCH] Update README.md and docs

---
 README.md                   |  42 ++++++++++++++++++++++++++++++------
 docs/README.html            |  33 +++++++++++++++++++++++-----
 docs/_sources/README.md.txt |  42 ++++++++++++++++++++++++++++++------
 docs/index.html             |  13 ++++++-----
 docs/objects.inv            | Bin 1116 -> 1124 bytes
 docs/searchindex.js         |   2 +-
 6 files changed, 109 insertions(+), 23 deletions(-)

diff --git a/README.md b/README.md
index 40f181f..d819ee4 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,22 @@
+![Python](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue)
+
+###### Platform Supported
+![Generic badge](https://img.shields.io/badge/Platform-MacOS|Windows-1f425f.svg)
+
+###### Repo Stats
+[![GitHub](https://img.shields.io/github/license/thevickypedia/expose)][LICENSE]
+[![GitHub repo size](https://img.shields.io/github/repo-size/thevickypedia/expose)][API_REPO]
+[![GitHub code size](https://img.shields.io/github/languages/code-size/thevickypedia/expose)][API_REPO]
+
+###### Deployments
+[![doc](https://github.com/thevickypedia/expose/actions/workflows/pages/pages-build-deployment/badge.svg)][gha_pages]
+[![pypi](https://github.com/thevickypedia/expose/actions/workflows/python-publish.yml/badge.svg)][gha_pypi]
+[![markdown](https://github.com/thevickypedia/expose/actions/workflows/markdown-validation.yml/badge.svg)][gha_markdown]
+
+[![Pypi-format](https://img.shields.io/pypi/format/expose-localhost)](https://pypi.org/project/expose-localhost/#files)
+[![Pypi-status](https://img.shields.io/pypi/status/expose-localhost)](https://pypi.org/project/expose-localhost)
+[![sourcerank](https://img.shields.io/librariesio/sourcerank/pypi/expose-localhost)](https://libraries.io/pypi/expose-localhost)
+
 # Expose localhost using EC2
 Reverse proxy that creates a secure tunnel from public endpoint to locally running web service
 
@@ -133,7 +152,7 @@ Styling conventions: [`PEP 8`](https://www.python.org/dev/peps/pep-0008/) <br>
 Clean code with pre-commit hooks: [`flake8`](https://flake8.pycqa.org/en/latest/) and 
 [`isort`](https://pycqa.github.io/isort/)
 
-## [Release Notes](https://github.com/thevickypedia/expose/blob/main/release_notes.rst)
+## [Release Notes][release-notes]
 **Requirement**
 ```shell
 python -m pip install gitverse
@@ -158,17 +177,28 @@ pre-commit run --all-files
 ```
 
 ### Pypi Package
-[![pypi-module](https://img.shields.io/badge/Software%20Repository-pypi-1f425f.svg)](https://packaging.python.org/tutorials/packaging-projects/)
+[![pypi-module](https://img.shields.io/badge/Software%20Repository-pypi-1f425f.svg)][pypi-read]
 
-[https://pypi.org/project/expose-localhost/](https://pypi.org/project/expose-localhost/)
+[https://pypi.org/project/expose-localhost/][pypi]
 
 ### Runbook
-[![made-with-sphinx-doc](https://img.shields.io/badge/Code%20Docs-Sphinx-1f425f.svg)](https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html)
+[![made-with-sphinx-doc](https://img.shields.io/badge/Code%20Docs-Sphinx-1f425f.svg)][sphinx-read]
 
-[https://thevickypedia.github.io/expose/](https://thevickypedia.github.io/expose/)
+[https://thevickypedia.github.io/expose/][docs]
 
 ## License & copyright
 
 &copy; Vignesh Rao
 
-Licensed under the [MIT License](https://github.com/thevickypedia/expose/blob/main/LICENSE)
+Licensed under the [MIT License][LICENSE]
+
+[LICENSE]: https://github.com/thevickypedia/expose/blob/main/LICENSE
+[API_REPO]: https://api.github.com/repos/thevickypedia/expose
+[pypi]: https://pypi.org/project/expose-localhost/
+[pypi-read]: https://packaging.python.org/tutorials/packaging-projects/
+[sphinx-read]: https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html
+[docs]: https://thevickypedia.github.io/expose/
+[release-notes]: https://github.com/thevickypedia/expose/blob/main/release_notes.rst
+[gha_pages]: https://github.com/thevickypedia/expose/actions/workflows/pages/pages-build-deployment
+[gha_pypi]: https://github.com/thevickypedia/expose/actions/workflows/python-publish.yml
+[gha_markdown]: https://github.com/thevickypedia/expose/actions/workflows/markdown-validation.yml
diff --git a/docs/README.html b/docs/README.html
index ad767bf..ff60de9 100644
--- a/docs/README.html
+++ b/docs/README.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Expose localhost using EC2 &#8212; Expose  documentation</title>
+    <title>Platform Supported &#8212; Expose  documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/classic.css" />
     
@@ -33,7 +33,7 @@ <h3>Navigation</h3>
           <a href="index.html" title="Expose - Expose a web service on localhost to public internet using AWS EC2"
              accesskey="P">previous</a> |</li>
         <li class="nav-item nav-item-0"><a href="index.html">Expose  documentation</a> &#187;</li>
-        <li class="nav-item nav-item-this"><a href="">Expose localhost using EC2</a></li> 
+        <li class="nav-item nav-item-this"><a href="">Platform Supported</a></li> 
       </ul>
     </div>  
 
@@ -42,7 +42,27 @@ <h3>Navigation</h3>
         <div class="bodywrapper">
           <div class="body" role="main">
             
-  <section id="expose-localhost-using-ec2">
+  <p><img alt="Python" src="https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue" /></p>
+<section id="platform-supported">
+<h1>Platform Supported<a class="headerlink" href="#platform-supported" title="Permalink to this heading">¶</a></h1>
+<p><img alt="Generic badge" src="https://img.shields.io/badge/Platform-MacOS%7CWindows-1f425f.svg" /></p>
+</section>
+<section id="repo-stats">
+<h1>Repo Stats<a class="headerlink" href="#repo-stats" title="Permalink to this heading">¶</a></h1>
+<p><a class="reference external" href="https://github.com/thevickypedia/expose/blob/main/LICENSE"><img alt="GitHub" src="https://img.shields.io/github/license/thevickypedia/expose" /></a>
+<a class="reference external" href="https://api.github.com/repos/thevickypedia/expose"><img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/thevickypedia/expose" /></a>
+<a class="reference external" href="https://api.github.com/repos/thevickypedia/expose"><img alt="GitHub code size" src="https://img.shields.io/github/languages/code-size/thevickypedia/expose" /></a></p>
+</section>
+<section id="deployments">
+<h1>Deployments<a class="headerlink" href="#deployments" title="Permalink to this heading">¶</a></h1>
+<p><a class="reference external" href="https://github.com/thevickypedia/expose/actions/workflows/pages/pages-build-deployment"><img alt="doc" src="https://github.com/thevickypedia/expose/actions/workflows/pages/pages-build-deployment/badge.svg" /></a>
+<a class="reference external" href="https://github.com/thevickypedia/expose/actions/workflows/python-publish.yml"><img alt="pypi" src="https://github.com/thevickypedia/expose/actions/workflows/python-publish.yml/badge.svg" /></a>
+<a class="reference external" href="https://github.com/thevickypedia/expose/actions/workflows/markdown-validation.yml"><img alt="markdown" src="https://github.com/thevickypedia/expose/actions/workflows/markdown-validation.yml/badge.svg" /></a></p>
+<p><a class="reference external" href="https://pypi.org/project/expose-localhost/#files"><img alt="Pypi-format" src="https://img.shields.io/pypi/format/expose-localhost" /></a>
+<a class="reference external" href="https://pypi.org/project/expose-localhost"><img alt="Pypi-status" src="https://img.shields.io/pypi/status/expose-localhost" /></a>
+<a class="reference external" href="https://libraries.io/pypi/expose-localhost"><img alt="sourcerank" src="https://img.shields.io/librariesio/sourcerank/pypi/expose-localhost" /></a></p>
+</section>
+<section id="expose-localhost-using-ec2">
 <h1>Expose localhost using EC2<a class="headerlink" href="#expose-localhost-using-ec2" title="Permalink to this heading">¶</a></h1>
 <p>Reverse proxy that creates a secure tunnel from public endpoint to locally running web service</p>
 <section id="setup">
@@ -208,7 +228,10 @@ <h2>License &amp; copyright<a class="headerlink" href="#license-copyright" title
   <div>
     <h3><a href="index.html">Table of Contents</a></h3>
     <ul>
-<li><a class="reference internal" href="#">Expose localhost using EC2</a><ul>
+<li><a class="reference internal" href="#">Platform Supported</a></li>
+<li><a class="reference internal" href="#repo-stats">Repo Stats</a></li>
+<li><a class="reference internal" href="#deployments">Deployments</a></li>
+<li><a class="reference internal" href="#expose-localhost-using-ec2">Expose localhost using EC2</a><ul>
 <li><a class="reference internal" href="#setup">Setup</a><ul>
 <li><a class="reference internal" href="#environment-variables">Environment Variables:</a></li>
 </ul>
@@ -270,7 +293,7 @@ <h3>Navigation</h3>
           <a href="index.html" title="Expose - Expose a web service on localhost to public internet using AWS EC2"
              >previous</a> |</li>
         <li class="nav-item nav-item-0"><a href="index.html">Expose  documentation</a> &#187;</li>
-        <li class="nav-item nav-item-this"><a href="">Expose localhost using EC2</a></li> 
+        <li class="nav-item nav-item-this"><a href="">Platform Supported</a></li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
diff --git a/docs/_sources/README.md.txt b/docs/_sources/README.md.txt
index 40f181f..d819ee4 100644
--- a/docs/_sources/README.md.txt
+++ b/docs/_sources/README.md.txt
@@ -1,3 +1,22 @@
+![Python](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue)
+
+###### Platform Supported
+![Generic badge](https://img.shields.io/badge/Platform-MacOS|Windows-1f425f.svg)
+
+###### Repo Stats
+[![GitHub](https://img.shields.io/github/license/thevickypedia/expose)][LICENSE]
+[![GitHub repo size](https://img.shields.io/github/repo-size/thevickypedia/expose)][API_REPO]
+[![GitHub code size](https://img.shields.io/github/languages/code-size/thevickypedia/expose)][API_REPO]
+
+###### Deployments
+[![doc](https://github.com/thevickypedia/expose/actions/workflows/pages/pages-build-deployment/badge.svg)][gha_pages]
+[![pypi](https://github.com/thevickypedia/expose/actions/workflows/python-publish.yml/badge.svg)][gha_pypi]
+[![markdown](https://github.com/thevickypedia/expose/actions/workflows/markdown-validation.yml/badge.svg)][gha_markdown]
+
+[![Pypi-format](https://img.shields.io/pypi/format/expose-localhost)](https://pypi.org/project/expose-localhost/#files)
+[![Pypi-status](https://img.shields.io/pypi/status/expose-localhost)](https://pypi.org/project/expose-localhost)
+[![sourcerank](https://img.shields.io/librariesio/sourcerank/pypi/expose-localhost)](https://libraries.io/pypi/expose-localhost)
+
 # Expose localhost using EC2
 Reverse proxy that creates a secure tunnel from public endpoint to locally running web service
 
@@ -133,7 +152,7 @@ Styling conventions: [`PEP 8`](https://www.python.org/dev/peps/pep-0008/) <br>
 Clean code with pre-commit hooks: [`flake8`](https://flake8.pycqa.org/en/latest/) and 
 [`isort`](https://pycqa.github.io/isort/)
 
-## [Release Notes](https://github.com/thevickypedia/expose/blob/main/release_notes.rst)
+## [Release Notes][release-notes]
 **Requirement**
 ```shell
 python -m pip install gitverse
@@ -158,17 +177,28 @@ pre-commit run --all-files
 ```
 
 ### Pypi Package
-[![pypi-module](https://img.shields.io/badge/Software%20Repository-pypi-1f425f.svg)](https://packaging.python.org/tutorials/packaging-projects/)
+[![pypi-module](https://img.shields.io/badge/Software%20Repository-pypi-1f425f.svg)][pypi-read]
 
-[https://pypi.org/project/expose-localhost/](https://pypi.org/project/expose-localhost/)
+[https://pypi.org/project/expose-localhost/][pypi]
 
 ### Runbook
-[![made-with-sphinx-doc](https://img.shields.io/badge/Code%20Docs-Sphinx-1f425f.svg)](https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html)
+[![made-with-sphinx-doc](https://img.shields.io/badge/Code%20Docs-Sphinx-1f425f.svg)][sphinx-read]
 
-[https://thevickypedia.github.io/expose/](https://thevickypedia.github.io/expose/)
+[https://thevickypedia.github.io/expose/][docs]
 
 ## License & copyright
 
 &copy; Vignesh Rao
 
-Licensed under the [MIT License](https://github.com/thevickypedia/expose/blob/main/LICENSE)
+Licensed under the [MIT License][LICENSE]
+
+[LICENSE]: https://github.com/thevickypedia/expose/blob/main/LICENSE
+[API_REPO]: https://api.github.com/repos/thevickypedia/expose
+[pypi]: https://pypi.org/project/expose-localhost/
+[pypi-read]: https://packaging.python.org/tutorials/packaging-projects/
+[sphinx-read]: https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html
+[docs]: https://thevickypedia.github.io/expose/
+[release-notes]: https://github.com/thevickypedia/expose/blob/main/release_notes.rst
+[gha_pages]: https://github.com/thevickypedia/expose/actions/workflows/pages/pages-build-deployment
+[gha_pypi]: https://github.com/thevickypedia/expose/actions/workflows/python-publish.yml
+[gha_markdown]: https://github.com/thevickypedia/expose/actions/workflows/markdown-validation.yml
diff --git a/docs/index.html b/docs/index.html
index 7a5e33f..9304762 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -18,7 +18,7 @@
     
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="Expose localhost using EC2" href="README.html" /> 
+    <link rel="next" title="Platform Supported" href="README.html" /> 
   </head><body>
     <div class="related" role="navigation" aria-label="related navigation">
       <h3>Navigation</h3>
@@ -30,7 +30,7 @@ <h3>Navigation</h3>
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
         <li class="right" >
-          <a href="README.html" title="Expose localhost using EC2"
+          <a href="README.html" title="Platform Supported"
              accesskey="N">next</a> |</li>
         <li class="nav-item nav-item-0"><a href="#">Expose  documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Expose - Expose a web service on localhost to public internet using AWS EC2</a></li> 
@@ -47,7 +47,10 @@ <h1>Expose - Expose a web service on localhost to public internet using AWS EC2<
 <div class="toctree-wrapper compound">
 <p class="caption" role="heading"><span class="caption-text">Read Me:</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="README.html">Expose localhost using EC2</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="README.html">Platform Supported</a></li>
+<li class="toctree-l1"><a class="reference internal" href="README.html#repo-stats">Repo Stats</a></li>
+<li class="toctree-l1"><a class="reference internal" href="README.html#deployments">Deployments</a></li>
+<li class="toctree-l1"><a class="reference internal" href="README.html#expose-localhost-using-ec2">Expose localhost using EC2</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="README.html#setup">Setup</a></li>
 <li class="toctree-l2"><a class="reference internal" href="README.html#usage">Usage</a></li>
 <li class="toctree-l2"><a class="reference internal" href="README.html#coding-standards">Coding Standards</a></li>
@@ -1023,7 +1026,7 @@ <h3><a href="#">Table of Contents</a></h3>
   <div>
     <h4>Next topic</h4>
     <p class="topless"><a href="README.html"
-                          title="next chapter">Expose localhost using EC2</a></p>
+                          title="next chapter">Platform Supported</a></p>
   </div>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
@@ -1056,7 +1059,7 @@ <h3>Navigation</h3>
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
         <li class="right" >
-          <a href="README.html" title="Expose localhost using EC2"
+          <a href="README.html" title="Platform Supported"
              >next</a> |</li>
         <li class="nav-item nav-item-0"><a href="#">Expose  documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Expose - Expose a web service on localhost to public internet using AWS EC2</a></li> 
diff --git a/docs/objects.inv b/docs/objects.inv
index daa2763224b25c7254d05a643bb6a0926341b2c7..94c166da0dd01723b8e6055e3d4c04fd4a904ca8 100644
GIT binary patch
delta 1020
zcmV<Y0|Wfr2;>Nmc7MT++cpq}@B0)2+N*^oMK8HIyKZ41PK;H890{5lOKc@l9g<#q
zpT0xMlI>=Tilk5LmH2-e4re$+!m-l^@|H`Lb*B%lE?ooJFPT&&9P`??%}>L##n0K|
z0WPESuTCjwyht?MnC#uP=Iy~bced6jUx67A4y8S@3bpI{Pk#fwD`#PZR(n}7guk6c
zXhB&MMQ{l0(1uD8xCI8{J(J2<t^~vp{(=+hxWqVhk^@U<Al`zrI?V!UC}^~h$#bc|
zvSB$RgojQrSq2KFk~UCc01tp<XLkx!T8_bAvpUp^7O<5nCa^VygQ3hm%0_ZL1?(dK
zQs(={nVK02aDV7GqrFqYO08ypJAa`lf(U|uvyVdz_oAFtpa6#;M#&pib5n<Y+EeTq
z5UiaH7$-4X-6u`H+^j!x12Z=Aw`BS9(|TEWF}D`w&RGZqd|qx=Df;d6m#1%!U)kfA
zr@L^r%RiDh1xt2G!BU-4uzR`XLP~WE`?xGttSC0=kbiH_pHd+GQ$_<Uo4c3aa8~N@
zI8~gGq?v^Iee^k~1KZ06V!ZJq>}Zjvk@$;YTnI46Hy7zFgo<`Drg#hKFlsZ9_Ss~^
z{6>2RuZx=d(#x!DK|7lU11jbX<7J8D`!rNdc>yJR)hcm<vgH+=+p7f1xffyf)Fm3^
z``z?)yMOMQ<0-lWMOzRiuDiyHEBVU%f}cc6x8=t+K84jc%u?-jBFODZJsxjEF$GvF
zRb@i==~0*SR<aU01QESL6Kg!P-ht#0>Cnu|xFDW5#K2RhrLsvF(o+XZJ?jCIIAdZ)
z=lDcYl~l*`sgnM*Emx&UA{si`)H<+=!BIfxSAW|CA5JdPeEGe22BRGcSRv|u$*0%z
zO~{{I*GP(E7-_Mf&)TlruIVpsp#08Jk&A+0LuJ`h%;<;{=Z!jF`~QBwpl0Rye<S*9
z1)uh^oZ6Oo&E-61hcqqWuRO}TvyEx*hP*ERF~F-`lf7I*WbWa%(NzT)92!)(=p_By
zuYb|PzN@2YknI}DqY!i?pD5mgz5zQsaISu+n!&~oGTN+0^{gDYQRR&0T{eL8*ZWrQ
z4`Tggpq=iOV=(9xyQ(J?(seBA+=BFXO3@6fyVx21sig{E{JcY&|GboWUM-(CtIXK)
zL#ai!c$W=N`VrZ-;dZaF%?j7~<`Bw<3UySE=p_x`(X2=`J{@Fh|MTH8>`cBIvFgpv
z7UK_|y}&N>=1VFnWN4!WZ~QSNv(){$9hIG|UsOfu<cyye6}4>j`2K<B{)R=}X)(SS
qKDimvVX*D$?f=NOCt5Fct2V$<)VIRn*`O(g_gmV`9{vH%ofuY3{s(vf

delta 1012
zcmV<Q0}K4*2;2yec7IK8+c*%0@A(x1cCQw;UF@YdH*psR>Nbd4^hnUuSmLfkszb`L
z^6NX)m+fs96-l4sNO~U*hva+^PK`E@)?BKj>E6{kZ!1XtNTkZ)l$N%xejA>xeot0+
zaQ-^|(kca&6N!o&lf1dqy#8^@TU%<BFTf0l7NzZ2fx2z_p?`ti<%=*vtAi{U!uM7p
z)S#>hBD4tXSo=y5xCI8{EtASvt^|Y;{)LV;Tw<6y%7Hml5N^S!j<Y}-+B90o=(!YN
z*|3}e!eb+t%squtN$V*wfJZ>Gv*~=5mZSG*R{MI<0@hN6Y-~;2!O+P*$x3qUJfg^d
zl<A>rP00*xaDV87(V<nsO05=;oj%hpf&hYm(Z@c9J5kCCP=LcGM#(Eya#Q*a?I?Bx
zcxz_^rb#ST_lG83@3!x`fdzs5HCej;xLs#X%&kSaZ!LHNKCO3~82#hZ=ZCNNU)cTU
zhnsL7*MCQGG8XNUjKw-7W4Ch4nH1|7_I{mhSeEVLA%9<=KE^=$r;I+ZY-udN;%wCM
ze$F^Phh`S0x6!Adj_e>S2=T_xu#-g|N8-<haUsAMS6sxi5DJQ9Oz|4xVN_-y#o1`X
zT%f&y*G0))>Sb2epj#UU14`x<<9Uwc`#4ld=K^x}qE+MsWz7p1%c}^=Sc@>*HIW9n
zdN+REE`O`$aEfj~Q3%4wb=O#MC0}@-@S{law)|Yi$FTZ>S*nAM1hxBIPwlNQCIf4w
zDvWQOo^&a%CCi~f5Wy=nv!<T)2Ba2|nr4=VZQ_|j4D1>$m5suXo+?<XS&tCKnGR;~
z8J|h2km@vcmGq~sxynrx(NJeoYR@bNCjpIHZGYq4oSdcU`djt{Mz<(ngQ)u@pI<LG
zA$@3@O42@ti53d_r0uqDs{Y~z@^2g!xyTDPWR?T%86D7ZUa8Zq`|raUwdkDxKcc@@
zaK~QebJ?=2xLn3;kftTvl}CPawlVe1keA6n1b7iO+4FgeENyNpT@--cTZ0l8b<%(R
z8GkJ7t2&wn*{+d13SKSwOmQA`1=#4orTQUjdK*8;C|FJEMQ7kjl`@)lUI8v&?`yql
z#QMuXJKrmZV6au}BA?KfE<;gc3DVyw1v9K}LTB`kmdbze(*|k&%Z|*`X8o|+B*y0N
zaxIe8n`C&>f01l@dQxe@E7ubwt#QQ7{cYR30#uLcr4`@P>_|L49pqd0^X~lFIKssj
z;{dDa2Tz`1pSWpAN-kvZd1y;jV7sUElk|(LV6ujiTW=Bh;1!FSZZ*9ahTILuVzBMv
i?Js1H9j%+XRvX|b%4^~9Y|v!G`$r0DcRv6Gyc(!RC<9jj

diff --git a/docs/searchindex.js b/docs/searchindex.js
index 8b46b5a..50b4428 100644
--- a/docs/searchindex.js
+++ b/docs/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["README", "index"], "filenames": ["README.md", "index.rst"], "titles": ["Expose localhost using EC2", "Expose - Expose a web service on localhost to public internet using AWS EC2"], "terms": {"revers": [0, 1], "proxi": [0, 1], "creat": [0, 1], "secur": [0, 1], "from": [0, 1], "public": 0, "endpoint": 0, "local": [0, 1], "run": [0, 1], "web": 0, "servic": 0, "can": [0, 1], "load": [0, 1], "ani": [0, 1], "env": [0, 1], "file": [0, 1], "port": [0, 1], "number": [0, 1], "ha": [0, 1], "which": [0, 1], "app": [0, 1], "api": [0, 1], "i": [0, 1], "option": [0, 1], "open": 0, "_": 0, "boolean": [0, 1], "flag": [0, 1], "enabl": 0, "ingress": [0, 1], "egress": [0, 1], "specifi": [0, 1], "default": [0, 1], "fals": [0, 1], "channel": [0, 1], "timeout": [0, 1], "second": 0, "wait": 0, "an": [0, 1], "incom": 0, "connect": [0, 1], "100": 0, "imag": [0, 1], "id": [0, 1], "ami": [0, 1], "ubuntu": [0, 1], "o": 0, "region": 0, "specif": [0, 1], "instanc": [0, 1], "type": [0, 1], "t2": 0, "nano": 0, "aw": 0, "access": [0, 1], "kei": [0, 1], "resourc": [0, 1], "config": [0, 1], "secret": 0, "name": [0, 1], "where": 0, "should": [0, 1], "live": 0, "u": [0, 1], "west": 0, "2": [0, 1], "pair": [0, 1], "expose_localhost": 0, "group": [0, 1], "allow": [0, 1], "server": 0, "info": 0, "json": [0, 1], "store": [0, 1], "configur": 0, "server_info": [0, 1], "email": 0, "address": [0, 1], "self": [0, 1], "sign": [0, 1], "ssl": [0, 1], "privat": [0, 1], "user": 0, "com": [0, 1], "organ": [0, 1], "certif": 0, "host": [0, 1], "zone": [0, 1], "regist": [0, 1], "route53": 0, "exampl": [0, 1], "mywebsit": 0, "subdomain": [0, 1], "sub": 0, "domain": 0, "ad": [0, 1], "latenc": [0, 1], "channel_timeout": [0, 1], "adjust": 0, "improv": [0, 1], "depend": 0, "applic": 0, "": [0, 1], "role": 0, "network": 0, "shorter": 0, "make": [0, 1], "your": [0, 1], "more": [0, 1], "respons": [0, 1], "mai": 0, "also": 0, "lead": 0, "neg": 0, "high": 0, "If": [0, 1], "take": [0, 1], "longer": 0, "establish": 0, "due": 0, "condit": 0, "short": 0, "might": 0, "reject": 0, "valid": [0, 1], "prematur": 0, "rate": 0, "expect": 0, "you": [0, 1], "want": 0, "process": 0, "them": 0, "quickli": 0, "benefici": 0, "howev": 0, "mean": 0, "need": 0, "abl": 0, "rapidli": 0, "higher": 0, "repeat": 0, "check": 0, "consum": 0, "cpu": 0, "ensur": 0, "capac": 0, "handl": [0, 1], "frequent": 0, "ar": 0, "set": [0, 1], "too": 0, "low": 0, "custom": [0, 1], "The": [0, 1], "dn": [0, 1], "long": [0, 1], "messi": 0, "To": 0, "avoid": 0, "A": [0, 1], "record": [0, 1], "warn": [0, 1], "requir": [0, 1], "activ": 0, "bulb": 0, "hosted_zon": [0, 1], "internet": 0, "chain": 0, "pem": [0, 1], "format": 0, "current": 0, "work": [0, 1], "directori": 0, "key_fil": [0, 1], "cert_fil": [0, 1], "var": 0, "No": 0, "cert": [0, 1], "problem": 0, "gener": [0, 1], "automat": [0, 1], "some": 0, "browser": 0, "throw": 0, "even": 0, "block": [0, 1], "ca": [0, 1], "manual": [0, 1], "openssl": [0, 1], "req": 0, "newkei": 0, "rsa": [0, 1], "2048": [0, 1], "sha256": 0, "node": 0, "keyout": 0, "x509": [0, 1], "dai": 0, "365": 0, "out": 0, "subj": 0, "c": 0, "st": 0, "new": [0, 1], "york": [0, 1], "l": 0, "brooklyn": 0, "compani": 0, "cn": 0, "verifi": 0, "inform": [0, 1], "noout": [0, 1], "text": [0, 1], "python3": 0, "m": 0, "pip": 0, "import": 0, "env_fil": [0, 1], "instanti": [0, 1], "object": [0, 1], "start": [0, 1], "purg": [0, 1], "true": 0, "reclaim": 0, "fail": [0, 1], "stop": [0, 1], "delet": [0, 1], "all": [0, 1], "acquir": [0, 1], "troubleshoot": 0, "e": 0, "could": 0, "get": [0, 1], "lock": [0, 1], "lib": 0, "dpkg": 0, "frontend": 0, "occur": 0, "dure": [0, 1], "startup": [0, 1], "simpli": 0, "rerun": 0, "script": 0, "command": [0, 1], "thi": [0, 1], "when": [0, 1], "apt": 0, "hasn": 0, "t": [0, 1], "yet": 0, "retri": 0, "logic": 0, "place": 0, "issu": [0, 1], "persist": 0, "re": [0, 1], "entir": 0, "limit": 0, "cannot": [0, 1], "multipl": [0, 1], "without": 0, "modifi": [0, 1], "follow": 0, "key_pair": [0, 1], "ssh": [0, 1], "filenam": [0, 1], "dump": [0, 1], "data": [0, 1], "security_group": [0, 1], "firewal": 0, "rule": 0, "control": 0, "traffic": [0, 1], "via": [0, 1], "vpc": [0, 1], "docstr": 0, "googl": 0, "style": 0, "convent": 0, "pep": 0, "8": 0, "clean": 0, "pre": [0, 1], "commit": 0, "hook": 0, "flake8": 0, "isort": 0, "python": 0, "gitvers": 0, "f": 0, "release_not": 0, "rst": 0, "precommit": 0, "doc": [0, 1], "creation": [0, 1], "everi": 0, "sphinx": 0, "5": 0, "1": 0, "recommonmark": 0, "http": [0, 1], "org": 0, "project": 0, "thevickypedia": 0, "github": 0, "io": [0, 1], "vignesh": 0, "rao": 0, "under": 0, "mit": 0, "setup": 1, "usag": 1, "code": 1, "standard": 1, "releas": 1, "note": 1, "lint": 1, "licens": 1, "copyright": 1, "class": 1, "tunnel": 1, "none": 1, "initi": 1, "spin": 1, "up": 1, "act": 1, "paramet": 1, "bring": 1, "own": 1, "init": 1, "bool": 1, "function": 1, "its": 1, "shutdown": 1, "create_key_pair": 1, "keypair": 1, "openssh": 1, "return": 1, "call": 1, "wa": 1, "get_vpc_id": 1, "str": 1, "fetch": 1, "union": 1, "authorize_security_group": 1, "security_group_id": 1, "public_ip": 1, "author": 1, "certain": 1, "securitygroup": 1, "argument": 1, "ip": 1, "22": 1, "onli": 1, "machin": 1, "cidr": 1, "notat": 1, "32": 1, "80": 1, "443": 1, "apart": 1, "abov": 1, "sg": 1, "request": 1, "forward": 1, "whether": 1, "successfulli": 1, "create_security_group": 1, "case": 1, "exist": 1, "same": 1, "alreadi": 1, "create_ec2_inst": 1, "tupl": 1, "success": 1, "delete_key_pair": 1, "disassociate_security_group": 1, "instance_id": 1, "disassoci": 1, "assign": 1, "unavail": 1, "delete_security_group": 1, "terminate_ec2_inst": 1, "serviceresourc": 1, "termin": 1, "nginx": 1, "refer": 1, "amazon": 1, "cli": 1, "latest": 1, "describ": 1, "statu": 1, "html": 1, "boto3": 1, "amazonaw": 1, "v1": 1, "document": 1, "wait_until_termin": 1, "server_copi": 1, "sourc": 1, "destin": 1, "write": 1, "within": 1, "get_config": 1, "download": 1, "string": 1, "config_requir": 1, "common_nam": 1, "custom_serv": 1, "san_list": 1, "list": 1, "dict": 1, "tri": 1, "dictionari": 1, "entri": 1, "subject": 1, "altern": 1, "configure_vm": 1, "public_dn": 1, "dispos": 1, "disabl": 1, "remov": 1, "doesn": 1, "neither": 1, "nor": 1, "hand": 1, "model": 1, "write_screen": 1, "screen": 1, "clear": 1, "later": 1, "written": 1, "flush_screen": 1, "flush": 1, "output": 1, "empti": 1, "size": 1, "ran": 1, "one": 1, "_get_seri": 1, "byte": 1, "serial": 1, "here": 1, "just": 1, "measur": 1, "insert": 1, "uniqu": 1, "identifi": 1, "encod": 1, "_generate_serial_hash": 1, "byte_s": 1, "int": 1, "18": 1, "int_siz": 1, "36": 1, "hash": 1, "contain": 1, "random": 1, "base": 1, "generate_cert": 1, "country_nam": 1, "locality_nam": 1, "springfield": 1, "state_or_province_nam": 1, "missouri": 1, "organization_unit_nam": 1, "technologi": 1, "key_siz": 1, "origin": 1, "countri": 1, "citi": 1, "state": 1, "provinc": 1, "unit": 1, "san": 1, "look": 1, "amibas": 1, "pydant": 1, "basemodel": 1, "valu": 1, "pars": 1, "input": 1, "keyword": 1, "rais": 1, "validationerror": 1, "pydantic_cor": 1, "form": 1, "__init__": 1, "__pydantic_self__": 1, "instead": 1, "common": 1, "first": 1, "arg": 1, "field": 1, "_base_url": 1, "modelprivateattr": 1, "marketplac": 1, "productid": 1, "_base_ssm": 1, "prod": 1, "path": 1, "product_pag": 1, "url": 1, "alia": 1, "product_cod": 1, "s_product_pag": 1, "s_name": 1, "s_alia": 1, "s_product_cod": 1, "model_post_init": 1, "__context": 1, "meant": 1, "behav": 1, "like": 1, "method": 1, "initialis": 1, "attribut": 1, "It": 1, "context": 1, "sinc": 1, "what": 1, "core": 1, "pass": 1, "envconfig": 1, "pydantic_set": 1, "baseset": 1, "dev": 1, "3": 1, "migrat": 1, "nullabl": 1, "open_port": 1, "image_id": 1, "instance_typ": 1, "aws_region_nam": 1, "aws_access_kei": 1, "aws_secret_kei": 1, "email_address": 1, "emailstr": 1, "extra": 1, "wrapper": 1, "interact": 1, "current_dir": 1, "ssh_home": 1, "key_pair_fil": 1, "ami_deprec": 1, "entrypoint": 1, "nginx_config_command": 1, "notimplementedwarn": 1, "implement": 1, "duplicateresourc": 1, "error": 1, "duplic": 1, "awsresourceerror": 1, "status_cod": 1, "error_msg": 1, "image_factori": 1, "deprecation_warn": 1, "deprecation_tim": 1, "deprec": 1, "chosen": 1, "nearing": 1, "deprecationtim": 1, "session": 1, "retriev": 1, "get_ami_id_ssm": 1, "get_ami_id_product_cod": 1, "product": 1, "get_ami_id_nam": 1, "get_image_id": 1, "sequenti": 1, "execut": 1, "sequenc": 1, "fastest": 1, "ssm": 1, "point": 1, "singl": 1, "possibli": 1, "lookup": 1, "mani": 1, "so": 1, "grab": 1, "most": 1, "recent": 1, "unabl": 1, "log": 1, "share": 1, "across": 1, "route_53": 1, "get_zone_id": 1, "client": 1, "miss": 1, "change_record_set": 1, "zone_id": 1, "action": 1, "chang": 1, "hostnam": 1, "perform": 1, "upsert": 1, "changeset": 1, "join": 1, "separ": 1, "squash": 1, "print_warn": 1, "print": 1, "messag": 1, "safeti": 1, "net": 1, "transport": 1, "until": 1, "usernam": 1, "30": 1, "intiat": 1, "given": 1, "remot": 1, "side": 1, "do": 1, "simpl": 1, "doe": 1, "through": 1, "sure": 1, "back": 1, "rsakei": 1, "authent": 1, "run_interactive_ssh": 1, "were": 1, "server_writ": 1, "dedic": 1, "ftp": 1, "content": 1, "_handler": 1, "socket": 1, "tcp": 1, "stop_tunnel": 1, "thread": 1, "daemon": 1, "initiate_tunnel": 1, "index": 1, "search": 1, "page": 1}, "objects": {"expose": [[1, 0, 0, "-", "main"]], "expose.main": [[1, 1, 1, "", "Tunnel"]], "expose.main.Tunnel": [[1, 2, 1, "", "authorize_security_group"], [1, 2, 1, "", "config_requirements"], [1, 2, 1, "", "configure_vm"], [1, 2, 1, "", "create_ec2_instance"], [1, 2, 1, "", "create_key_pair"], [1, 2, 1, "", "create_security_group"], [1, 2, 1, "", "delete_key_pair"], [1, 2, 1, "", "delete_security_group"], [1, 2, 1, "", "disassociate_security_group"], [1, 2, 1, "", "get_config"], [1, 2, 1, "", "get_vpc_id"], [1, 2, 1, "", "init"], [1, 2, 1, "", "server_copy"], [1, 2, 1, "", "start"], [1, 2, 1, "", "stop"], [1, 2, 1, "", "terminate_ec2_instance"]], "expose.models": [[1, 0, 0, "-", "auxiliary"], [1, 0, 0, "-", "cert"], [1, 0, 0, "-", "exceptions"], [1, 0, 0, "-", "image_factory"], [1, 0, 0, "-", "logger"], [1, 0, 0, "-", "route_53"], [1, 0, 0, "-", "server"]], "expose.models.auxiliary": [[1, 3, 1, "", "flush_screen"], [1, 3, 1, "", "write_screen"]], "expose.models.cert": [[1, 3, 1, "", "_generate_serial_hash"], [1, 3, 1, "", "_get_serial"], [1, 3, 1, "", "generate_cert"]], "expose.models.config": [[1, 1, 1, "", "AMIBase"], [1, 1, 1, "", "EnvConfig"], [1, 1, 1, "", "Settings"]], "expose.models.config.AMIBase": [[1, 4, 1, "", "ALIAS"], [1, 4, 1, "", "NAME"], [1, 4, 1, "", "PRODUCT_CODE"], [1, 4, 1, "", "PRODUCT_PAGE"], [1, 4, 1, "", "S_ALIAS"], [1, 4, 1, "", "S_NAME"], [1, 4, 1, "", "S_PRODUCT_CODE"], [1, 4, 1, "", "S_PRODUCT_PAGE"], [1, 4, 1, "", "_BASE_SSM"], [1, 4, 1, "", "_BASE_URL"], [1, 2, 1, "", "model_post_init"]], "expose.models.config.EnvConfig": [[1, 1, 1, "", "Config"], [1, 4, 1, "", "aws_access_key"], [1, 4, 1, "", "aws_region_name"], [1, 4, 1, "", "aws_secret_key"], [1, 4, 1, "", "cert_file"], [1, 4, 1, "", "channel_timeout"], [1, 4, 1, "", "email_address"], [1, 4, 1, "", "hosted_zone"], [1, 4, 1, "", "image_id"], [1, 4, 1, "", "instance_type"], [1, 4, 1, "", "key_file"], [1, 4, 1, "", "key_pair"], [1, 4, 1, "", "open_port"], [1, 4, 1, "", "organization"], [1, 4, 1, "", "port"], [1, 4, 1, "", "security_group"], [1, 4, 1, "", "server_info"], [1, 4, 1, "", "subdomain"]], "expose.models.config.EnvConfig.Config": [[1, 4, 1, "", "env_file"], [1, 4, 1, "", "extra"]], "expose.models.config.Settings": [[1, 4, 1, "", "ami_deprecation"], [1, 4, 1, "", "configuration"], [1, 4, 1, "", "current_dir"], [1, 4, 1, "", "entrypoint"], [1, 4, 1, "", "interactive"], [1, 4, 1, "", "key_pair_file"], [1, 4, 1, "", "nginx_config_commands"], [1, 4, 1, "", "ssh_home"]], "expose.models.exceptions": [[1, 5, 1, "", "AWSResourceError"], [1, 5, 1, "", "DuplicateResource"], [1, 5, 1, "", "NotImplementedWarning"]], "expose.models.image_factory": [[1, 1, 1, "", "ImageFactory"], [1, 3, 1, "", "deprecation_warning"]], "expose.models.image_factory.ImageFactory": [[1, 2, 1, "", "get_ami_id_name"], [1, 2, 1, "", "get_ami_id_product_code"], [1, 2, 1, "", "get_ami_id_ssm"], [1, 2, 1, "", "get_image_id"]], "expose.models.route_53": [[1, 3, 1, "", "change_record_set"], [1, 3, 1, "", "get_zone_id"]], "expose.models.server": [[1, 1, 1, "", "Server"], [1, 3, 1, "", "join"], [1, 3, 1, "", "print_warning"]], "expose.models.server.Server": [[1, 2, 1, "", "_handler"], [1, 2, 1, "", "initiate_tunnel"], [1, 2, 1, "", "run_interactive_ssh"], [1, 2, 1, "", "server_write"], [1, 2, 1, "", "stop_tunnel"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:function", "4": "py:attribute", "5": "py:exception"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "function", "Python function"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "exception", "Python exception"]}, "titleterms": {"expos": [0, 1], "localhost": [0, 1], "us": [0, 1], "ec2": [0, 1], "setup": 0, "environ": 0, "variabl": 0, "usag": 0, "instal": 0, "tunnel": 0, "code": 0, "standard": 0, "releas": 0, "note": 0, "lint": 0, "pypi": 0, "packag": 0, "runbook": 0, "licens": 0, "copyright": 0, "web": 1, "servic": 1, "public": 1, "internet": 1, "aw": 1, "read": 1, "me": 1, "main": 1, "modul": 1, "auxiliari": 1, "certif": 1, "configur": 1, "except": 1, "imagefactori": 1, "logger": 1, "route53": 1, "server": 1, "indic": 1, "tabl": 1}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 56}})
\ No newline at end of file
+Search.setIndex({"docnames": ["README", "index"], "filenames": ["README.md", "index.rst"], "titles": ["Platform Supported", "Expose - Expose a web service on localhost to public internet using AWS EC2"], "terms": {"revers": [0, 1], "proxi": [0, 1], "creat": [0, 1], "secur": [0, 1], "from": [0, 1], "public": 0, "endpoint": 0, "local": [0, 1], "run": [0, 1], "web": 0, "servic": 0, "can": [0, 1], "load": [0, 1], "ani": [0, 1], "env": [0, 1], "file": [0, 1], "port": [0, 1], "number": [0, 1], "ha": [0, 1], "which": [0, 1], "app": [0, 1], "api": [0, 1], "i": [0, 1], "option": [0, 1], "open": 0, "_": 0, "boolean": [0, 1], "flag": [0, 1], "enabl": 0, "ingress": [0, 1], "egress": [0, 1], "specifi": [0, 1], "default": [0, 1], "fals": [0, 1], "channel": [0, 1], "timeout": [0, 1], "second": 0, "wait": 0, "an": [0, 1], "incom": 0, "connect": [0, 1], "100": 0, "imag": [0, 1], "id": [0, 1], "ami": [0, 1], "ubuntu": [0, 1], "o": 0, "region": 0, "specif": [0, 1], "instanc": [0, 1], "type": [0, 1], "t2": 0, "nano": 0, "aw": 0, "access": [0, 1], "kei": [0, 1], "resourc": [0, 1], "config": [0, 1], "secret": 0, "name": [0, 1], "where": 0, "should": [0, 1], "live": 0, "u": [0, 1], "west": 0, "2": [0, 1], "pair": [0, 1], "expose_localhost": 0, "group": [0, 1], "allow": [0, 1], "server": 0, "info": 0, "json": [0, 1], "store": [0, 1], "configur": 0, "server_info": [0, 1], "email": 0, "address": [0, 1], "self": [0, 1], "sign": [0, 1], "ssl": [0, 1], "privat": [0, 1], "user": 0, "com": [0, 1], "organ": [0, 1], "certif": 0, "host": [0, 1], "zone": [0, 1], "regist": [0, 1], "route53": 0, "exampl": [0, 1], "mywebsit": 0, "subdomain": [0, 1], "sub": 0, "domain": 0, "ad": [0, 1], "latenc": [0, 1], "channel_timeout": [0, 1], "adjust": 0, "improv": [0, 1], "depend": 0, "applic": 0, "": [0, 1], "role": 0, "network": 0, "shorter": 0, "make": [0, 1], "your": [0, 1], "more": [0, 1], "respons": [0, 1], "mai": 0, "also": 0, "lead": 0, "neg": 0, "high": 0, "If": [0, 1], "take": [0, 1], "longer": 0, "establish": 0, "due": 0, "condit": 0, "short": 0, "might": 0, "reject": 0, "valid": [0, 1], "prematur": 0, "rate": 0, "expect": 0, "you": [0, 1], "want": 0, "process": 0, "them": 0, "quickli": 0, "benefici": 0, "howev": 0, "mean": 0, "need": 0, "abl": 0, "rapidli": 0, "higher": 0, "repeat": 0, "check": 0, "consum": 0, "cpu": 0, "ensur": 0, "capac": 0, "handl": [0, 1], "frequent": 0, "ar": 0, "set": [0, 1], "too": 0, "low": 0, "custom": [0, 1], "The": [0, 1], "dn": [0, 1], "long": [0, 1], "messi": 0, "To": 0, "avoid": 0, "A": [0, 1], "record": [0, 1], "warn": [0, 1], "requir": [0, 1], "activ": 0, "bulb": 0, "hosted_zon": [0, 1], "internet": 0, "chain": 0, "pem": [0, 1], "format": 0, "current": 0, "work": [0, 1], "directori": 0, "key_fil": [0, 1], "cert_fil": [0, 1], "var": 0, "No": 0, "cert": [0, 1], "problem": 0, "gener": [0, 1], "automat": [0, 1], "some": 0, "browser": 0, "throw": 0, "even": 0, "block": [0, 1], "ca": [0, 1], "manual": [0, 1], "openssl": [0, 1], "req": 0, "newkei": 0, "rsa": [0, 1], "2048": [0, 1], "sha256": 0, "node": 0, "keyout": 0, "x509": [0, 1], "dai": 0, "365": 0, "out": 0, "subj": 0, "c": 0, "st": 0, "new": [0, 1], "york": [0, 1], "l": 0, "brooklyn": 0, "compani": 0, "cn": 0, "verifi": 0, "inform": [0, 1], "noout": [0, 1], "text": [0, 1], "python3": 0, "m": 0, "pip": 0, "import": 0, "env_fil": [0, 1], "instanti": [0, 1], "object": [0, 1], "start": [0, 1], "purg": [0, 1], "true": 0, "reclaim": 0, "fail": [0, 1], "stop": [0, 1], "delet": [0, 1], "all": [0, 1], "acquir": [0, 1], "troubleshoot": 0, "e": 0, "could": 0, "get": [0, 1], "lock": [0, 1], "lib": 0, "dpkg": 0, "frontend": 0, "occur": 0, "dure": [0, 1], "startup": [0, 1], "simpli": 0, "rerun": 0, "script": 0, "command": [0, 1], "thi": [0, 1], "when": [0, 1], "apt": 0, "hasn": 0, "t": [0, 1], "yet": 0, "retri": 0, "logic": 0, "place": 0, "issu": [0, 1], "persist": 0, "re": [0, 1], "entir": 0, "limit": 0, "cannot": [0, 1], "multipl": [0, 1], "without": 0, "modifi": [0, 1], "follow": 0, "key_pair": [0, 1], "ssh": [0, 1], "filenam": [0, 1], "dump": [0, 1], "data": [0, 1], "security_group": [0, 1], "firewal": 0, "rule": 0, "control": 0, "traffic": [0, 1], "via": [0, 1], "vpc": [0, 1], "docstr": 0, "googl": 0, "style": 0, "convent": 0, "pep": 0, "8": 0, "clean": 0, "pre": [0, 1], "commit": 0, "hook": 0, "flake8": 0, "isort": 0, "python": 0, "gitvers": 0, "f": 0, "release_not": 0, "rst": 0, "precommit": 0, "doc": [0, 1], "creation": [0, 1], "everi": 0, "sphinx": 0, "5": 0, "1": 0, "recommonmark": 0, "http": [0, 1], "org": 0, "project": 0, "thevickypedia": 0, "github": 0, "io": [0, 1], "vignesh": 0, "rao": 0, "under": 0, "mit": 0, "platform": 1, "support": 1, "repo": 1, "stat": 1, "deploy": 1, "setup": 1, "usag": 1, "code": 1, "standard": 1, "releas": 1, "note": 1, "lint": 1, "licens": 1, "copyright": 1, "class": 1, "tunnel": 1, "none": 1, "initi": 1, "spin": 1, "up": 1, "act": 1, "paramet": 1, "bring": 1, "own": 1, "init": 1, "bool": 1, "function": 1, "its": 1, "shutdown": 1, "create_key_pair": 1, "keypair": 1, "openssh": 1, "return": 1, "call": 1, "wa": 1, "get_vpc_id": 1, "str": 1, "fetch": 1, "union": 1, "authorize_security_group": 1, "security_group_id": 1, "public_ip": 1, "author": 1, "certain": 1, "securitygroup": 1, "argument": 1, "ip": 1, "22": 1, "onli": 1, "machin": 1, "cidr": 1, "notat": 1, "32": 1, "80": 1, "443": 1, "apart": 1, "abov": 1, "sg": 1, "request": 1, "forward": 1, "whether": 1, "successfulli": 1, "create_security_group": 1, "case": 1, "exist": 1, "same": 1, "alreadi": 1, "create_ec2_inst": 1, "tupl": 1, "success": 1, "delete_key_pair": 1, "disassociate_security_group": 1, "instance_id": 1, "disassoci": 1, "assign": 1, "unavail": 1, "delete_security_group": 1, "terminate_ec2_inst": 1, "serviceresourc": 1, "termin": 1, "nginx": 1, "refer": 1, "amazon": 1, "cli": 1, "latest": 1, "describ": 1, "statu": 1, "html": 1, "boto3": 1, "amazonaw": 1, "v1": 1, "document": 1, "wait_until_termin": 1, "server_copi": 1, "sourc": 1, "destin": 1, "write": 1, "within": 1, "get_config": 1, "download": 1, "string": 1, "config_requir": 1, "common_nam": 1, "custom_serv": 1, "san_list": 1, "list": 1, "dict": 1, "tri": 1, "dictionari": 1, "entri": 1, "subject": 1, "altern": 1, "configure_vm": 1, "public_dn": 1, "dispos": 1, "disabl": 1, "remov": 1, "doesn": 1, "neither": 1, "nor": 1, "hand": 1, "model": 1, "write_screen": 1, "screen": 1, "clear": 1, "later": 1, "written": 1, "flush_screen": 1, "flush": 1, "output": 1, "empti": 1, "size": 1, "ran": 1, "one": 1, "_get_seri": 1, "byte": 1, "serial": 1, "here": 1, "just": 1, "measur": 1, "insert": 1, "uniqu": 1, "identifi": 1, "encod": 1, "_generate_serial_hash": 1, "byte_s": 1, "int": 1, "18": 1, "int_siz": 1, "36": 1, "hash": 1, "contain": 1, "random": 1, "base": 1, "generate_cert": 1, "country_nam": 1, "locality_nam": 1, "springfield": 1, "state_or_province_nam": 1, "missouri": 1, "organization_unit_nam": 1, "technologi": 1, "key_siz": 1, "origin": 1, "countri": 1, "citi": 1, "state": 1, "provinc": 1, "unit": 1, "san": 1, "look": 1, "amibas": 1, "pydant": 1, "basemodel": 1, "valu": 1, "pars": 1, "input": 1, "keyword": 1, "rais": 1, "validationerror": 1, "pydantic_cor": 1, "form": 1, "__init__": 1, "__pydantic_self__": 1, "instead": 1, "common": 1, "first": 1, "arg": 1, "field": 1, "_base_url": 1, "modelprivateattr": 1, "marketplac": 1, "productid": 1, "_base_ssm": 1, "prod": 1, "path": 1, "product_pag": 1, "url": 1, "alia": 1, "product_cod": 1, "s_product_pag": 1, "s_name": 1, "s_alia": 1, "s_product_cod": 1, "model_post_init": 1, "__context": 1, "meant": 1, "behav": 1, "like": 1, "method": 1, "initialis": 1, "attribut": 1, "It": 1, "context": 1, "sinc": 1, "what": 1, "core": 1, "pass": 1, "envconfig": 1, "pydantic_set": 1, "baseset": 1, "dev": 1, "3": 1, "migrat": 1, "nullabl": 1, "open_port": 1, "image_id": 1, "instance_typ": 1, "aws_region_nam": 1, "aws_access_kei": 1, "aws_secret_kei": 1, "email_address": 1, "emailstr": 1, "extra": 1, "wrapper": 1, "interact": 1, "current_dir": 1, "ssh_home": 1, "key_pair_fil": 1, "ami_deprec": 1, "entrypoint": 1, "nginx_config_command": 1, "notimplementedwarn": 1, "implement": 1, "duplicateresourc": 1, "error": 1, "duplic": 1, "awsresourceerror": 1, "status_cod": 1, "error_msg": 1, "image_factori": 1, "deprecation_warn": 1, "deprecation_tim": 1, "deprec": 1, "chosen": 1, "nearing": 1, "deprecationtim": 1, "session": 1, "retriev": 1, "get_ami_id_ssm": 1, "get_ami_id_product_cod": 1, "product": 1, "get_ami_id_nam": 1, "get_image_id": 1, "sequenti": 1, "execut": 1, "sequenc": 1, "fastest": 1, "ssm": 1, "point": 1, "singl": 1, "possibli": 1, "lookup": 1, "mani": 1, "so": 1, "grab": 1, "most": 1, "recent": 1, "unabl": 1, "log": 1, "share": 1, "across": 1, "route_53": 1, "get_zone_id": 1, "client": 1, "miss": 1, "change_record_set": 1, "zone_id": 1, "action": 1, "chang": 1, "hostnam": 1, "perform": 1, "upsert": 1, "changeset": 1, "join": 1, "separ": 1, "squash": 1, "print_warn": 1, "print": 1, "messag": 1, "safeti": 1, "net": 1, "transport": 1, "until": 1, "usernam": 1, "30": 1, "intiat": 1, "given": 1, "remot": 1, "side": 1, "do": 1, "simpl": 1, "doe": 1, "through": 1, "sure": 1, "back": 1, "rsakei": 1, "authent": 1, "run_interactive_ssh": 1, "were": 1, "server_writ": 1, "dedic": 1, "ftp": 1, "content": 1, "_handler": 1, "socket": 1, "tcp": 1, "stop_tunnel": 1, "thread": 1, "daemon": 1, "initiate_tunnel": 1, "index": 1, "search": 1, "page": 1}, "objects": {"expose": [[1, 0, 0, "-", "main"]], "expose.main": [[1, 1, 1, "", "Tunnel"]], "expose.main.Tunnel": [[1, 2, 1, "", "authorize_security_group"], [1, 2, 1, "", "config_requirements"], [1, 2, 1, "", "configure_vm"], [1, 2, 1, "", "create_ec2_instance"], [1, 2, 1, "", "create_key_pair"], [1, 2, 1, "", "create_security_group"], [1, 2, 1, "", "delete_key_pair"], [1, 2, 1, "", "delete_security_group"], [1, 2, 1, "", "disassociate_security_group"], [1, 2, 1, "", "get_config"], [1, 2, 1, "", "get_vpc_id"], [1, 2, 1, "", "init"], [1, 2, 1, "", "server_copy"], [1, 2, 1, "", "start"], [1, 2, 1, "", "stop"], [1, 2, 1, "", "terminate_ec2_instance"]], "expose.models": [[1, 0, 0, "-", "auxiliary"], [1, 0, 0, "-", "cert"], [1, 0, 0, "-", "exceptions"], [1, 0, 0, "-", "image_factory"], [1, 0, 0, "-", "logger"], [1, 0, 0, "-", "route_53"], [1, 0, 0, "-", "server"]], "expose.models.auxiliary": [[1, 3, 1, "", "flush_screen"], [1, 3, 1, "", "write_screen"]], "expose.models.cert": [[1, 3, 1, "", "_generate_serial_hash"], [1, 3, 1, "", "_get_serial"], [1, 3, 1, "", "generate_cert"]], "expose.models.config": [[1, 1, 1, "", "AMIBase"], [1, 1, 1, "", "EnvConfig"], [1, 1, 1, "", "Settings"]], "expose.models.config.AMIBase": [[1, 4, 1, "", "ALIAS"], [1, 4, 1, "", "NAME"], [1, 4, 1, "", "PRODUCT_CODE"], [1, 4, 1, "", "PRODUCT_PAGE"], [1, 4, 1, "", "S_ALIAS"], [1, 4, 1, "", "S_NAME"], [1, 4, 1, "", "S_PRODUCT_CODE"], [1, 4, 1, "", "S_PRODUCT_PAGE"], [1, 4, 1, "", "_BASE_SSM"], [1, 4, 1, "", "_BASE_URL"], [1, 2, 1, "", "model_post_init"]], "expose.models.config.EnvConfig": [[1, 1, 1, "", "Config"], [1, 4, 1, "", "aws_access_key"], [1, 4, 1, "", "aws_region_name"], [1, 4, 1, "", "aws_secret_key"], [1, 4, 1, "", "cert_file"], [1, 4, 1, "", "channel_timeout"], [1, 4, 1, "", "email_address"], [1, 4, 1, "", "hosted_zone"], [1, 4, 1, "", "image_id"], [1, 4, 1, "", "instance_type"], [1, 4, 1, "", "key_file"], [1, 4, 1, "", "key_pair"], [1, 4, 1, "", "open_port"], [1, 4, 1, "", "organization"], [1, 4, 1, "", "port"], [1, 4, 1, "", "security_group"], [1, 4, 1, "", "server_info"], [1, 4, 1, "", "subdomain"]], "expose.models.config.EnvConfig.Config": [[1, 4, 1, "", "env_file"], [1, 4, 1, "", "extra"]], "expose.models.config.Settings": [[1, 4, 1, "", "ami_deprecation"], [1, 4, 1, "", "configuration"], [1, 4, 1, "", "current_dir"], [1, 4, 1, "", "entrypoint"], [1, 4, 1, "", "interactive"], [1, 4, 1, "", "key_pair_file"], [1, 4, 1, "", "nginx_config_commands"], [1, 4, 1, "", "ssh_home"]], "expose.models.exceptions": [[1, 5, 1, "", "AWSResourceError"], [1, 5, 1, "", "DuplicateResource"], [1, 5, 1, "", "NotImplementedWarning"]], "expose.models.image_factory": [[1, 1, 1, "", "ImageFactory"], [1, 3, 1, "", "deprecation_warning"]], "expose.models.image_factory.ImageFactory": [[1, 2, 1, "", "get_ami_id_name"], [1, 2, 1, "", "get_ami_id_product_code"], [1, 2, 1, "", "get_ami_id_ssm"], [1, 2, 1, "", "get_image_id"]], "expose.models.route_53": [[1, 3, 1, "", "change_record_set"], [1, 3, 1, "", "get_zone_id"]], "expose.models.server": [[1, 1, 1, "", "Server"], [1, 3, 1, "", "join"], [1, 3, 1, "", "print_warning"]], "expose.models.server.Server": [[1, 2, 1, "", "_handler"], [1, 2, 1, "", "initiate_tunnel"], [1, 2, 1, "", "run_interactive_ssh"], [1, 2, 1, "", "server_write"], [1, 2, 1, "", "stop_tunnel"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:function", "4": "py:attribute", "5": "py:exception"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "function", "Python function"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "exception", "Python exception"]}, "titleterms": {"platform": 0, "support": 0, "repo": 0, "stat": 0, "deploy": 0, "expos": [0, 1], "localhost": [0, 1], "us": [0, 1], "ec2": [0, 1], "setup": 0, "environ": 0, "variabl": 0, "usag": 0, "instal": 0, "tunnel": 0, "code": 0, "standard": 0, "releas": 0, "note": 0, "lint": 0, "pypi": 0, "packag": 0, "runbook": 0, "licens": 0, "copyright": 0, "web": 1, "servic": 1, "public": 1, "internet": 1, "aw": 1, "read": 1, "me": 1, "main": 1, "modul": 1, "auxiliari": 1, "certif": 1, "configur": 1, "except": 1, "imagefactori": 1, "logger": 1, "route53": 1, "server": 1, "indic": 1, "tabl": 1}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 56}})
\ No newline at end of file