Packages

  • package root
    Definition Classes
    root
  • package com
    Definition Classes
    root
  • package typesafe
    Definition Classes
    com
  • package sbt
    Definition Classes
    typesafe
  • package packager
    Definition Classes
    sbt
  • package docker
    Definition Classes
    packager
  • object DockerPlugin extends AutoPlugin

    This plugin helps you build docker containers.

    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.

    Definition Classes
    docker
    Example:

    1. Enable the plugin in the build.sbt

      enablePlugins(DockerPlugin)
    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.

  • autoImport

object autoImport extends DockerKeysEx

Linear Supertypes
DockerKeysEx, DockerKeys, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. autoImport
  2. DockerKeysEx
  3. DockerKeys
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val Docker: sbt.Configuration
  5. val DockerAlias: docker.DockerAlias.type
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. lazy val dockerAdditionalPermissions: TaskKey[Seq[(DockerChmodType, String)]]
    Definition Classes
    DockerKeysEx
    Annotations
    @transient()
  9. val dockerAlias: SettingKey[DockerAlias]
    Definition Classes
    DockerKeys
  10. val dockerAliases: SettingKey[Seq[DockerAlias]]
    Definition Classes
    DockerKeys
  11. val dockerApiVersion: TaskKey[Option[DockerApiVersion]]
    Definition Classes
    DockerKeysEx
    Annotations
    @transient()
  12. val dockerAutoremoveMultiStageIntermediateImages: SettingKey[Boolean]
    Definition Classes
    DockerKeys
  13. val dockerBaseImage: SettingKey[String]
    Definition Classes
    DockerKeys
  14. val dockerBuildCommand: SettingKey[Seq[String]]
    Definition Classes
    DockerKeys
  15. val dockerBuildEnvVars: SettingKey[Map[String, String]]
    Definition Classes
    DockerKeys
  16. val dockerBuildInit: SettingKey[Boolean]
    Definition Classes
    DockerKeysEx
  17. val dockerBuildOptions: SettingKey[Seq[String]]
    Definition Classes
    DockerKeys
  18. val dockerBuildkitEnabled: TaskKey[Boolean]
    Definition Classes
    DockerKeysEx
    Annotations
    @transient()
  19. val dockerBuildxPlatforms: SettingKey[Seq[String]]
    Definition Classes
    DockerKeysEx
  20. lazy val dockerChmodType: SettingKey[DockerChmodType]
    Definition Classes
    DockerKeysEx
  21. val dockerCmd: SettingKey[Seq[String]]
    Definition Classes
    DockerKeys
  22. val dockerCommands: TaskKey[Seq[CmdLike]]
    Definition Classes
    DockerKeys
    Annotations
    @transient()
  23. val dockerEntrypoint: SettingKey[Seq[String]]
    Definition Classes
    DockerKeys
  24. val dockerEnvVars: SettingKey[Map[String, String]]
    Definition Classes
    DockerKeys
  25. val dockerExecCommand: SettingKey[Seq[String]]
    Definition Classes
    DockerKeys
  26. val dockerExposedPorts: SettingKey[Seq[Int]]
    Definition Classes
    DockerKeys
  27. val dockerExposedUdpPorts: SettingKey[Seq[Int]]
    Definition Classes
    DockerKeys
  28. val dockerExposedVolumes: SettingKey[Seq[String]]
    Definition Classes
    DockerKeys
  29. val dockerGenerateConfig: TaskKey[sbt.File]
    Definition Classes
    DockerKeys
    Annotations
    @transient()
  30. val dockerGroupLayers: TaskKey[PartialFunction[(FileRef, String), Int]]
    Definition Classes
    DockerKeysEx
    Annotations
    @transient()
  31. val dockerLabels: SettingKey[Map[String, String]]
    Definition Classes
    DockerKeys
  32. val dockerLayerMappings: TaskKey[Seq[LayeredMapping]]
    Definition Classes
    DockerKeysEx
    Annotations
    @transient()
  33. val dockerPackageMappings: TaskKey[Seq[(FileRef, String)]]
    Definition Classes
    DockerKeys
    Annotations
    @transient()
  34. lazy val dockerPermissionStrategy: SettingKey[DockerPermissionStrategy]
    Definition Classes
    DockerKeysEx
  35. val dockerRepository: SettingKey[Option[String]]
    Definition Classes
    DockerKeys
  36. val dockerRmiCommand: SettingKey[Seq[String]]
    Definition Classes
    DockerKeys
  37. val dockerUpdateLatest: SettingKey[Boolean]
    Definition Classes
    DockerKeys
  38. val dockerUsername: SettingKey[Option[String]]
    Definition Classes
    DockerKeys
  39. val dockerVersion: TaskKey[Option[DockerVersion]]
    Definition Classes
    DockerKeys
    Annotations
    @transient()
  40. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  41. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  42. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  43. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  44. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  45. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  46. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  47. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  48. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  49. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  50. def toString(): String
    Definition Classes
    AnyRef → Any
  51. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  52. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  53. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Deprecated Value Members

  1. val dockerLayerGrouping: SettingKey[(String) ⇒ Option[Int]]
    Definition Classes
    DockerKeysEx
    Annotations
    @deprecated
    Deprecated

    (Since version 1.7.1) Use dockerGroupLayers instead

Inherited from DockerKeysEx

Inherited from DockerKeys

Inherited from AnyRef

Inherited from Any

Ungrouped