Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Featureless FTP server
JavaScript
branch: master

README.md

Build Status

FTP Server -- Simple featureless FTP server

This is a very simple FTP server. At first it's aimed to simply provide a full-Node implementation of FTP server to be embedded for Unit Testing purpose.

It's currently highly experimental and could crash anytime. It could become a real FTP server if you want to contribute a bit ;) Don't be afraid: FTP protocol is quite simple.

Install

# Using NPM
npm install ftp-server

Or from source:

# Install from sources...
git clone git://github.com/naholyr/node-ftp-server.git ftp-server
cd ftp-server
npm link

# ...Then in your project
npm link ftp-server

You can run unit tests:

# From your project where ftp-server has been installed as a module
npm test ftp-server

# Or directly from ftp-server
npm test

Usage

Example: Simply serve a given directory:

var ftpd = require('ftp-server')
// Path to your FTP root
ftpd.fsOptions.root = '/path/to/ftp-root'
// Start listening on port 21 (you need to be root for ports < 1024)
ftpd.listen(21)

Extend server

Just look at the code. I'll fully document the ways to extend the server with additional features when it's at least more stable.

Paternity

Note that the original implementation I based my work on was @billywhizz 's from GitHub.

Roadmap

  • Add support for rename commands
  • Better implementation of LIST and NLST to be cross-platform
  • Add support for REST command (restart an interrupted download)
  • Maybe wrap all this stuff in a class or at least a function with options (like what FS we'll use)
  • Add better documentation on how to extend server (add "features") or new FS wrappers
  • Implement MemoryFS
  • Support authentication from config or even from database
  • Implement all the RFCs from FTP protocol

License: MIT

Copyright (C) 2012 Nicolas Chambrier

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Something went wrong with that request. Please try again.