Sftp

Downloads artifacts, files, and signatures from a SFTP server.

Legend:

  • required

  • optional

  • may use environment variable

  • accepts Name Templates

  • YAML

  • TOML

  • JSON

  • Maven

  • Gradle

# 
download:
  # 
  sftp:
    # Downloaders require a name.
    # 
    app:

      # Enables or disables the downloader.
      # Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
      # Defaults to `NEVER`.
      # 
      active: ALWAYS

      # Defines the connection timeout in seconds.
      # Defaults to `20`.
      # 
      connectTimeout: 20

      # Defines the read timeout in seconds.
      # Defaults to `60`.
      # 
      readTimeout: 60

      # Additional properties used when evaluating templates.
      # 
      extraProperties:
        # Key will be capitalized and prefixed with `sftp`, i.e, `sftpFoo`.
        foo: bar

      # Host where the SFTP service is enabled.
      # If left unspecified, the `JRELEASER_SFTP_${name}_HOST`
      # environment variable must be defined.
      #  
      host: downloads.acme.com

      # Port number of SFTP service.
      # If left unspecified, the `JRELEASER_SFTP_${name}_PORT`
      # environment variable must be defined.
      # Defaults to `22`.
      #  
      port: 22

      # The username required for authorization.
      # If left unspecified, the `JRELEASER_SFTP_${name}_USERNAME`
      # environment variable must be defined.
      #  
      username: __DO_NOT_SET_HERE__

      # Password for login into the SFTP service.
      # If left unspecified, the `JRELEASER_SFTP_${name}_PASSWORD`
      # environment variable must be defined.
      #  
      password: __DO_NOT_SET_HERE__

      # The public SSH key.
      # If left unspecified, the `JRELEASER_SFTP_${name}_PUBLIC_KEY`
      # environment variable must be defined.
      #  
      publicKey: __DO_NOT_SET_HERE__

      # The private SSH key.
      # If left unspecified, the `JRELEASER_SFTP_${name}_PRIVATE_KEY`
      # environment variable must be defined.
      #  
      privateKey: __DO_NOT_SET_HERE__

      # The passphrase required to read private keys.
      # If left unspecified, the `JRELEASER_SFTP_${name}_PASSPHRASE`
      # environment variable must be defined.
      #  
      passphrase: __DO_NOT_SET_HERE__

      # The remote server's SSH fingerprint.
      # If left unspecified, the `JRELEASER_SFTP_${name}_FINGERPRINT`
      # environment variable must be defined.
      #  
      fingerprint: __DO_NOT_SET_HERE__

      # A list of assets to be downloaded.
      # 
      assets:
          # Full download path to asset.
          #  
        - input: '/logos/logo-256x256.png'

          # Local path where asset will be downloaded to.
          # Defaults to `${jreleaser.downloadDirectory}/${downloader.name}`.
          #  
          output: '{{projectName}}.png'

          # Unpack options
          # 
          unpack:
            # Unpack input archive when `true`.
            # Defaults to `false`.
            # 
            enabled: false

            # Skip the archive's root entry from the unpacked directory when `true`.
            # Defaults to `false`.
            # 
            skipRootEntry: false
