Skip to content

docs: fix jailbreak detection build instructions #1248

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

Merged
merged 1 commit into from
Jun 30, 2025
Merged

docs: fix jailbreak detection build instructions #1248

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions docs/user-guides/advanced/using-docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ NOTE: the provided Dockerfile downloads only the `base` AlignScore image. If you
If you want to use the jailbreak detection heuristics server, you can also build a Docker image using the provided [Dockerfile](https://github.com/NVIDIA/NeMo-Guardrails/tree/develop/nemoguardrails/library/jailbreak_detection/Dockerfile).

```bash
cd nemoguardrails/jailbreak_detection
cd nemoguardrails/library/jailbreak_detection
docker build -t jailbreak_detection_heuristics .
```

Expand All @@ -62,9 +62,9 @@ docker run -p 8000:8000 -e OPENAI_API_KEY=$OPENAI_API_KEY nemoguardrails

This will start the NeMo Guardrails server with the example configurations. The Chat UI will be accessible at `http://localhost:8000`.

NOTE: Since the example configurations use the OpenAI `test-davinci-003` models, you need to provide an `OPENAI_API_KEY`.
NOTE: Since the example configurations use OpenAI models (such as `gpt-3.5-turbo-instruct` and `gpt-4`), you need to provide an `OPENAI_API_KEY`.

To specify your own config folder for the server, you can have to mount your local configuration into the `/config` path into the container:
To specify your own config folder for the server, you have to mount your local configuration into the `/config` path into the container:

```bash
docker run \
Expand Down