Skip to content

docs(README): document the usage of --chrome-binary #107

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
stanislaw merged 1 commit into from
Sep 13, 2026
Merged

docs(README): document the usage of --chrome-binary #107

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
24 changes: 24 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,30 @@ python -m html2pdf4doc.main get_driver --disable-ssl-check
python -m html2pdf4doc.main print --disable-ssl-check input.html output.pdf
```

### Pin a specific Chrome binary

Pin a specific Chrome/Chromium binary with `--chrome-binary`, for example to
use Chrome for Testing or a binary in a non-standard location. Without this
flag, `html2pdf4doc` auto-detects the Chrome/Chromium binary on the machine.

```bash
python -m html2pdf4doc.main get_driver --chrome-binary /path/to/chrome
python -m html2pdf4doc.main print --chrome-binary /path/to/chrome input.html output.pdf
```

Set the `HTML2PDF4DOC_CHROME_BINARY` environment variable instead of the
flag, for example in CI or Docker environments:

```bash
export HTML2PDF4DOC_CHROME_BINARY=/path/to/chrome
python -m html2pdf4doc.main print input.html output.pdf
```

`html2pdf4doc` resolves the Chrome binary in this order:
- `--chrome-binary`
- `HTML2PDF4DOC_CHROME_BINARY`
- auto-detection.

## Developer guide

### Getting started
Expand Down