How do I build a static Rust binary with musl?

Use the Docker image with 'docker run -v $(pwd):/home/rust/src ekidd/rust-musl-builder cargo build --release'. It handles static linking for libraries like OpenSSL and libpq automatically.

rust-musl-builder vs cross: which is better?

rust-musl-builder is specialized for OpenSSL and diesel dependencies, but cross supports more platforms and is actively maintained. For modern projects without OpenSSL, cross is often preferred.

Does rust-musl-builder work with rustls?

No, it's optimized for OpenSSL. The README recommends switching to rustls and using cross for compilation, as rustls is now well-supported in the Rust ecosystem.

How to cache builds to speed up rust-musl-builder?

Mount volumes for .cargo/git, .cargo/registry, and target, then run 'sudo chown -R rust:rust' on them, as detailed in the caching section. This avoids re-downloading dependencies.

Setting up diesel with PostgreSQL in rust-musl-builder?

Add diesel with postgres features to Cargo.toml, include openssl, and order extern crate statements in main.rs to prevent linker errors, following the specific instructions in the README.

Is rust-musl-builder still maintained or updated?

The README indicates it's not actively maintained, with updates rare since rustls reduced the need for OpenSSL. Consider alternatives like cross for current projects.

Open-Awesome

rust-musl-builder

Apache-2.0Dockerfile

Docker images for compiling static Rust binaries using musl-libc, with static C libraries for openssl, diesel, and sqlx.

GitHub

1.6k stars192 forks0 contributors

What is rust-musl-builder?

rust-musl-builder is a set of Docker images that facilitate building static Rust binaries using musl-libc. It solves the problem of creating portable, dependency-free executables by pre-configuring static C libraries like OpenSSL and libpq, which are commonly needed by Rust crates such as diesel and sqlx.

Target Audience

Rust developers who need to deploy applications as single static binaries, particularly those using database drivers or TLS libraries that rely on native C dependencies.

Value Proposition

It simplifies the toolchain setup for static compilation, provides tested configurations for popular Rust crates, and integrates seamlessly with Docker-based build pipelines, reducing the friction of producing distributable Rust applications.

Overview

Docker images for compiling static Rust binaries using musl-libc and musl-gcc, with static versions of useful C libraries. Supports openssl and diesel crates.

Use Cases

Best For

Building Rust web servers that require OpenSSL for HTTPS
Creating CLI tools that must run on any Linux distribution without dependencies
Deploying Rust applications in minimal Alpine Linux containers
Automating static binary builds in CI/CD pipelines like Travis CI
Developing with diesel ORM for PostgreSQL or SQLite databases
Cross-compiling Rust projects for embedded or restricted environments

Not Ideal For

Projects using rustls for TLS instead of OpenSSL, as the image is optimized for legacy OpenSSL dependencies
Teams requiring extensive cross-compilation for architectures beyond x86_64 and basic armv7
Applications prioritizing minimal Docker image sizes without the overhead of pre-installed C libraries
Developers seeking actively maintained tools, as the README labels this project 'effectively dead'

Pros & Cons

Pros

Pre-configured Static Libraries

Includes static versions of OpenSSL, libpq, libz, and SQLite3, configured to work out of the box with popular Rust crates like diesel and sqlx, reducing linking headaches.

CI/CD Pipeline Ready

Designed for integration with Travis CI and GitHub releases, with examples for automating static binary builds and deploying to Alpine Linux containers.

Extras for Enhanced Workflows

Bundles tools like mdbook, cargo about, cargo deb, and cargo deny, aiding in documentation, licensing, packaging, and security checks.

Simplified Static Compilation

Abstracts the complexity of musl-libc setup, providing a Docker environment that just works for creating dependency-free executables.

Cons

Effectively Deprecated

The README openly states the project is 'effectively dead' due to the decreasing need for OpenSSL, making it a legacy choice for new projects.

Limited Cross-Platform Support

Only supports x86_64 and basic armv7 targets, lacking the broader architecture support found in alternatives like cross.

Caching Requires Manual Setup

Efficient build caching necessitates extra Docker volume mounts and permission fixes, adding complexity compared to turnkey solutions.

Frequently Asked Questions

Related Projects

komodo

🦎 a tool to build and deploy software on many servers 🦎

Stars11,712

Forks356

Last commit11 hours ago

cargo-chef

A cargo-subcommand to speed up Rust Docker builds using Docker layer caching.

Stars2,664

Forks143

Last commit3 months ago

release-plz

Publish Rust crates from CI with a Release PR.

Stars1,431

Forks179

Last commit14 hours ago

rust-musl-cross

Docker images for compiling static Rust binaries using musl-cross

Stars748

Forks80

Last commit16 days ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub