cloudflare / cloudflare/boringtun

Build issue - Instructions seem incorect

Open
#239 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
7.2k
Forks
532
PR merge metrics
No merged PRs in 30d

Description

Hello Everyone,

when building boringtun based on the READMEI get the following error

Executable: cargo build --bin boringtun --release [--target $(TARGET_TRIPLE)]
specifically using this
cargo build --bin boringtun --release

I get the following error
error: no bin target named `boringtun'

looking at the Azure CI pipeline it looks like the command is actualy
cargo build --bin boringtun-cli --release

That seems to work, not sure if the main README needs to be updated?

Thanks,
Greg

Contributor guide

Open the contributing guide

Research direction

Compare the README build command with the working cargo build --bin boringtun-cli --release command and the Azure CI pipeline. Update the README instruction to use the valid binary target, then verify the documented command builds successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
build-system, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
40/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.