sbt-native-packager
API
Generated with
sbt-native-packager/com.typesafe.sbt/com.typesafe.sbt.packager/com.typesafe.sbt.packager.docker/DockerPlugin

DockerPlugin

com.typesafe.sbt.packager.docker.DockerPlugin
object DockerPlugin extends AutoPlugin

==Docker Plugin==

This plugin helps you build docker containers.

==Configuration==

In order to configure this plugin take a look at the available com.typesafe.sbt.packager.docker.DockerKeys

==Requirements==

You need docker to have docker installed on your system and be able to execute commands. Check with a single command:

docker version

Future versions of the Docker Plugin may use the REST API, so you don't need docker installed locally.

Attributes

Note

this plugin is not intended to build very customizable docker images, but turn your mappings configuration in a docker image with almost no ''any'' configuration.

Example

Enable the plugin in the build.sbt

  enablePlugins(DockerPlugin)
Graph
Supertypes
class AutoPlugin
trait PluginsFunctions
class Basic
trait Plugins
class Object
trait Matchable
class Any
Show all
Self type

Members list

Type members

Classlikes

object autoImport

Attributes

Supertypes
trait DockerKeys
class Object
trait Matchable
class Any
Self type
autoImport.type

Value members

Concrete methods

def mapGenericFilesToDocker: Seq[Setting[_]]

uses the Universal / mappings to generate the Docker / mappings.

uses the Universal / mappings to generate the Docker / mappings.

Attributes

override def projectConfigurations: Seq[Configuration]

The Configurations to add to each project that activates this AutoPlugin.

The Configurations to add to each project that activates this AutoPlugin.

Attributes

Definition Classes
AutoPlugin
def publishDocker(context: File, execCommand: Seq[String], tag: String, log: Logger, multiplatform: Boolean): Unit
def publishLocalDocker(context: File, buildCommand: Seq[String], execCommand: Seq[String], envVars: Map[String, String], strategy: DockerPermissionStrategy, removeIntermediateImages: Boolean, buildkitEnabled: Boolean, log: Logger): Unit
override def requires: Plugins

This AutoPlugin requires the plugins the Plugins matcher returned by this method. See trigger.

This AutoPlugin requires the plugins the Plugins matcher returned by this method. See trigger.

Attributes

Definition Classes
AutoPlugin
def rmiDocker(execCommand: Seq[String], tag: String, log: Logger): Unit

Inherited methods

def &&(o: Basic): Plugins

Attributes

Inherited from:
Basic
def allRequirements: PluginTrigger

This plugin is activated when all required plugins are present.

This plugin is activated when all required plugins are present.

Attributes

Inherited from:
PluginsFunctions
def buildSettings: Seq[Setting[_]]

The Setting to add to the build scope for each project that activates this AutoPlugin. The settings returned here are guaranteed to be added to a given build scope only once regardless of how many projects for that build activate this AutoPlugin.

The Setting to add to the build scope for each project that activates this AutoPlugin. The settings returned here are guaranteed to be added to a given build scope only once regardless of how many projects for that build activate this AutoPlugin.

Attributes

Inherited from:
AutoPlugin
def derivedProjects(proj: ProjectDefinition[_]): Seq[Project]

The Projects to add to the current build based on an existing project.

The Projects to add to the current build based on an existing project.

Attributes

Inherited from:
AutoPlugin
def empty: Plugins

Plugins instance that doesn't require any Pluginss.

Plugins instance that doesn't require any Pluginss.

Attributes

Inherited from:
PluginsFunctions
def extraProjects: Seq[Project]

The Projects to add to the current build.

The Projects to add to the current build.

Attributes

Inherited from:
AutoPlugin
def noTrigger: PluginTrigger

This plugin is activated only when it is manually activated.

This plugin is activated only when it is manually activated.

Attributes

Inherited from:
PluginsFunctions
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
AutoPlugin -> Any
Inherited from:
AutoPlugin
def trigger: PluginTrigger

Determines whether this AutoPlugin will be activated for this project when the requires clause is satisfied.

Determines whether this AutoPlugin will be activated for this project when the requires clause is satisfied.

When this method returns allRequirements, and requires method returns Web && Javascript, this plugin instance will be added automatically if the Web and Javascript plugins are enabled.

When this method returns noTrigger, and requires method returns Web && Javascript, this plugin instance will be added only if the build user enables it, but it will automatically add both Web and Javascript.

Attributes

Inherited from:
AutoPlugin

Concrete fields

val UnixSeparatorChar: Char

The separator used by makeCopyLayerIntermediate should be always forced to UNIX separator. The separator doesn't depend on the OS where Dockerfile is being built.

The separator used by makeCopyLayerIntermediate should be always forced to UNIX separator. The separator doesn't depend on the OS where Dockerfile is being built.

Attributes

lazy override val globalSettings: Seq[Setting[_]]

The Settings to add to the global scope exactly once if any project activates this AutoPlugin.

The Settings to add to the global scope exactly once if any project activates this AutoPlugin.

Attributes

lazy override val projectSettings: Seq[Setting[_]]

The Settings to add in the scope of each project that activates this AutoPlugin.

The Settings to add in the scope of each project that activates this AutoPlugin.

Attributes

Inherited fields

val label: String

Attributes

Inherited from:
AutoPlugin
Generated with