libunftp
When you need to FTP, but don't want to.
The libunftp library is a safe, fast and extensible FTP server implementation in Rust brought to you by the bol.com techlab.
Because of its plugable authentication and storage backends (e.g. local filesystem, Google Cloud Storage) it's more flexible than traditional FTP servers and a perfect match for the cloud.
It runs on top of the Tokio asynchronous run-time and so tries to make use of Async IO as much as possible.
libunftp is currently under heavy development and not yet recommended for production use. The API MAY BREAK
Prerequisites
You'll need Rust 1.31 or higher to build libunftp. There are no runtime dependencies besides the OS and libc.
Getting started
If you've got Rust and cargo installed, create your project with
Then add the libunftp, tokio & futures crates to your project's dependencies in Cargo.toml
:
[]
= "0.2"
= "0.1"
= "0.1"
Now you're ready to develop your server!
Add the following to src/main.rs
:
use Future;
use Runtime;
You can now run your server with cargo run
and connect to localhost:2121
with your favourite FTP client e.g.:
For more help refer to:
- the examples directory.
- the API Documentation.
- unFTP server, a server from the bol.com techlab that is built on top of libunftp.
Contributing
First of all, thank you for your interest in contributing to libunftp! Please feel free to create a github issue if you encounter any problems, want to submit a feature request, or just feel like it :)
Run make help
in the root of this repository to see the available make commands.
License
You're free to use, modify and distribute this software under the terms of the Apache-2.0 license.