NodeFTPD is an FTP server written for Node.js. It's currently under heavy development and should not be used in production.
This is a real FTP server, and I'm aiming to implement all standard FTP functionality. I have pretty much all of the basics implemented so far, and you can definitely install this locally and use it as an FTP server. It even supports TLS!
The project is a Node.js/JavaScript learning project, but I intend on making it into a feature complete FTP server that I can deploy on my own servers.
I've prioritized the most common FTP commands first, so the majority of commands that are actually used by modern FTP clients are implemented. For a detailed list, see the list of implemented/not implemented commands.
This software is in alpha. It's NOT ready for use in any type of production environment.
- The PAM dev package is required. On Ubuntu variants, install with
sudo apt-get install libpam-dev. On CentOS variants, install withsudo yum install pam-devel. On Debian variants, install withsudo apt-get install libpam0g-dev. - Clone this repository or download as a zip
- Run
npm installto install dependencies - Run
npm start. It will auto detect your IP and run on port 21.
- The PAM dev package is required. On Ubuntu variants, install with
sudo apt-get install libpam-dev. On CentOS variants, install withsudo yum install pam-devel. On Debian variants, install withsudo apt-get install libpam0g-dev. - Run
npm install -g nodeftpd - Run
nodeftpd start. It will auto detect your IP and run on port 21.
These instructions assume you've installed NodeFTPD via NPM or placed the NodeFTPD binary in your PATH variable.
Start NodeFTPD
$ nodeftpd start
Starting NodeFTPD.... Done
Stop NodeFTPD
$ nodeftpd stop
Stopping NodeFTPD.... Stopped
Restart NodeFTPD
$ nodeftpd restart
Stopping NodeFTPD.... Not running
Starting NodeFTPD.... Done
NodeFTPD status
$ nodeftpd status
NodeFTPD is NOT running.
Help
$ nodeftpd help
Usage: nodeftpd [options] [command]
Commands:
help Show this help text
status Display the status of NodeFTPD
stop Stop NodeFTPD
restart Restart NodeFTPD
* Start NodeFTPD
Options:
-h, --help output usage information
-V, --version output the version number
-D, --no-daemon Don't run NodeFTPD as a daemon
Every FTP command and response is logged. By default, these logs are stored in /var/log/nodeftpd/access.log.
Error logs are stored in /var/log/nodeftpd/error.log.
The PID file (stores the process ID of the main process) is in /var/run/nodeftpd.pid.
You may override these values via the config file.
The configuration file is /etc/nodeftpd.yml. It expects a YAML file. Example configuration below:
port: 10021
passive_port_range: 45000-55000
motd: 'NodeFTPD %pkg.version% Server (%os.hostname%)'To see all possible configuration values, please look at config.yml (contains the default config).
This is not yet implemented
Warning: This feature is new and unstable
Add the following to your config file:
tls:
enabled: true,
key: /root/server-key.pem
cert: /root/server-cert.pem
port: 990Listens on port 990 by default. Supports active and passive mode transfers.
The system only supports Linux accounts via PAM at the moment. More drivers are coming soon!
NodeFTPd ships with software level chroot capabilities, which are enabled by default. The default setting chroots the user to their home directory. When they connect via FTP, their root directory is mapped to their home directory.
Users in a chroot jail cannot manipulate files outside of their chroot jail.
You can disable chroot jails by setting the chroot jail to /.
This FTP server uses a child process based design, where each connection is handled by it's own process. This is for security reasons, and to make the code easier to organize and maintain.
The parent process listens for new connections and passes them off to a process in the process pool. When this occurs, a new process is spawned to keep idle_workers processes free in the pool. When a connection is closed, that process is destroyed.