This is a work in process project. The goal is to be able to bundle up Scala software built with SBT for native packaging systems, like deb, rpm, homebrew, msi.
- Discussion/Questions:
If you wish to ask questions about the native packager, we're very active on Stack Overflow. You can either use the
sbt
tag or thesbt-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. - 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.
Add the following to your project/plugins.sbt
file:
// for sbt 0.12.x and scala 2.9.x
addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "0.7.5-RC2")
// for sbt 0.13.x and scala 2.10.x
addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "0.8.0-M1")
For the native packager keys add this to your build.sbt
import NativePackagerKeys._
Native packager now provides experimental systemd
startup scripts.
Currently it works on Fedora Fedora release 20 (Heisenbug)
and doesn't work on Ubuntu because of partial systemd
support in Ubuntu 14.04 LTS
.
To enable this feature follow My First Packaged Server Project guide and use Systemd
as server loader:
import com.typesafe.sbt.packager.archetypes.ServerLoader.Systemd
serverLoading in Rpm := Systemd
Any help on testing and improving this feature is appreciated so feel free to report bugs or making PR.
Native packager now provides experimental Docker
images.
To enable this feature follow My First Packaged Server Project guide and use one of the provided Docker tasks for generating images.
The only essential extra setting for creating a local image for testing is:
maintainer in Docker := "John Smith <john.smith@example.com>"
To publish the image, dockerRepository
should also be set.
As with the systemd
support, help with testing and improvements is appreciated.
If don't run a linux or mac system with dpkg
installed, you can configure the
debian packaging be done by jdeb. To enable this just set another packaging
implementation in your build.sbt
packageBin in Debian <<= debianJDebPackaging in Debian
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.