Skip to content
This repository

Ftp interface to Rackspace Cloud Files

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.rst

FTP Interface to Rackspace Cloud Files and OpenStack Swift

Homepage: http://blog.chmouel.com/2009/10/29/ftp-server-for-cloud-files/
Credits: Copyright 2009--2012 Chmouel Boudjnah <chmouel@chmouel.com>
Licence: MIT

DESCRIPTION

ftp-cloudfs is a ftp server acting as a proxy to Rackspace Cloud Files or to OpenStack Swift. It allow you to connect via any FTP client to do upload/download or create containers.

By default the server will bind to port 2021 which allow to be run as a non root/administrator user.

It supports pseudo-hierarchical folders/directories as described in the Rackspace Cloud Files API and the OpenStack Object Storage API.

REQUIREMENT

Operating Systems

This has been tested on a Debian testing Linux distribution but it should work on any Unices (including MacOSX) as long you have the requirement listed above.

It should as well work on Windows but this has been completely untested.

INSTALL

Use standard setup.py directives ie :

python setup.py install

Or if you have pip installed you can just do a

pip install ftp-cloudfs

which will install ftp-cloudfs with all the dependencies needed.

On a Debian/Ubuntu the preferred way to install would be like this:

apt-get -y install python-daemon python-stdeb
pypi-install python-memcached
pypi-install python-cloudfiles
pypi-install pyftpdlib
pypi-install ftp-cloudfs

USAGE

The install should have created a /usr/bin/ftpcloudfs (or whatever prefix defined in your python distribution or command line arguments) which can be used like this :

Usage: ftpcloudfs [OPTIONS].....
-h, --help show this help message and exit
-p PORT, --port=PORT
  Port to bind the server default: 2021.
-b BIND_ADDRESS, --bind-address=BIND_ADDRESS
  Address to bind by default: 127.0.0.1.
--workers=WORKERS
  Number of workers to use default: 1.
--memcache=MEMCACHE
  Memcache server(s) to be used for cache (ip:port).
-a AUTHURL, --auth-url=AUTHURL
  Auth URL for alternate providers(eg OpenStack)
-v, --verbose Be verbose on logging.
-s, --service-net
  Connect via Rackspace ServiceNet network.
-f, --foreground
  Do not attempt to daemonize but run in foreground.
-l LOG_FILE, --log-file=LOG_FILE
  Log File: Default stdout when in foreground
--syslog Enable logging to the system logger (daemon facility).
--pid-file=PID_FILE
  Pid file location when in daemon mode.
--uid=UID UID to drop the privilege to when in daemon mode
--gid=GID GID to drop the privilege to when in daemon mode

The defaults can be changed using a configuration file (by default in /etc/ftpcloudfs.conf). Check the example file included in the package.

CACHE MANAGEMENT

Both Rackspace Cloud Files and OpenStack Swift are a object storages and not real file systems. This proxy simulates enough file system functionality to be used over FTP, but it has a performance hit.

To improve the performance a cache is used. It can be local or external (with Memcache). By default a local cache is used, unless one or more Memcache servers are configured.

If you're using just one worker the local cache will be fine, but if you're using several workers, configuring an external cache is highly recommended.

SUPPORT

This tool is not supported by Rackspace in any sort but I will be happy to help you as much as possible. Your best bet to report issues and or feature request is to have them reported in the github issue tracker :

https://github.com/chmouel/ftp-cloudfs/issues

BUGS

None known ;-)

LICENSE

Unless otherwise noted, all files are released under the MIT license, exceptions contain licensing information in them.

Copyright (C) 2009-2012 Chmouel Boudjnah <chmouel@chmouel.com>

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.

Except as contained in this notice, the name of Rackspace US, Inc. shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorisation from Rackspace US, Inc.

Authors

Contributors

Something went wrong with that request. Please try again.