Skip to content

Update FAQ #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
badarahmed wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update FAQ #33

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f0e6e78
Update FAQ
badarahmed Apr 5, 2023
a226c05
Merge branch 'main' into update-faq
milesjos Apr 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/docs/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,14 @@ We know that JupyterLab is where many data scientist experiement and prove out t

Yes, you can run NB Defense in your CI pipline using the [NB Defense CLI](./getting-started/cli.md)! Use the CLI in your CI pipelines to scan repositories, or multiple notebooks at a time.

### What is special about NB Defense when many security tools offer similar functionality?
### What is unique about NB Defense when many security tools offer similar functionality?

NB Defense is special because it allows you to scan Jupyter Notebooks. We provide both a [JupyterLab Extension](./getting-started/jupyter-lab-extension.md) that you can use to scan notebooks while you're working, and a [CLI](./getting-started/cli.md) that you can use to scan groups of notebooks or repositories. Using both of these tools, you can scan your notebooks for personally identifiable information (PII), secrets, common exposures and vulnerabilities (CVEs), and non permissive licenses.

NB Defense allows you to scan Jupyter Notebooks. Currently most security tools do not support Notebook `.ipynb` formatted files. NB Defense fills this gap. We provide both a [JupyterLab Extension](./getting-started/jupyter-lab-extension.md) that you can use to scan notebooks within Jupyterlab environment, and a [CLI](./getting-started/cli.md) that you can use to scan groups of notebooks or repositories. Using both of these tools, you can scan your notebooks for personally identifiable information (PII), secrets, common exposures and vulnerabilities (CVEs), and non permissive licenses.
Copy link
Copy Markdown
Member

@milesjos milesjos Apr 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Current

that you can use to scan notebooks within Jupyterlab environment

Recommended

that you can use to scan notebooks within a JupyterLab environment

Copy link
Copy Markdown
Member

@chrisking chrisking Apr 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps instead of saying they don't support .ipynb files, state that they aren't rendering findings in a way that a Jupyter user understands. Specifically they will report an issue on a line of a JSON file, not within a specific cell or output.


### Does NB Defense JupyterLab Extension run in my kernel?

We recommend that you isolate NB Defense from the kernel that you are using for your notebook. If you have installed NB Defense into a separate python environment, it will not run in your kernel. We do use your active kernels python path to determine which third party dependencies are installed, so we can scan them for CVEs and licenses.
No. We recommend installing NB Defense Jupyterlab extension outside of Kernel specific environment. NB Defense runs its code on the Jupyter Server instead of Notebook specific Kernel(s). We do use your active kernels python path to determine which third party dependencies are installed, so we can scan them for CVEs and licenses.
Copy link
Copy Markdown
Member

@milesjos milesjos Apr 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Current

We recommend installing NB Defense Jupyterlab extension outside of Kernel specific environment.

Recommended

We recommend installing NB Defense JupyterLab extension outside of a kernel-specific environment.

Also, we should add an apostrophe for kernel's and capitalize Python in active kernel's Python path in the next sentence.


## Found A Bug? 🐞

Expand Down