# Downloaders require a name.
# 
[download.sftp.app]

  # Enables or disables the downloader.
  # Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
  # Defaults to `NEVER`.
  # 
  active = "ALWAYS"

  # Defines the connection timeout in seconds.
  # Defaults to `20`.
  # 
  connectTimeout = 20

  # Defines the read timeout in seconds.
  # Defaults to `60`.
  # 
  readTimeout = 60

  # Additional properties used when evaluating templates.
  # 
  extraProperties.foo = "bar"
  # Key will be capitalized and prefixed with `sftp`, i.e, `sftpFoo`.

  # Host where the SFTP service is enabled.
  # If left unspecified, the `JRELEASER_SFTP_${name}_HOST`
  # environment variable must be defined.
  #  
  host = "downloads.acme.com"

  # Port number of SFTP service.
  # If left unspecified, the `JRELEASER_SFTP_${name}_PORT`
  # environment variable must be defined.
  # Defaults to `port`.
  #  
  port = 22

  # The username required for authorization.
  # If left unspecified, the `JRELEASER_SFTP_${name}_USERNAME`
  # environment variable must be defined.
  #  
  username = "__DO_NOT_SET_HERE__"

  # Password for login into the SFTP service..
  # If left unspecified, the `JRELEASER_SFTP_${name}_PASSWORD`
  # environment variable must be defined.
  #  
  password = "__DO_NOT_SET_HERE__"

  # The public SSH key.
  # If left unspecified, the `JRELEASER_SFTP_${name}_PUBLIC_KEY`
  # environment variable must be defined.
  #  
  publicKey = "__DO_NOT_SET_HERE__"

  # The private SSH key.
  # If left unspecified, the `JRELEASER_SFTP_${name}_PRIVATE_KEY`
  # environment variable must be defined.
  #  
  privateKey = "__DO_NOT_SET_HERE__"

  # The passphrase required to read private keys.
  # If left unspecified, the `JRELEASER_SFTP_${name}_PASSPHRASE`
  # environment variable must be defined.
  #  
  passphrase = "__DO_NOT_SET_HERE__"

  # The remote server's SSH fingerprint.
  # If left unspecified, the `JRELEASER_SFTP_${name}_FINGERPRINT`
  # environment variable must be defined.
  #  
  fingerprint = "__DO_NOT_SET_HERE__"

  # A list of assets to be downloaded.
  # 
  [[dowload.sftp.app.assets]]
    # Full download path to asset.
    #  
    input = "/logos/logo-256x256.png"

    # Local path where asset will be downloaded to.
    # Defaults to `${jreleaser.downloadDirectory}/${downloader.name}`.
    #  
    output = "{{projectName}}.png"

    # Unpack input archive when `true`.
    # Defaults to `false`.
    # 
    unpack.enabled: false

    # Skip the archive's root entry from the unpacked directory when `true`.
    # Defaults to `false`.
    # 
    unpack.skipRootEntry: false
{
  // 
  "download": {
    // 
    "sftp": {
      // Downloaders require a name.
      // 
      "app": {

        // Enables or disables the downloader.
        // Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
        // Defaults to `NEVER`.
        // 
        "active": "ALWAYS",

        // Defines the connection timeout in seconds.
        // Defaults to `20`.
        // 
        "connectTimeout": 20,

        // Defines the read timeout in seconds.
        // Defaults to `60`.
        // 
        "readTimeout": 60,

        // Additional properties used when evaluating templates.
        // 
        "extraProperties": {
          // Key will be capitalized and prefixed with `sftp`, i.e, `sftpFoo`.
          "foo": "bar"
        },

        // Host where the SFTP service is enabled.
        // If left unspecified, the `JRELEASER_SFTP_${name}_HOST`
        // environment variable must be defined.
        //  
        "host": "downloads.acme.com",

        // Port number of SFTP service.
        // If left unspecified, the `JRELEASER_SFTP_${name}_PORT`
        // environment variable must be defined.
        // Defaults to `22`.
        //  
        "port": 22,

        // The username required for authorization.
        // If left unspecified, the `JRELEASER_SFTP_${name}_USERNAME`
        // environment variable must be defined.
        //  
        "username": "__DO_NOT_SET_HERE__",

        // Password for login into the SFTP service.
        // If left unspecified, the `JRELEASER_SFTP_${name}_PASSWORD`
        // environment variable must be defined.
        //  
        "password": "__DO_NOT_SET_HERE__",

        // The public SSH key.
        // If left unspecified, the `JRELEASER_SFTP_${name}_PUBLIC_KEY`
        // environment variable must be defined.
        //  
        "publicKey": "__DO_NOT_SET_HERE__",

        // The private SSH key.
        // If left unspecified, the `JRELEASER_SFTP_${name}_PRIVATE_KEY`
        // environment variable must be defined.
        //  
        "privateKey": "__DO_NOT_SET_HERE__",

        // The passphrase required to read private keys.
        // If left unspecified, the `JRELEASER_SFTP_${name}_PASSPHRASE`
        // environment variable must be defined.
        //  
        "passphrase": "__DO_NOT_SET_HERE__",

        // The remote server's SSH fingerprint.
        // If left unspecified, the `JRELEASER_SFTP_${name}_FINGERPRINT`
        // environment variable must be defined.
        //  
        "fingerprint": "__DO_NOT_SET_HERE__",

        // A list of assets to be downloaded.
        // 
        "assets": [
          {
            // Full download path to asset.
            //  
            "input": "/logos/logo-256x256.png",

            // Local path where asset will be downloaded to.
            // Defaults to `${jreleaser.downloadDirectory}/${downloader.name}`.
            //  
            "output": "{{projectName}}.png",

            // Unpack options
            // 
            "unpack": {
              // Unpack input archive when `true`.
              // Defaults to `false`.
              // 
              "enabled": false,

              // Skip the archive's root entry from the unpacked directory when `true`.
              // Defaults to `false`.
              // 
              "skipRootEntry": false
            }
          }
        ]
      }
    }
  }
}
<jreleaser>
  <!--
    
  -->
  <download>
    <!--
      
    -->
    <sftp>
      <!--
        Downloaders require a name.
        
      -->
      <app>
        <!--
          Enables or disables the distribution.
          Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
          Defaults to `NEVER`.
          
        -->
        <active>ALWAYS</active>

        <!--
          Defines the connection timeout in seconds.
          Defaults to `20`.
          
        -->
        <connectTimeout>20</connectTimeout>

        <!--
          Defines the read timeout in seconds.
          Defaults to `60`.
          
        -->
        <readTimeout>60</readTimeout>

        <!--
          Additional properties used when evaluating templates.
          
        -->
        <extraProperties>
          <!--
            Key will be capitalized and prefixed with `sftp`, i.e, `sftpFoo`.
          -->
          <foo>bar</foo>
        </extraProperties>

        <!--
          Host where the SFTP service is enabled.
          If left unspecified, the `JRELEASER_SFTP_${name}_HOST`
          environment variable must be defined.
           
        -->
        <host>downloads.acme.com</host>

        <!--
          Port number of SFTP service.
          If left unspecified, the `JRELEASER_SFTP_${name}_PORT`
          environment variable must be defined.
          Defaults to `22`.
           
        -->
        <port>22</port>

        <!--
          The username required for authorization.
          If left unspecified, the `JRELEASER_SFTP_${name}_USERNAME`
          environment variable must be defined.
           
        -->
        <username>__DO_NOT_SET_HERE__</username>

        <!--
          Password for login into the SFTP service.
          If left unspecified, the `JRELEASER_SFTP_${name}_PASSWORD`
          environment variable must be defined.
           
        -->
        <password>__DO_NOT_SET_HERE__</password>

        <!--
          The public SSH key.
          If left unspecified, the `JRELEASER_SFTP_${name}_PUBLIC_KEY`
          environment variable must be defined.
           
        -->
        <publicKey>__DO_NOT_SET_HERE__</publicKey>

        <!--
          The private SSH key.
          If left unspecified, the `JRELEASER_SFTP_${name}_PRIVATE_KEY`
          environment variable must be defined.
           
        -->
        <privateKey>__DO_NOT_SET_HERE__</privateKey>

        <!--
          The passphrase required to read private keys.
          If left unspecified, the `JRELEASER_SFTP_${name}_PASSPHRASE`
          environment variable must be defined.
           
        -->
        <passphrase>__DO_NOT_SET_HERE__</passphrase>

        <!--
          The remote server's SSH fingerprint.
          If left unspecified, the `JRELEASER_SFTP_${name}_FINGERPRINT`
          environment variable must be defined.
           
        -->
        <fingerprint>__DO_NOT_SET_HERE__</fingerprint>

        <!--
          A list of assets to be downloaded.
          
        -->
        <assets>
          <asset>
            <!--
              Full download path to asset.
               
            -->
            <input>/logos/logo-256x256.png</input>

            <!--
              Local path where asset will be downloaded to.
              Defaults to `${jreleaser.downloadDirectory}/${downloader.name}`.
               
            -->
            <output>{{projectName}}.png</output>

            <!--
              Unpack options
              
            -->
            <unpack>
              <!--
                Unpack input archive when `true`.
                Defaults to `false`.
                
              -->
              <enabled>false</enabled>

              <!--
                Skip the archive's root entry from the unpacked directory when `true`.
                Defaults to `false`.
                
              -->
              <skipRootEntry>false</skipRootEntry>
            </unpack>
          </asset>
        </assets>
      </app>
    </sftp>
  </download>
