Doc update

uds-se · Jul 1, 2024 · d4112d5 · d4112d5
1 parent 012e5cf
commit d4112d5
Show file tree

Hide file tree

Showing 6 changed files with 44 additions and 27 deletions.
diff --git a/docs/beta/dist/fuzzingbook-1.2.2.tar.gz b/docs/beta/dist/fuzzingbook-1.2.2.tar.gz
diff --git a/docs/beta/dist/fuzzingbook-code.zip b/docs/beta/dist/fuzzingbook-code.zip
diff --git a/docs/beta/dist/fuzzingbook-notebooks.zip b/docs/beta/dist/fuzzingbook-notebooks.zip
diff --git a/docs/beta/html/index.html b/docs/beta/html/index.html
@@ -12147,13 +12147,17 @@
 <div class="inner_cell">
 <div class="text_cell_render border-box-sizing rendered_html"><h4 id="Do-I-have-alternatives-to-the-interactive-notebook?">Do I have alternatives to the interactive notebook?<a class="anchor-link" href="#Do-I-have-alternatives-to-the-interactive-notebook?">&#182;</a></h4><p>If mybinder.org does not work or match your needs, you have a number of alternatives:</p>
 <ol>
-<li><p><strong>Download the Python code</strong> (using the menu at the top) and edit and run it in your favorite environment.  This is easy to do and does not require lots of resources.</p>
-</li>
-<li><p><strong>Download the Jupyter Notebooks</strong> (using the menu at the top) and open them in Jupyter.  Here's <a href="https://www.dataquest.io/blog/jupyter-notebook-tutorial/">how to install jupyter notebook on your machine</a>.</p>
-</li>
-<li><p>If you want to use the book in a classroom, and depend on your users having access to the interactive notebooks, consider using or deploying a <a href="http://jupyter.org/hub">JupyterHub</a> or <a href="https://github.com/jupyterhub/binderhub">BinderHub</a> instance.</p>
-</li>
+<li><strong>Download the Python code</strong> (using the menu at the top) and edit and run it in your favorite environment.  This is easy to do and does not require lots of resources.</li>
+<li><strong>Download the Jupyter Notebooks</strong> (using the menu at the top) and open them in Jupyter.  Here's <a href="https://www.dataquest.io/blog/jupyter-notebook-tutorial/">how to install jupyter notebook on your machine</a>.</li>
 </ol>
+<p>For details, see our article on <a href="Importing.html">Using Debuggingbook Code in your own Programs</a>.</p>
+<p>As another alternative, you can also <strong>use our Docker images</strong> (experimental). <a href="https://docs.docker.com/get-docker/">Install Docker</a> and then run</p>
+
+<pre><code>    $ docker pull zeller24/fuzzingbook
+    $ docker run -it --rm -p 8888:8888 zeller24/fuzzingbook</code></pre>
+<p>and then in your Web browser, open the URL (<code>http://127.0.0.1/...</code> or <code>http://localhost/...</code>) given in the console output.
+This should give you the same environment as in mybinder.org.</p>
+<p>If you want to create your own Docker images, use our <a href="https://github.com/uds-se/fuzzingbook/blob/master/binder/Dockerfile">Dockerfile</a> as a starting point.</p>
 </div>
 </div>
 </div>
@@ -12369,7 +12373,7 @@
 The content of this project is licensed under the
 <a href="https://creativecommons.org/licenses/by-nc-sa/4.0/" target=_blank>Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
 The source code that is part of the content, as well as the source code used to format and display that content is licensed under the <a href="https://github.com/uds-se/fuzzingbook/blob/master/LICENSE.md#mit-license">MIT License</a>.
-<a href="https://github.com/uds-se/fuzzingbook/commits/master/notebooks/index.ipynb" target=_blank)>Last change: 2024-06-29 18:25:54+02:00</a> &bull; 
+<a href="https://github.com/uds-se/fuzzingbook/commits/master/notebooks/index.ipynb" target=_blank)>Last change: 2024-07-01 16:50:18+02:00</a> &bull; 
 <a href="#citation" id="cite" onclick="revealCitation()">Cite</a> &bull;
 <a href="https://cispa.de/en/impressum" target=_blank>Imprint</a>
 </p>
@@ -12385,7 +12389,7 @@
 <a name="citation"></a>
 <h2>How to Cite this Work</h2>
 <p>
