SBT Native Packager

Goal

SBT native packager lets you build application packages in native formats. It offers different archetypes for common configurations, such as simple Java apps or server applications.

Issues/Discussions

• Discussion/Questions: If you wish to ask questions about the native packager we're active on Stack Overflow. You can either use the sbt tag or the sbt-native-packager tag. They also have far better search support for working around issues.

• Docs: Our docs are available online. If you'd like to help improve the docs, they're part of this repository in the src/sphinx directory. ScalaDocs are also available.

  The old documentation can be found here

• Issues/Feature Requests: Finally, any bugs or features you find you need, please report to our issue tracker. Please check the compatibility matrix to see if your system is able to produce the packages you want.

Features

• Build native packages for different systems
  • Universal zip,tar.gz, xz archives
  • deb and rpm packages for Debian/RHEL based systems
  • dmg for macOS
  • msi for Windows
  • docker images
  • graalvm native images
• Provide archetypes for common use cases
  • Java application with start scripts for Linux, macOS and Windows
  • Java server application adds support for service managers:s
    • Systemd
    • Systemv
    • Upstart
• Java8 jdkpackager wrapper
• Java11 jlink wrapper
• Optional JDeb integration for cross-platform Debian builds
• Optional Spotify docker client integration

Installation

Add the following to your project/plugins.sbt file:

// for autoplugins
addSbtPlugin("com.github.sbt" % "sbt-native-packager" % "<version>")

In your build.sbt enable the plugin you want. For example the JavaAppPackaging.

enablePlugins(JavaAppPackaging)

Or if you need a server with autostart support

enablePlugins(JavaServerAppPackaging)

Build

If you have enabled one of the archetypes (app or server), you can build your application with

sbt <config-scope>/packageBin

Examples

# universal zip
sbt Universal/packageBin

# debian package
sbt Debian/packageBin

# rpm package
sbt Rpm/packageBin

# docker image
sbt Docker/publishLocal

# graalvm image
sbt GraalVMNativeImage/packageBin

Read more in the specific format documentation on how to configure and build your package.

Documentation

There's a complete "getting started" guide and more detailed topics available at the sbt-native-packager site.

Please feel free to contribute documentation, or raise issues where you feel it may be lacking.

Contributing

Please read the contributing.md on how to build and test native-packager.

Related SBT Plugins

These are a list of plugins that either use sbt-native-packager, provide additional features or provide a richer API for a single packaging format.

• sbt-aether
• sbt-assembly
• sbt-docker
  • This is in addition to the built-in Docker Plugin from sbt-native. Both generate docker images. sbt-docker provides more customization abilities, while the DockerPlugin in this project integrates more directly with predefined archetypes.
• sbt-kubeyml
• sbt-packager
• sbt-package-courier

Maintainers

• Nepomuk Seiler (@muuki88)
• Alexey Kardapoltsev (@kardapoltsev)
• Derek Wickern (@dwickern)
• Felix Satyaputra (@fsat)

Credits

• Josh Suereth for the initial development
• Sascha Rinaldi for the native-packager logo