README.md

dropwizard-sftp

SFTP Server (SSH File Transfer Protocol) based on Apache MINA SSHD for Dropwizard. Please note version 2 requires Dropwizard 2.

Usage

Maven Artifacts

This project is available in the Central Repository. To add it to your project simply add the following dependency to your POM:

<dependency>
  <groupId>org.dhatim</groupId>
  <artifactId>dropwizard-sftp</artifactId>
  <version>2.1.1</version>
</dependency>

Define SSHD configuration

sshd:
  enable: true
  port: 2222
  bindHost: localhost
  capacity: 256

The capacity (defaults to 256) caps the amount of in-flight buffers during a transfer session by throttling the producer and the consumer.

Add the bundle to your Dropwizard application

bootstrap.addBundle(new SshdBundle<YourConfiguration>() {
    @Override
    public SshdConfiguration getSshdConfiguration(YourConfiguration configuration) {
        return configuration.getSshd();
    }

    @Override
    public void configure(YourConfiguration configuration, Environment environment, SshServer server) {
        // Init your SSH Server
    }
});

Support

Please file bug reports and feature requests in GitHub issues.