</jreleaser>
jreleaser {
  // 
  download {
    // 
    sftp {
      // Downloaders require a name.
      // 
      app {

        // Enables or disables the downloader.
        // Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
        // Defaults to `NEVER`.
        // 
        active = 'ALWAYS'

        // Defines the connection timeout in seconds.
        // Defaults to `20`.
        // 
        connectTimeout = 20

        // Defines the read timeout in seconds.
        // Defaults to `60`.
        // 
        readTimeout = 60

        // Additional properties used when evaluating templates.
        // Key will be capitalized and prefixed with `sftp`, i.e, `sftpFoo`.
        // 
        extraProperties.put('foo', 'bar')

        // Host where the SFTP service is enabled.
        // If left unspecified, the `JRELEASER_SFTP_${name}_HOST`
        // environment variable must be defined.
        //  
        host = 'downloads.acme.com'

        // Port number of SFTP service.
        // If left unspecified, the `JRELEASER_SFTP_${name}_PORT`
        // environment variable must be defined.
        // Defaults to `22`.
        //  
        port = 22

        // The username required for authorization.
        // If left unspecified, the `JRELEASER_SFTP_${name}_USERNAME`
        // environment variable must be defined.
        //  
        username = '__DO_NOT_SET_HERE__'

        // Password for login into the SFTP service.
        // If left unspecified, the `JRELEASER_SFTP_${name}_PASSWORD`
        // environment variable must be defined.
        //  
        password = '__DO_NOT_SET_HERE__'

        // The public SSH key.
        // If left unspecified, the `JRELEASER_SFTP_${name}_PUBLIC_KEY`
        // environment variable must be defined.
        //  
        publicKey = '__DO_NOT_SET_HERE__'

        // The private SSH key.
        // If left unspecified, the `JRELEASER_SFTP_${name}_PRIVATE_KEY`
        // environment variable must be defined.
        //  
        privateKey = '__DO_NOT_SET_HERE__'

        // The passphrase required to read private keys.
        // If left unspecified, the `JRELEASER_SFTP_${name}_PASSPHRASE`
        // environment variable must be defined.
        //  
        passphrase = '__DO_NOT_SET_HERE__'

        // The remote server's SSH fingerprint.
        // If left unspecified, the `JRELEASER_SFTP_${name}_FINGERPRINT`
        // environment variable must be defined.
        //  
        fingerprint = '__DO_NOT_SET_HERE__'

        // A list of assets to be downloaded.
        // 
        asset {
          // Full download path to asset.
          //  
          input = '/logos/logo-256x256.png'

          // Local path where asset will be downloaded to.
          // Defaults to `${jreleaser.downloadDirectory}/${downloader.name}`.
          //  
          output = '{{projectName}}.png'

          // Unpack options
          // 
          unpack {
            // Unpack input archive when `true`.
            // Defaults to `false`.
            // 
            enabled = false

            // Skip the archive's root entry from the unpacked directory when `true`.
            // Defaults to `false`.
            // 
            skipRootEntry = false
          }
       }
      }
    }
  }
}

