This reference documentation offers an in-depth description of the behavior and configuration options of the Paketo Ruby Buildpack. For explanations of how to use the buildpack for several common use-cases, see the Paketo Ruby Buildpack How To documentation.
The Ruby Paketo Buildpack supports several versions of MRI, Bundler, and common Ruby webservers and task runners. For more details on the specific versions supported in a given buildpack version, see the release notes.
The Ruby Buildpack uses Bundler to install and manage
the gems needed to run your application. Including a
Gemfile in your app
source code instructs the
buildpack to vendor your
The Ruby Buildpack supports a number of webservers and task runners that are useful for running Ruby applications. If your application uses one of these tools, it will be automatically detected and a start command for your application will be assigned when building your application container.
The buildpack runs
bundle exec rails assets:precompile for the app, and works
with any of the supported Ruby webservers listed above. The Paketo Ruby
Buildpack pulls in this buildpack, as well as the Paketo Node Engine
Buildpack to support asset compilation.
Per the Ruby How To Guide, the Paketo Ruby
Buildpack supports building apps with vendored gems. Behind the scenes,
the presence of the cache path in the app source code indicates to the
buildpack to run
bundle install with the addition of the
--local flag to
prefer the use of local gems.
The Ruby CNB sets a few environment variables during the
phases of the app lifecycle. The sections below describe each environment
variable and its impact on your app.
The Ruby buildpack supports the full software bill of materials (SBOM) in Syft, CycloneDX, and SPDX formats. The Ruby buildpack also includes limited support for the Paketo-specific SBOM format. This Paketo-specific SBOM format does not include information about the application dependencies.
SBOMs will be generated for applications which leverage Bundler.
Check out the Access the Software Bill of Materials guide for more information about how to retrieve the SBOM for your Ruby app image.
Last modified: July 5, 2022