Skip to content

docs: add libasound2-dev Linux prerequisite for Tauri build (fixes #872)#935

Open
andreolf wants to merge 1 commit into
jamiepine:mainfrom
andreolf:fix/linux-alsa-prereq
Open

docs: add libasound2-dev Linux prerequisite for Tauri build (fixes #872)#935
andreolf wants to merge 1 commit into
jamiepine:mainfrom
andreolf:fix/linux-alsa-prereq

Conversation

@andreolf

@andreolf andreolf commented Jul 21, 2026

Copy link
Copy Markdown

Summary

Closes #872.

  • Add a dedicated troubleshooting accordion in docs/content/docs/developer/setup.mdx for the alsa-sys / libasound not found build error on Ubuntu/Debian and Fedora/RHEL
  • Add a one-liner note in README.md next to the Tauri Prerequisites link so Linux contributors hit the hint before they hit the error

Root cause

just setup triggers a Rust build that includes the alsa-sys crate. That crate requires the ALSA development headers (libasound2-dev on Debian/Ubuntu, alsa-lib-devel on Fedora/RHEL), which are not installed by default. The existing docs link to https://v2.tauri.app/start/prerequisites/ but that page doesn't surface the ALSA dep prominently enough to prevent the error.

Test plan

  • Verified the apt-get install command resolves the alsa.pc / alsa-sys build failure on a fresh Ubuntu 22.04 container
  • Doc changes render correctly in the MDX accordion structure used by the docs site

Summary by CodeRabbit

  • Documentation
    • Added Ubuntu/Debian setup guidance for installing libasound2-dev before running project setup.
    • Added Linux troubleshooting instructions for missing ALSA development headers, including Fedora/RHEL guidance.
    • Clarified general Tauri build troubleshooting steps.

…miepine#872)

The alsa-sys crate requires ALSA development headers which are not
installed by default on Ubuntu/Debian. Users hit an opaque build error
with no hint in the docs. Add a dedicated troubleshooting accordion in
setup.mdx and a one-liner note in the README prerequisites section.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 791f9755-f59d-4558-b027-72c9b453dc54

📥 Commits

Reviewing files that changed from the base of the PR and between 52f8d8d and 82757ca.

📒 Files selected for processing (2)
  • README.md
  • docs/content/docs/developer/setup.mdx

📝 Walkthrough

Walkthrough

Updated setup documentation to identify ALSA development packages required on Linux and added troubleshooting guidance for alsa-sys build failures.

Changes

Linux ALSA setup documentation

Layer / File(s) Summary
ALSA prerequisites and troubleshooting
README.md, docs/content/docs/developer/setup.mdx
Quick Start now includes the Ubuntu/Debian libasound2-dev prerequisite. Troubleshooting adds Linux-specific instructions for Ubuntu/Debian and Fedora/RHEL, while the general Tauri build guidance is renamed and retained.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

Suggested reviewers: jamiepine

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the main doc change: adding the Linux libasound2-dev prerequisite for Tauri builds.
Linked Issues check ✅ Passed The docs add the missing ALSA/Linux dependency guidance, including libasound2-dev for Ubuntu, which addresses #872.
Out of Scope Changes check ✅ Passed The changes stay focused on documenting the missing Linux prerequisite and related troubleshooting guidance.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing libasound2-dev in Linux prerequisites

1 participant