Host

You can have the host set in the configuration as shown above, or you can have it read from an environment variable. The configured name of the SFTP server will be used to build the environment variable name. This means that the name per configured instance needs to be unique.

The name of the environment variable will be JRELEASER_SFTP_NAME_HOST. If your instance is named production, you can store the host in the environment variable JRELEASER_SFTP_PRODUCTION_HOST. The name will be transformed to uppercase.

If a configured host is found in the configuration file, then the environment variable is not used at all.

Alternatives to JRELEASER_SFTP_NAME_HOST are (in order):

  • JRELEASER_SSH_NAME_HOST

  • JRELEASER_SFTP_HOST

  • JRELEASER_SSH_HOST

Port

You can have the port set in the configuration as shown above, or you can have it read from an environment variable. The configured name of the SFTP server will be used to build the environment variable name. This means that the name per configured instance needs to be unique.

The name of the environment variable will be JRELEASER_SFTP_NAME_PORT. If your instance is named production, you can store the port in the environment variable JRELEASER_SFTP_PRODUCTION_PORT. The name will be transformed to uppercase.

If a configured port is found in the configuration file, then the environment variable is not used at all.

Alternatives to JRELEASER_SFTP_NAME_PORT are (in order):

  • JRELEASER_SSH_NAME_PORT

  • JRELEASER_SFTP_PORT

  • JRELEASER_SSH_PORT

