Skip to content

Commit 762da18

Browse files
Updated info for jupyer-book format
1 parent 9968a9f commit 762da18

File tree

7 files changed

+103
-37
lines changed

7 files changed

+103
-37
lines changed

Chapters.makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,7 @@ FRONTMATTER = \
9898
EXTRAS = \
9999
ReleaseNotes.ipynb \
100100
Importing.ipynb \
101+
Copyright.ipynb \
101102
Guide_for_Authors.ipynb \
102103
Template.ipynb \
103104
404.ipynb

_config.yml

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,16 +37,18 @@ parse:
3737
- deflist
3838

3939
html:
40-
announcement: '<p>This is a beta version of fuzzingbook.org, currently in development. See the <a href="https://fuzzingbook.org/classic/" style="color:white!important;">classic site</a> for resources.</p>'
40+
announcement: '<p>This is a beta version of fuzzingbook.org, currently in development. See the <a href="https://fuzzingbook.org/classic/" style="color:white!important;">classic site</a> for the 2024 version.</p>'
4141
use_issues_button: true
4242
use_repository_button: true
4343
extra_footer: |
4444
<div>
45-
Copyright &copy;
46-
2021–2025 <a href="https://www.cispa.de/">CISPA Helmholtz Center for Information Security</a>. Copyright &copy; 2018-2020 <a href="https://www.uni-saarland.de/">Saarland University</a>. Copyright &copy; 2018-2025 external contributors.
47-
The content of this project is licensed under the <a href="https://creativecommons.org/licenses/by-nc-sa/4.0/">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://cispa.de/en/impressum">Imprint</a>.
45+
Copyright &copy; 2021–2025 <a href="https://www.cispa.de/">CISPA Helmholtz Center for Information Security</a>. Copyright &copy; 2018-2020 <a href="https://www.uni-saarland.de/">Saarland University</a>. Copyright &copy; 2018-2025 external contributors.
46+
The <strong>content</strong> of this project is licensed under the <a href="https://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
47+
The <strong>source code</strong> 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>.
48+
<br>
49+
<a href="https://cispa.de/en/impressum">Imprint</a> &middot; <a href="/html/index.html#how-do-i-cite-your-work">Cite</a>
4850
</div>
49-
51+
5052
sphinx:
5153
config:
5254
html_show_copyright: false

_toc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,4 +59,5 @@ parts:
5959
chapters:
6060
- file: ReleaseNotes
6161
- file: Importing
62+
- file: Copyright
6263
- file: Guide_for_Authors

notebooks/Copyright.ipynb

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
{
2+
"cells": [
3+
{
4+
"cell_type": "markdown",
5+
"metadata": {
6+
"button": false,
7+
"new_sheet": false,
8+
"run_control": {
9+
"read_only": false
10+
}
11+
},
12+
"source": [
13+
"# Copyright\n",
14+
"\n",
15+
"This material is copyright &copy; \n",
16+
"2021–2025 <a href=\"https://www.cispa.de/\">CISPA Helmholtz Center for Information Security</a>. Copyright &copy; 2018-2020 <a href=\"https://www.uni-saarland.de/\">Saarland University</a>. Copyright &copy; 2018-2025 external contributors.\n",
17+
"\n",
18+
"The <strong>content</strong> of this project is licensed under the <a href=\"https://creativecommons.org/licenses/by-nc-sa/4.0/\">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.\n",
19+
"\n",
20+
"The <strong>source code</strong> 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>.\n",
21+
"\n",
22+
"<a href=\"https://cispa.de/en/impressum\">Imprint</a> &middot; <a href=\"/html/index.html#how-do-i-cite-your-work\">Cite</a>"
23+
]
24+
}
25+
],
26+
"metadata": {
27+
"ipub": {
28+
"bibliography": "fuzzingbook.bib",
29+
"toc": true
30+
},
31+
"kernelspec": {
32+
"display_name": "Python 3 (ipykernel)",
33+
"language": "python",
34+
"name": "python3"
35+
},
36+
"language_info": {
37+
"codemirror_mode": {
38+
"name": "ipython",
39+
"version": 3
40+
},
41+
"file_extension": ".py",
42+
"mimetype": "text/x-python",
43+
"name": "python",
44+
"nbconvert_exporter": "python",
45+
"pygments_lexer": "ipython3",
46+
"version": "3.9.7"
47+
},
48+
"toc": {
49+
"base_numbering": 1,
50+
"nav_menu": {},
51+
"number_sections": true,
52+
"sideBar": true,
53+
"skip_h1_title": true,
54+
"title_cell": "",
55+
"title_sidebar": "Contents",
56+
"toc_cell": false,
57+
"toc_position": {},
58+
"toc_section_display": true,
59+
"toc_window_display": true
60+
},
61+
"toc-autonumbering": false
62+
},
63+
"nbformat": 4,
64+
"nbformat_minor": 4
65+
}

