https://github.com/dhatim/dropwizard-sftp

SFTP Server (SSH File Transfer Protocol) based on Apache MINA SSHD for Dropwizard
https://github.com/dhatim/dropwizard-sftp

bundle dropwizard java library sftp-server

Last synced: 5 months ago
JSON representation

SFTP Server (SSH File Transfer Protocol) based on Apache MINA SSHD for Dropwizard

• Host: GitHub
• URL: https://github.com/dhatim/dropwizard-sftp
• Owner: dhatim
• License: apache-2.0
• Created: 2018-07-24T08:43:18.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2025-12-15T14:32:48.000Z (6 months ago)
• Last Synced: 2025-12-18T18:50:34.717Z (6 months ago)
• Topics: bundle, dropwizard, java, library, sftp-server
• Language: Java
• Size: 157 KB
• Stars: 1
• Watchers: 10
• Forks: 3
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# dropwizard-sftp

[![Build Status](https://github.com/dhatim/dropwizard-sftp/workflows/build/badge.svg)](https://github.com/dhatim/dropwizard-sftp/actions)

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.dhatim/dropwizard-sftp/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.dhatim/dropwizard-sftp)

[![Javadocs](https://www.javadoc.io/badge/org.dhatim/dropwizard-sftp.svg)](https://www.javadoc.io/doc/org.dhatim/dropwizard-sftp)

SFTP Server (SSH File Transfer Protocol) based on [Apache MINA SSHD](https://mina.apache.org/) for [Dropwizard](https://www.dropwizard.io).

**Please note version 2 requires Dropwizard 2.**

## Usage

### Maven Artifacts

This project is available in the [Central Repository](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.dhatim%22%20AND%20a%3A%22dropwizard-sftp%22). To add it to your project simply add the following dependency to your POM:

```xml

  org.dhatim

  dropwizard-sftp

  2.1.1

```

### Define SSHD configuration

```yaml

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

```java

bootstrap.addBundle(new SshdBundle() {

    @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](https://github.com/dhatim/dropwizard-sftp/issues).