DEV Community

Murad Bayoun
Murad Bayoun

Posted on • Edited on

Comprehensive Guide to Generating `.deb` and `.rpm` Packages for Rust Applications

#rust #debian #redhat #packaging

Rust Software Packaging

Welcome to this comprehensive guide on packaging your Rust applications into .deb and .rpm packages! Whether you're distributing your application to Debian/Ubuntu or Fedora/Red Hat users, this guide will walk you through the process step-by-step. By the end, you'll be able to create professional, installable packages for your Rust apps.

Table of Contents

  1. Introduction

    • Why Package Your Rust Application?
    • What Are .deb and .rpm Packages?

  2. Prerequisites

    • Rust Toolchain
    • Required Tools for Packaging

  3. Building Your Rust Application

    • Compiling for Release
    • Stripping Binaries (Optional)

  4. Creating a .deb Package

    • Installing cargo-deb
    • Configuring Cargo.toml
    • Building the .deb Package
    • Testing the .deb Package

  5. Creating an .rpm Package

    • Installing cargo-rpm
    • Configuring Cargo.toml
    • Building the .rpm Package
    • Testing the .rpm Package

  6. Advanced Topics

    • Adding Dependencies
    • Including Systemd Services
    • Customizing Package Metadata

  7. Conclusion

    • Best Practices
    • Further Reading

1. Introduction

Why Package Your Rust Application?

Packaging your Rust application makes it easier for users to install and manage your software. It ensures compatibility with the system's package manager, simplifies updates, and provides a seamless installation experience.

What Are .deb and .rpm Packages?

  • .deb: Used by Debian-based distributions like Ubuntu.
  • .rpm: Used by Red Hat-based distributions like Fedora and CentOS.

Both formats contain the application binaries, metadata, and installation scripts.

2. Prerequisites

Before we start, ensure you have the following:

Rust Toolchain

  • Install Rust using rustup: 
  curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
Enter fullscreen mode Exit fullscreen mode
  • Verify installation: 
  rustc --version
  cargo --version
Enter fullscreen mode Exit fullscreen mode

Required Tools for Packaging

  • For .deb:
    • cargo-deb: A Cargo subcommand to create .deb packages.
    • dpkg: To test the generated .deb package. 
  cargo install cargo-deb
  sudo apt install dpkg
Enter fullscreen mode Exit fullscreen mode
  • For .rpm:
    • cargo-rpm: A Cargo subcommand to create .rpm packages.
    • rpm: To test the generated .rpm package. 
  cargo install cargo-rpm
  sudo dnf install rpm
Enter fullscreen mode Exit fullscreen mode

3. Building Your Rust Application

Compiling for Release

Ensure your application is compiled in release mode for optimal performance:

cargo build --release
Enter fullscreen mode Exit fullscreen mode

Stripping Binaries (Optional)

To reduce the size of your binary:

strip target/release/your_app_name
Enter fullscreen mode Exit fullscreen mode

4. Creating a .deb Package

Installing cargo-deb

If you haven't already:

cargo install cargo-deb
Enter fullscreen mode Exit fullscreen mode

Configuring Cargo.toml

Add the following section to your Cargo.toml:

[package.metadata.deb]
maintainer = "Your Name <your.email@example.com>"
copyright = "2023, Your Name"
license-file = ["LICENSE"]
assets = [
    ["target/release/your_app_name", "usr/bin/", "755"],
]
Enter fullscreen mode Exit fullscreen mode

Building the .deb Package

Run the following command:

cargo deb
Enter fullscreen mode Exit fullscreen mode

This will generate a .deb file in the target/debian/ directory.

Testing the .deb Package

Install the package:

sudo dpkg -i target/debian/your_app_name_0.1.0_amd64.deb
Enter fullscreen mode Exit fullscreen mode

Verify installation:

your_app_name --version
Enter fullscreen mode Exit fullscreen mode

5. Creating an .rpm Package

Installing cargo-rpm

If you haven't already:

cargo install cargo-rpm
Enter fullscreen mode Exit fullscreen mode

Configuring Cargo.toml

Add the following section to your Cargo.toml:

[package.metadata.rpm]
license = "MIT"
requires = ["libc"]
assets = [
    ["target/release/your_app_name", "/usr/bin/your_app_name", "755"],
]
Enter fullscreen mode Exit fullscreen mode

Building the .rpm Package

Run the following command:

cargo rpm build
Enter fullscreen mode Exit fullscreen mode

This will generate an .rpm file in the target/release/rpmbuild/RPMS/x86_64/ directory.

Testing the .rpm Package

Install the package:

sudo rpm -ivh target/release/rpmbuild/RPMS/x86_64/your_app_name-0.1.0-1.x86_64.rpm
Enter fullscreen mode Exit fullscreen mode

Verify installation:

your_app_name --version
Enter fullscreen mode Exit fullscreen mode

6. Advanced Topics

Adding Dependencies

Specify dependencies in your Cargo.toml:

[package.metadata.deb]
depends = "libc6 (>= 2.28), zlib1g"

[package.metadata.rpm]
requires = "libc >= 2.28, zlib"
Enter fullscreen mode Exit fullscreen mode

Including Systemd Services

For .deb:

[package.metadata.deb]
systemd-units = [
    ["your_app_name.service", "lib/systemd/system/your_app_name.service", "644"],
]
Enter fullscreen mode Exit fullscreen mode

For .rpm:

[package.metadata.rpm]
systemd-units = [
    ["your_app_name.service", "/usr/lib/systemd/system/your_app_name.service", "644"],
]
Enter fullscreen mode Exit fullscreen mode

Customizing Package Metadata

You can customize metadata like description, version, and more in the Cargo.toml file.

7. Conclusion

Best Practices

  • Test your packages on clean systems.
  • Keep your Cargo.toml metadata up-to-date.
  • Use CI/CD pipelines to automate packaging.

Further Reading

Congratulations! You now know how to package your Rust applications into .deb and .rpm formats.

Top comments (1)

Collapse
 
troelsarvin profile image
Troels Arvin •

cargo-rpm is end-of-life (since 2022). As it states on its Github readme, one should reach for cargo-generate-rpm instead.