-Andreas Zeller, Rahul Gopinath, Marcel Böhme, Gordon Fraser, and Christian Holler: "<a href="https://www.fuzzingbook.org/beta/html/index.html">About this Book</a>".  In Andreas Zeller, Rahul Gopinath, Marcel Böhme, Gordon Fraser, and Christian Holler, "<a href="https://www.fuzzingbook.org/beta/">The Fuzzing Book</a>", <a href="https://www.fuzzingbook.org/beta/html/index.html">https://www.fuzzingbook.org/beta/html/index.html</a>.  Retrieved 2024-06-29 18:25:54+02:00.
+Andreas Zeller, Rahul Gopinath, Marcel Böhme, Gordon Fraser, and Christian Holler: "<a href="https://www.fuzzingbook.org/beta/html/index.html">About this Book</a>".  In Andreas Zeller, Rahul Gopinath, Marcel Böhme, Gordon Fraser, and Christian Holler, "<a href="https://www.fuzzingbook.org/beta/">The Fuzzing Book</a>", <a href="https://www.fuzzingbook.org/beta/html/index.html">https://www.fuzzingbook.org/beta/html/index.html</a>.  Retrieved 2024-07-01 16:50:18+02:00.
 </p>
 <pre>
 @incollection{fuzzingbook2024:index,
@@ -12395,9 +12399,9 @@ <h2>How to Cite this Work</h2>
     year = {2024},
     publisher = {CISPA Helmholtz Center for Information Security},
     howpublished = {\url{https://www.fuzzingbook.org/beta/html/index.html}},
-    note = {Retrieved 2024-06-29 18:25:54+02:00},
+    note = {Retrieved 2024-07-01 16:50:18+02:00},
     url = {https://www.fuzzingbook.org/beta/html/index.html},
-    urldate = {2024-06-29 18:25:54+02:00}
+    urldate = {2024-07-01 16:50:18+02:00}
 }
 </pre>
 </div>

diff --git a/docs/beta/index.html b/docs/beta/index.html
@@ -12142,13 +12142,17 @@
 <div class="inner_cell">
 <div class="text_cell_render border-box-sizing rendered_html"><h4 id="Do-I-have-alternatives-to-the-interactive-notebook?">Do I have alternatives to the interactive notebook?<a class="anchor-link" href="#Do-I-have-alternatives-to-the-interactive-notebook?">&#182;</a></h4><p>If mybinder.org does not work or match your needs, you have a number of alternatives:</p>
 <ol>
-<li><p><strong>Download the Python code</strong> (using the menu at the top) and edit and run it in your favorite environment.  This is easy to do and does not require lots of resources.</p>
-</li>
-<li><p><strong>Download the Jupyter Notebooks</strong> (using the menu at the top) and open them in Jupyter.  Here's <a href="https://www.dataquest.io/blog/jupyter-notebook-tutorial/">how to install jupyter notebook on your machine</a>.</p>
-</li>
-<li><p>If you want to use the book in a classroom, and depend on your users having access to the interactive notebooks, consider using or deploying a <a href="http://jupyter.org/hub">JupyterHub</a> or <a href="https://github.com/jupyterhub/binderhub">BinderHub</a> instance.</p>
-</li>
+<li><strong>Download the Python code</strong> (using the menu at the top) and edit and run it in your favorite environment.  This is easy to do and does not require lots of resources.</li>
+<li><strong>Download the Jupyter Notebooks</strong> (using the menu at the top) and open them in Jupyter.  Here's <a href="https://www.dataquest.io/blog/jupyter-notebook-tutorial/">how to install jupyter notebook on your machine</a>.</li>
 </ol>
+<p>For details, see our article on <a href="html/Importing.html">Using Debuggingbook Code in your own Programs</a>.</p>
+<p>As another alternative, you can also <strong>use our Docker images</strong> (experimental). <a href="https://docs.docker.com/get-docker/">Install Docker</a> and then run</p>
+
+<pre><code>    $ docker pull zeller24/fuzzingbook
+    $ docker run -it --rm -p 8888:8888 zeller24/fuzzingbook</code></pre>
+<p>and then in your Web browser, open the URL (<code>http://127.0.0.1/...</code> or <code>http://localhost/...</code>) given in the console output.
+This should give you the same environment as in mybinder.org.</p>
+<p>If you want to create your own Docker images, use our <a href="https://github.com/uds-se/fuzzingbook/blob/master/binder/Dockerfile">Dockerfile</a> as a starting point.</p>
 </div>
 </div>
 </div>
@@ -12364,7 +12368,7 @@
 The content of this project is licensed under the
 <a href="https://creativecommons.org/licenses/by-nc-sa/4.0/" target=_blank>Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
 The source code that is part of the content, as well as the source code used to format and display that content is licensed under the <a href="https://github.com/uds-se/fuzzingbook/blob/master/LICENSE.md#mit-license">MIT License</a>.
-<a href="https://github.com/uds-se/fuzzingbook/commits/master/notebooks/index.ipynb" target=_blank)>Last change: 2024-06-29 18:25:54+02:00</a> &bull; 
+<a href="https://github.com/uds-se/fuzzingbook/commits/master/notebooks/index.ipynb" target=_blank)>Last change: 2024-07-01 16:50:18+02:00</a> &bull; 
 <a href="#citation" id="cite" onclick="revealCitation()">Cite</a> &bull;
 <a href="https://cispa.de/en/impressum" target=_blank>Imprint</a>
 </p>
@@ -12380,7 +12384,7 @@
 <a name="citation"></a>
 <h2>How to Cite this Work</h2>
 <p>
-Andreas Zeller, Rahul Gopinath, Marcel Böhme, Gordon Fraser, and Christian Holler: "<a href="https://www.fuzzingbook.org/beta/">The Fuzzing Book</a>".  Retrieved 2024-06-29 18:25:54+02:00.
+Andreas Zeller, Rahul Gopinath, Marcel Böhme, Gordon Fraser, and Christian Holler: "<a href="https://www.fuzzingbook.org/beta/">The Fuzzing Book</a>".  Retrieved 2024-07-01 16:50:18+02:00.
 </p>
 <pre>
 @book{fuzzingbook2024,
@@ -12389,9 +12393,9 @@ <h2>How to Cite this Work</h2>
     year = {2024},
     publisher = {CISPA Helmholtz Center for Information Security},
     howpublished = {\url{https://www.fuzzingbook.org/beta/}},
-    note = {Retrieved 2024-06-29 18:25:54+02:00},
+    note = {Retrieved 2024-07-01 16:50:18+02:00},
     url = {https://www.fuzzingbook.org/beta/},
-    urldate = {2024-06-29 18:25:54+02:00}
+    urldate = {2024-07-01 16:50:18+02:00}
 }
 </pre>
 </div>

diff --git a/docs/beta/notebooks/index.ipynb b/docs/beta/notebooks/index.ipynb
@@ -19,10 +19,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-06-30T16:22:51.063526Z",
-     "iopub.status.busy": "2024-06-30T16:22:51.063124Z",
-     "iopub.status.idle": "2024-06-30T16:22:51.148134Z",
-     "shell.execute_reply": "2024-06-30T16:22:51.147752Z"
+     "iopub.execute_input": "2024-07-01T14:50:20.739296Z",
+     "iopub.status.busy": "2024-07-01T14:50:20.738260Z",
+     "iopub.status.idle": "2024-07-01T14:50:20.873057Z",
+     "shell.execute_reply": "2024-07-01T14:50:20.872648Z"
     },
     "slideshow": {
      "slide_type": "skip"
@@ -44,7 +44,7 @@
        "        "
       ],
       "text/plain": [
-       "<IPython.lib.display.IFrame at 0x103f33640>"
+       "<IPython.lib.display.IFrame at 0x105b2e230>"
       ]
      },
      "execution_count": 1,
@@ -214,10 +214,19 @@
     "If mybinder.org does not work or match your needs, you have a number of alternatives:\n",
     "\n",
     "1. **Download the Python code** (using the menu at the top) and edit and run it in your favorite environment.  This is easy to do and does not require lots of resources.\n",
-    "\n",
     "2. **Download the Jupyter Notebooks** (using the menu at the top) and open them in Jupyter.  Here's [how to install jupyter notebook on your machine](https://www.dataquest.io/blog/jupyter-notebook-tutorial/).\n",
     "\n",
-    "3. If you want to use the book in a classroom, and depend on your users having access to the interactive notebooks, consider using or deploying a [JupyterHub](http://jupyter.org/hub) or [BinderHub](https://github.com/jupyterhub/binderhub) instance."
+    "For details, see our article on [Using Debuggingbook Code in your own Programs](Importing.ipynb).\n",
+    "\n",
+    "As another alternative, you can also **use our Docker images** (experimental). [Install Docker](https://docs.docker.com/get-docker/) and then run\n",
+    "```\n",
+    "    $ docker pull zeller24/fuzzingbook\n",
+    "    $ docker run -it --rm -p 8888:8888 zeller24/fuzzingbook\n",
+    "```\n",
+    "and then in your Web browser, open the URL (`http://127.0.0.1/...` or `http://localhost/...`) given in the console output.\n",
+    "This should give you the same environment as in mybinder.org.\n",
+    "\n",
+    "If you want to create your own Docker images, use our [Dockerfile](https://github.com/uds-se/fuzzingbook/blob/master/binder/Dockerfile) as a starting point."
    ]
   },
   {