How do I temporarily run an FTP server?

In the world of Ubuntu, it seems you either always run an FTP server or you never do. Perhaps I'm the first network analyst who's needed to flash a Cisco, Checkpoint or Nokia image using Ubuntu... I need an FTP server for maybe 5 minutes, no more than that.

I'm looking for a bare-bones, user-initiated FTP server. I understand that it would likely have to run with sudo. That's fine - but I want to start/stop it like a normal program.

On the Windows platform, such tools are a dime a dozen - I've used 3CDaemon for years and recently found CoreFTP. Both are excellent. You configure a user, point it at a directory, then hit the "Start" button. A couple of minutes later, you're generally done and you hit the "Stop" button. Job done.

Such tools don't seem to exist on Ubuntu. I found a Google Code project that creates a TFTP instance reasonably nicely (assuming it still runs - I haven't used it in about a year and python has moved on), but how about FTP? Anything out there?

You can get an FTP server going as easy as one two three using pyftpdlib:

1. Install with pip pip install --user pyftpdlib
2. Run with python -m pyftpdlib, add -w if you want write access too.
3. there is no step three :)

You now have an ftp server which you can log in to anonymously sharing your home directory. This is meant more as a test of the module, but it does what it says on the tin.

This command:

python -m pyftpdlib --directory=FTP --port=2121 --write

will serve, without root privileges, on port 2121 and grant write access to anonymous users. It will also use the directory FTP in the current working directory instead of your home. Type python ftpserver.py --help to get information about all the options.

• log into it at anonymous@localhost:2121/

Please note that this software is released under the terms of the MIT License, which means you can do basically what ever you please with it. Read the license text, it's only a few lines, and know your rights.

Now, this script doesn't support username and password as part of it's stand-alone functionality (for security reasons I imagine).

So I've added that feature:

• download my modified version

You now have, in addition to all options I mentioned, the command line parameters

--username=USERNAME and --password=PASSWORD:

python ftpserver.py --port=2121 --username=ftpuser --password=3r2u389r2u333j

Again, use --help to see them all.

This should be as easy as it gets.

I've also written a little gui for it:

• Download it here (updated at rev. 6)

  I'm sorry it's 3999 lines long, but it will do everything the original does. And i wanted to keep it all in one file. When it's started without any parameters (i.e. make it executable and double click it, or create a launcher for it), it starts a little gui for you to configure your server. You can still import it as a python module or use the above command line fu.

  Known issues:

  • I've not bothered with anything other than port 2121. This should be simple, making the port configurable requires complex error handling which I don't want the user to bother with. 2121 should always work fine.

  • It won't warn you, like the command line does, about using an insecure configuration. I.e. not setting a password or something like that.

EDIT: since the API of pyftpdlib and ftpserver.py changed (and the ubuntu pastebin links are gone); most of the above post doesn't work anymore. For the (2014) version of pyftpdlib, use this script (ftpserver-cli.py) to achieve the same as above:

#!/usr/bin/env python
# ftpserver-cli.py
import sys
sys.path.append("/path/to/pyftpdlib-svn") # enter your proper path here
import argparse

from pyftpdlib.authorizers import DummyAuthorizer
from pyftpdlib.handlers import FTPHandler
from pyftpdlib.servers import FTPServer

def processCmdLineOptions():
  global optparser
  optparser = argparse.ArgumentParser(description="ftpserver-cli",
              formatter_class=argparse.RawDescriptionHelpFormatter)
  optparser.add_argument('-u', '--username', action='store', type=str,
      default="user", help="username")
  optparser.add_argument('-p', '--password', action='store', type=str,
      default="12345", help="password")
  optparser.add_argument('-t', '--port', action='store', type=int,
      default="21", help="port")
  optparser.add_argument('-d', '--directory', action='store', type=str,
      default="/home/stefano/Projekte/", help="port")
  optargs = optparser.parse_args(sys.argv[1:]) #(sys.argv)
  return optargs


optargs = processCmdLineOptions()

print("Using: user: %s pass: %s port: %d dir: %s" % (optargs.username, optargs.password, optargs.port, optargs.directory))

authorizer = DummyAuthorizer()
authorizer.add_user(optargs.username, optargs.password, optargs.directory, perm="elradfmw")
#authorizer.add_anonymous("/home/nobody")

handler = FTPHandler
handler.authorizer = authorizer

server = FTPServer(("127.0.0.1", optargs.port), handler)
server.serve_forever()

call with:

$ sudo python ftpserver-cli.py --directory=/tmp/srvtest
Using: user: user pass: 12345 port: 21 dir: /tmp/srvtest
[I 14-03-02 21:40:57] >>> starting FTP server on 127.0.0.1:21, pid=19286 <<<
...

• You can use pure-ftpd

• You can use scp if you have an ssh server.