sbt Native Packager
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.
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.
zip
,tar.gz
, xz
archivesdeb
and rpm
packages for Debian/RHEL based systemsdmg
for macOSmsi
for Windowsdocker
imagesgraalvm
native imagesAdd 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)
If you have enabled one of the archetypes (app or server), you can build your application with
sbt <config-scope>:packageBin
# universal zip
sbt universal:packageBin
# debian package
sbt debian:packageBin
# rpm package
sbt rpm:packageBin
# docker image
sbt docker:publishLocal
# graalvm image
sbt graalvm-native-image:packageBin
Read more in the specific format documentation on how to configure and build your package.
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.
Please read the contributing.md on how to build and test native-packager.
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-docker
provides more customization abilities, while the DockerPlugin
in this project integrates more directly with predefined archetypes.