libunftp 0.2.0

Safe, fast and extensible FTP server library for Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

# [libunftp](https://github.com/bolcom/libunftp)

[![Crate Version](https://img.shields.io/crates/l/libunftp.svg)](https://crates.io/crates/libunftp)
[![Crate License](https://img.shields.io/crates/v/libunftp.svg)](https://crates.io/crates/libunftp)
[![Build Status](https://travis-ci.org/bolcom/libunftp.svg)](https://travis-ci.org/bolcom/libunftp)
[![API Docs](https://docs.rs/libunftp/badge.svg)](https://docs.rs/libunftp)

The libunftp library is a safe, fast and extensible FTP server implementation in Rust.

Because of its plugable authentication and storage backends (e.g. local filesystem, Google Buckets) it's more flexible than traditional FTP servers and a perfect match for the cloud.

It is currently under heavy development and not yet recommended for production use.
**API MAY BREAK**

[API Documentation](https://docs.rs/libunftp)

## Prerequisites

You'll need [Rust](https://rust-lang.org) 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

```sh
cargo new my_project
```

Then add libunftp to your project's dependencies in `Cargo.toml`:

```toml
[dependencies]
libunftp = "0.1"
```

Now you're ready to write your server!
Add the following to `src/main.rs`:

```rust
extern crate libunftp;

fn main() {
  let server = libunftp::Server::with_root(std::env::temp_dir());
  server.listen("127.0.0.1:2121");
}
```

You can now run your server with `cargo run` and connect to `localhost:2121` with your favourite FTP client.

For more examples checkout out the [examples](./examples) directory.

For more information checkout the [API Documentation](https://docs.rs/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.