Username

You can have the username set in the configuration as shown above, or you can have it read from an environment variable. The configured name of the SFTP server will be used to build the environment variable name. This means that the name per configured instance needs to be unique.

The name of the environment variable will be JRELEASER_SFTP_NAME_USERNAME. If your instance is named production, you can store the username in the environment variable JRELEASER_SFTP_PRODUCTION_USERNAME. The name will be transformed to uppercase.

If a configured username is found in the configuration file, then the environment variable is not used at all.

Alternatives to JRELEASER_SFTP_NAME_USERNAME are (in order):

  • JRELEASER_SSH_NAME_USERNAME

  • JRELEASER_SFTP_USERNAME

  • JRELEASER_SSH_USERNAME

Password

The password will be stored in an environment variable. The configured name of the SFTP server will be used. This means that the name per configured instance needs to be unique.

The name of the environment variable will be JRELEASER_SFTP_NAME_PASSWORD. If your instance is named production, you need to store the secret in the environment variable JRELEASER_SFTP_PRODUCTION_PASSWORD. The name will be transformed to uppercase.

Alternatives to JRELEASER_SFTP_NAME_PASSWORD are (in order):

  • JRELEASER_SSH_NAME_PASSWORD

  • JRELEASER_SFTP_PASSWORD

  • JRELEASER_SSH_PASSWORD

Public Key

The public key will be stored in an environment variable. The configured name of the SFTP server will be used. This means that the name per configured instance needs to be unique.

The name of the environment variable will be JRELEASER_SFTP_NAME_PUBLIC_KEY. If your instance is named production, you need to store the secret in the environment variable JRELEASER_SFTP_PRODUCTION_PUBLIC_KEY. The name will be transformed to uppercase.

Alternatives to JRELEASER_SFTP_NAME_PUBLIC_KEY are (in order):

  • JRELEASER_SSH_NAME_PUBLIC_KEY

  • JRELEASER_SFTP_PUBLIC_KEY

  • JRELEASER_SSH_PUBLIC_KEY

Private Key

The private key will be stored in an environment variable. The configured name of the SFTP server will be used. This means that the name per configured instance needs to be unique.

The name of the environment variable will be JRELEASER_SFTP_NAME_PRIVATE_KEY. If your instance is named production, you need to store the secret in the environment variable JRELEASER_SFTP_PRODUCTION_PRIVATE_KEY. The name will be transformed to uppercase.

Alternatives to JRELEASER_SFTP_NAME_PRIVATE_KEY are (in order):

  • JRELEASER_SSH_NAME_PRIVATE_KEY

  • JRELEASER_SFTP_PRIVATE_KEY

  • JRELEASER_SSH_PRIVATE_KEY

Passphrase

The passphrase will be stored in an environment variable. The configured name of the SFTP server will be used. This means that the name per configured instance needs to be unique.

The name of the environment variable will be JRELEASER_SFTP_NAME_PASSPHRASE. If your instance is named production, you need to store the secret in the environment variable JRELEASER_SFTP_PRODUCTION_PASSPHRASE. The name will be transformed to uppercase.

Alternatives to JRELEASER_SFTP_NAME_PASSPHRASE are (in order):

  • JRELEASER_SSH_NAME_PASSPHRASE

  • JRELEASER_SFTP_PASSPHRASE

  • JRELEASER_SSH_PASSPHRASE

Fingerprint

The fingerprint will be stored in an environment variable. The configured name of the SFTP server will be used. This means that the name per configured instance needs to be unique.

The name of the environment variable will be JRELEASER_SFTP_NAME_FINGERPRINT. If your instance is named production, you need to store the secret in the environment variable JRELEASER_SFTP_PRODUCTION_FINGERPRINT. The name will be transformed to uppercase.

Alternatives to JRELEASER_SFTP_NAME_FINGERPRINT are (in order):

  • JRELEASER_SSH_NAME_FINGERPRINT

  • JRELEASER_SFTP_FINGERPRINT

  • JRELEASER_SSH_FINGERPRINT