firetrap 0.1.0

Modern, safe 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

# [firetrap](https://github.com/koenw/firetrap)

Firetrap helps you create modern, safe and extensible FTP servers 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**

## Prerequisites

You'll need [Rust](https://rust-lang.org) to build firetrap.
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 firetrap to your projects dependencies in `Cargo.toml`:

```toml
[dependencies]
firetrap = "*"
```

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

```rust
extern crate firetrap;

fn main() {
  let server = firetrap::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.

## Contributing

First of all, thank you for you interest in contributing to firetrap!
Please feel free to create a github issue if you encounter any problems.
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 MIT or Apache-2.0 license, whichever has your preference.