jsftpd

FTP server for node.js


Install

Either download from here or install via npm.

``shell
$ npm install jsftpd
`

Quick start

To get an FTP server running quickly, the below code will get you started by allowing access for a single user.

`js
const { ftpd } = require('jsftpd')

const server = new ftpd({cnf: {username: 'john', password: 'doe', basefolder: '/tmp'}})

server.start()
`

Documentation

The full documentation of the project is available here.

The ftpd instance takes an object with two properties that allows for configuring the new instance.
- tls property object. Takes any configuration option as per node.js tls.createServer options
- cnf property object. Takes jsftpd specific configuration items. See full documentation here
- hdl` property object. Takes handler functions for specific FTP commands. See full documentation here