notebooks/Importing.ipynb

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
"In short, there are three ways:\n",
2323
"\n",
2424
"1. Simply run the notebooks in your browser, using the \"mybinder\" environment. Choose \"Binder\" from the menus at the top; this will lead you to a preconfigured Jupyter Notebook environment where you can toy around at your leisure.\n",
25-
"2. Import the code for your own Python programs. Using `pip install fuzzingbook`, you can install all code and start using it from your own code. See \"Can I import the code for my own Python projects?\", below.\n",
25+
"2. Import the code for your own Python programs. Using `pip install fuzzingbook`, you can install all code and start using it from your own code. See \"Installing Fuzzingbook Code for your own Python projects\", below.\n",
2626
"3. Download or check out the code and/or the notebooks from the project site. This allows you to edit and run all things locally. However, be sure to also install the required packages; see below for details."
2727
]
2828
},
@@ -217,11 +217,13 @@
217217
"source": [
218218
"#### Installing Graphviz on Linux\n",
219219
"\n",
220+
"Use\n",
221+
"\n",
220222
"```sh\n",
221223
"$ sudo apt-get install graphviz libgraphviz-dev\n",
222224
"```\n",
223225
"\n",
224-
"to install it. "
226+
"to install `dot`."
225227
]
226228
},
227229
{
@@ -319,6 +321,28 @@
319321
"\n",
320322
"to run the tests."
321323
]
324+
},
325+
{
326+
"cell_type": "markdown",
327+
"metadata": {},
328+
"source": [
329+
"## Using Docker\n",
330+
"\n",
331+
"As another alternative, you can also **use our Docker images** (experimental). [Install Docker](https://docs.docker.com/get-docker/) and then run\n",
332+
"```\n",
333+
" $ docker pull zeller24/fuzzingbook\n",
334+
" $ docker run -it --rm -p 8888:8888 zeller24/fuzzingbook\n",
335+
"```\n",
336+
"and then in your Web browser, open the URL (`http://127.0.0.1/...` or `http://localhost/...`) given in the console output.\n",
337+
"This should kick off the same Jupyter environment as in mybinder.org.\n",
338+
"\n",
339+
"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."
340+
]
341+
},
342+
{
343+
"cell_type": "markdown",
344+
"metadata": {},
345+
"source": []
322346
}
323347
],
324348
"metadata": {

notebooks/Tours.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
}
1414
},
1515
"source": [
16-
"# Tours through the Book\n",
16+
"# Sitemap\n",
1717
"\n",
1818
"This book is _massive_. With more than 20,000 lines of code and 150,000 words of text, a printed version would cover more than 1,200 pages of text. Obviously, we do not assume that everybody wants to read everything."
1919
]

notebooks/index.ipynb

Lines changed: 2 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -125,22 +125,7 @@
125125
"source": [
126126
"#### Do I have alternatives to the interactive notebook?\n",
127127
"\n",
128-
"If mybinder.org does not work or match your needs, you have a number of alternatives:\n",
129-
"\n",
130-
"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",
131-
"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",
132-
"\n",
133-
"For details, see our article on [Using Debuggingbook Code in your own Programs](Importing.ipynb).\n",
134-
"\n",
135-
"As another alternative, you can also **use our Docker images** (experimental). [Install Docker](https://docs.docker.com/get-docker/) and then run\n",
136-
"```\n",
137-
" $ docker pull zeller24/fuzzingbook\n",
138-
" $ docker run -it --rm -p 8888:8888 zeller24/fuzzingbook\n",
139-
"```\n",
140-
"and then in your Web browser, open the URL (`http://127.0.0.1/...` or `http://localhost/...`) given in the console output.\n",
141-
"This should give you the same environment as in mybinder.org.\n",
142-
"\n",
143-
"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."
128+
"If mybinder.org does not work or match your needs, you can [download the code and/or notebooks and run them on your machine](Importing.ipynb)"
144129
]
145130
},
146131
{
@@ -198,7 +183,7 @@
198183
"source": [
199184
"#### How do I cite your work?\n",
200185
"\n",
201-
"Sure! Here's how to cite it:\n",
186+
"Here's how to cite it:\n",
202187
"\n",
203188
"> Andreas Zeller, Rahul Gopinath, Marcel Böhme, Gordon Fraser, and Christian Holler: \"The Fuzzing Book\". CISPA Helmholtz Center for Information Security, 2024.\n",
204189
"\n",
@@ -276,18 +261,6 @@
276261
"We have compiled a number of [tours through the book](Tours.ipynb) for various audiences. Our [Sitemap](00_Table_of_Contents.ipynb) lists the dependencies between the individual chapters."
277262
]
278263
},
279-
{
280-
"cell_type": "markdown",
281-
"metadata": {},
282-
"source": [
283-
"#### How can I extend or adapt your slides?\n",
284-
"\n",
285-
"Download the Jupyter Notebooks (using the menu at the top) and adapt the notebooks at your leisure (see above), including \"Slide Type\" settings. Then,\n",
286-
"\n",
287-
"1. Download slides from Jupyter Notebook; or\n",
288-
"2. Use the RISE extension ([instructions](http://www.blog.pythonlibrary.org/2018/09/25/creating-presentations-with-jupyter-notebook/)) to present your slides right out of Jupyter notebook."
289-
]
290-
},
291264
{
292265
"cell_type": "markdown",
293266
"metadata": {},

0 commit comments

Comments
 (0)