Skip to content

fix: use supported wkhtmltox packages for Linux setup #4277

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
zay168 wants to merge 2 commits into
base: develop
Choose a base branch
from
+20 −2
Open

fix: use supported wkhtmltox packages for Linux setup #4277

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
03c3d23
fix: use supported wkhtmltox packages for Linux setup
zay168 Mar 27, 2026
7063d12
fix: preserve wkhtmltox fallback on install failure
zay168 Mar 27, 2026
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
17 changes: 17 additions & 0 deletions .github/helper/install.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,23 @@ mariadb --host 127.0.0.1 --port 3306 -u root -proot -e "GRANT ALL PRIVILEGES ON
mariadb --host 127.0.0.1 --port 3306 -u root -proot -e "FLUSH PRIVILEGES"

install_whktml() {
local arch os_like wkhtml_package

arch="$(dpkg --print-architecture)"
os_like="$(. /etc/os-release && printf '%s %s' "$ID" "$ID_LIKE")"

if echo "$os_like" | grep -Eq '(^| )ubuntu( |$)'; then
wkhtml_package="wkhtmltox_0.12.6.1-3.jammy_${arch}.deb"
elif echo "$os_like" | grep -Eq '(^| )debian( |$)'; then
wkhtml_package="wkhtmltox_0.12.6.1-3.bookworm_${arch}.deb"
fi

if [ -n "$wkhtml_package" ]; then
wget -O "/tmp/${wkhtml_package}" "https://github.com/wkhtmltopdf/packaging/releases/download/0.12.6.1-3/${wkhtml_package}"
sudo apt install -y xvfb xfonts-75dpi xfonts-base "/tmp/${wkhtml_package}"
return
fi

wget -O /tmp/wkhtmltox.tar.xz https://github.com/frappe/wkhtmltopdf/raw/master/wkhtmltox-0.12.3_linux-generic-amd64.tar.xz
tar -xf /tmp/wkhtmltox.tar.xz -C /tmp
sudo mv /tmp/wkhtmltox/bin/wkhtmltopdf /usr/local/bin/wkhtmltopdf
Expand Down
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,10 +92,11 @@ Use the following credentials to log in:

### Local

1. Set up bench by following the [Installation Steps](https://frappeframework.com/docs/user/en/installation) and start the server and keep it running
1. Set up bench by following the [Installation Steps](https://docs.frappe.io/framework/user/en/installation) and start the server and keep it running
```sh
$ bench start
```
Comment on lines 96 to 98
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Mar 27, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Remove shell prompts in command examples to satisfy markdownlint.

At Line [97], drop the leading $ in the fenced shell block (MD014) to keep docs lint-clean.

🧰 Tools
🪛 markdownlint-cli2 (0.22.0)

[warning] 97-97: Dollar signs used before commands without showing output

(MD014, commands-show-output)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 96 - 98, The fenced shell code block contains a
leading shell prompt character ('$') before the command 'bench start' which
violates markdownlint rule MD014; remove the leading '$' so the block contains
just the raw command (i.e., replace "$ bench start" with "bench start" in the
fenced code block) to satisfy the linter while keeping the command example
intact.

For Debian and Ubuntu derivatives, install the distro-specific `wkhtmltox` package from the official [wkhtmltopdf packaging releases](https://github.com/wkhtmltopdf/packaging/releases/tag/0.12.6.1-3) (`bookworm` for Debian/Parrot, `jammy` for Ubuntu) instead of using the placeholder `wkhtmltox_file.deb` command from the generic downloads page.
2. In a separate terminal window, run the following commands
```sh
$ bench new-site hrms.localhost
Expand Down
Loading