Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bolcom/unftp
A FTP(S) server with a couple of twists written in Rust. Follow and talk to us on https://t.me/unftp. Docs on https://unftp.rs
https://github.com/bolcom/unftp
ftp hacktoberfest rust server
Last synced: about 13 hours ago
JSON representation
A FTP(S) server with a couple of twists written in Rust. Follow and talk to us on https://t.me/unftp. Docs on https://unftp.rs
- Host: GitHub
- URL: https://github.com/bolcom/unftp
- Owner: bolcom
- License: apache-2.0
- Created: 2019-03-01T16:57:43.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-03T22:04:27.000Z (2 months ago)
- Last Synced: 2024-11-15T16:33:00.259Z (1 day ago)
- Topics: ftp, hacktoberfest, rust, server
- Language: HTML
- Homepage:
- Size: 3.03 MB
- Stars: 269
- Watchers: 8
- Forks: 21
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Support: docs/support.md
Awesome Lists containing this project
README
# unFTP
[](https://crates.io/crates/unftp)
[](https://github.com/bolcom/unFTP/actions)
[](https://hub.docker.com/r/bolcom/unftp/)
[](https://t.me/unftp)
When you need to FTP, but don't want to.
[**Website**](https://unftp.rs) | [**Docs**](https://unftp.rs/server) | [**libunftp**](https://github.com/bolcom/libunftp)
unFTP is an FTP(S) server written in [Rust](https://www.rust-lang.org) and built on top of [libunftp](https://github.com/bolcom/libunftp) and the [Tokio](https://tokio.rs) asynchronous run-time. It is **un**like your normal FTP server in that it provides:
- Configurable Authentication (e.g. Anonymous, [PAM](https://en.wikipedia.org/wiki/Linux_PAM) or a JSON file).
- Configurable storage back-ends (e.g. [GCS](https://cloud.google.com/storage/) or filesystem)
- An HTTP server with health endpoints for use for example in Kubernetes for readiness and liveness probes.
- Integration with [Prometheus](https://prometheus.io) for monitoring.
- A proxy protocol mode for use behind proxies like HA Proxy and Nginx.
- Structured logging and the ability to ship logs to a Redis instance.
With unFTP, you can present RFC compliant FTP(S) to the outside world while freeing yourself to use modern APIs and
techniques on the inside of your perimeter.
## Installation and Usage
User documentation are available on our website [unftp.rs](https://unftp.rs)
## Docker image
The project contains templated Dockerfiles . To get a list of available commands, run:
```sh
make help
```
We offer 3 different options for building an unFTP docker image:
- `scratch`: builds the binary in [rust:slim](https://hub.docker.com/_/rust) and deploys in a `FROM scratch` image. The unFTP binary is statically linked using [musl libc](https://www.musl-libc.org/).
- `alpine` (default): builds in [rust:slim](https://hub.docker.com/_/rust) and deploy in alpine. This image is built with musl instead of a full-blown libc. The unFTP binary is statically linked using [musl libc](https://www.musl-libc.org/).
- `alpine-debug`: same images as `alpine` but using the debug build of unftp and adds tools like [lftp](https://lftp.yar.ru/) and [CurlFtpFS](http://curlftpfs.sourceforge.net/) while also running as root.
- `alpine-istio`: same as `alpine` but with [scuttle](https://github.com/redboxllc/scuttle) installed. For use together with [Istio](https://istio.io/).
- `alpine-istio-debug`: same as alpine-debug but with the additions of `alpine-istio`.
To build the alpine docker image:
```sh
make docker-image-alpine
```
Alternatively you can download pre-made images from [docker hub](https://hub.docker.com/r/bolcom/unftp/tags).
## Enabling tokio-console
You can use [tokio-console](https://github.com/tokio-rs/console) to analyze async tasks running in unFTP. To do this you
need to compile a build or run with the `tokio_console` feature enabled while also enabling the `tokio_unstable cfg`.
For example:
```sh
RUSTFLAGS="--cfg tokio_unstable" cargo build --features tokio_console
```
or:
```shell
RUSTFLAGS="--cfg tokio_unstable" cargo run --features tokio_console -- -vv
```
unFTP will listen on default port 6669 for connections from tokio-console.
## Getting help and staying informed
Support is given on a best effort basis. You are welcome to engage us on [the discussions page](https://github.com/bolcom/unftp/discussions)
or create a Github issue.
You can also follow news and talk to us on [Telegram](https://t.me/unftp)
## License
You're free to use, modify and distribute this software under the terms of the Apache-2.0 license.
## See also
- [libunftp](https://github.com/bolcom/libunftp)