Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
- unFTP is a Rust FTP/FTPS server designed for cloud deployments, built on libunftp and Tokio.
- This repository contains the server application, including configuration and integrations for storage, authentication, monitoring, logging, and notifications.
- GitHub project: https://github.com/Cloudinvoke/unFTP
- Maintained under the CloudInvoke project by Hannes de Jager and Rob klein Gunnewiek (https://github.com/robklg). unFTP is no longer affiliated with bol.com.
- The source for libunftp sits here: https://github.com/bolcom/libunftp
- Maintained under the CloudInvoke project by Hannes de Jager and Rob klein Gunnewiek (https://github.com/robklg).
- The source for libunftp sits here: https://github.com/Cloudinvoke/libunftp
- Many extensions used by unFTP can be found on crates.io by searching for `unftp-`: https://crates.io/search?q=unftp-
- libunftp provides the underlying FTP/FTPS server library; this application configures and integrates it.
- Application code lives in `src/`
Expand All @@ -15,7 +15,7 @@

- We offer binaries that are hosted on Github
- We have a couple of docker images. There are *.Dockerfile.template files for these in the root. They build and publish via Github actions
- Images are still published to Docker Hub as `bolcom/unftp` until a CloudInvoke namespace is set up
- Images are published to Docker Hub as `cloudinvoke/unftp` and to GHCR as `ghcr.io/cloudinvoke/unftp`.

## Website

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ When you need to FTP, but don't want to.

![logo](logo.png)

[**Website**](https://unftp.rs) | [**Docs**](https://unftp.rs/server) | [**libunftp**](https://github.com/bolcom/libunftp)
[**Website**](https://unftp.rs) | [**Docs**](https://unftp.rs/server) | [**libunftp**](https://github.com/Cloudinvoke/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:
of [libunftp](https://github.com/Cloudinvoke/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), a JSON file or HTTP).
- Configurable storage back-ends (e.g. [GCS](https://cloud.google.com/storage/) or filesystem)
Expand All @@ -29,7 +29,7 @@ techniques on the inside of your perimeter.

unFTP is maintained under the [CloudInvoke](https://github.com/Cloudinvoke) project by
[Hannes de Jager](https://github.com/hannesdejager) and
[Rob klein Gunnewiek](https://github.com/robklg). It is no longer affiliated with bol.com.
[Rob klein Gunnewiek](https://github.com/robklg).

## Installation and Usage

Expand Down Expand Up @@ -125,5 +125,5 @@ You're free to use, modify and distribute this software under the terms of the A

## See also

- [libunftp](https://github.com/bolcom/libunftp), the primary crate unFTP server is based on.
- [libunftp](https://github.com/Cloudinvoke/libunftp), the primary crate unFTP server is based on.
- [libunftp back-ends/extensions on crates.io](https://crates.io/search?q=unftp-)
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ while your users still get that familiar FTP feeling.

The unFTP server is maintained under the [CloudInvoke](https://github.com/Cloudinvoke) project by
[Hannes de Jager](https://github.com/hannesdejager) and
[Rob klein Gunnewiek](https://github.com/robklg). It is no longer affiliated with bol.com.
[Rob klein Gunnewiek](https://github.com/robklg).

### Looking for something else?

- [libunftp on Github](https://github.com/bolcom/libunftp)
- [libunftp on Github](https://github.com/Cloudinvoke/libunftp)
- [libunftp API docs](https://docs.rs/libunftp/latest)
- [libunftp crate](https://crates.io/crates/libunftp)
- [unFTP server on Github](https://github.com/Cloudinvoke/unFTP)
Expand Down
8 changes: 4 additions & 4 deletions docs/libunftp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ possible.
| [unftp-sbe-rooter](https://crates.io/crates/unftp-sbe-rooter) | Wraps another storage back-end in order to root a user to a specific home directory |
| [unftp-sbe-webdav](https://crates.io/crates/unftp-sbe-webdav) | A WebDAV storage back-end providing translation between FTP & WebDAV |

See the [full list of storage back-ends on crates.io](https://crates.io/search?q=unftp-sbe) or the [Contribution Guide](https://github.com/bolcom/libunftp/blob/master/CONTRIBUTING.md#developing-your-own-authentication-or-storage-back-end-implementation) and [API Documentation](https://docs.rs/libunftp) if you want to create your own.
See the [full list of storage back-ends on crates.io](https://crates.io/search?q=unftp-sbe) or the [Contribution Guide](https://github.com/Cloudinvoke/libunftp/blob/master/CONTRIBUTING.md#developing-your-own-authentication-or-storage-back-end-implementation) and [API Documentation](https://docs.rs/libunftp) if you want to create your own.

## Known Authentication back-ends

Expand All @@ -53,16 +53,16 @@ See the [full list of storage back-ends on crates.io](https://crates.io/search?q
| [unftp-auth-pam](https://crates.io/crates/unftp-auth-pam) | Authenticates via PAM |
| [unftp-auth-rest](https://crates.io/crates/unftp-auth-rest) | Consumes an HTTP API to authenticate |

See the [full list of authentication back-ends on crates.io](https://crates.io/search?q=unftp-auth) or the [Contribution Guide](https://github.com/bolcom/libunftp/blob/master/CONTRIBUTING.md#developing-your-own-authentication-or-storage-back-end-implementation) and [API Documentation](https://docs.rs/libunftp) if you want to create your own.
See the [full list of authentication back-ends on crates.io](https://crates.io/search?q=unftp-auth) or the [Contribution Guide](https://github.com/Cloudinvoke/libunftp/blob/master/CONTRIBUTING.md#developing-your-own-authentication-or-storage-back-end-implementation) and [API Documentation](https://docs.rs/libunftp) if you want to create your own.

## Known SITE command extensions

| Crate | Description |
|-------|-------------|
| [unftp-site-hash](https://crates.io/crates/unftp-site-hash) | Adds a `SITE HASH` command, supporting SHA-256, SHA-1, MD5 and CRC32 file hashing |

See the [full list of SITE command extensions on crates.io](https://crates.io/search?q=unftp-site) or the [Contribution Guide](https://github.com/bolcom/libunftp/blob/master/CONTRIBUTING.md#developing-your-own-authentication-or-storage-back-end-implementation) and [`ServerBuilder::site_command`](https://docs.rs/libunftp/latest/libunftp/struct.ServerBuilder.html#method.site_command) if you want to create your own.
See the [full list of SITE command extensions on crates.io](https://crates.io/search?q=unftp-site) or the [Contribution Guide](https://github.com/Cloudinvoke/libunftp/blob/master/CONTRIBUTING.md#developing-your-own-authentication-or-storage-back-end-implementation) and [`ServerBuilder::site_command`](https://docs.rs/libunftp/latest/libunftp/struct.ServerBuilder.html#method.site_command) if you want to create your own.

## Additional resources

See the [github page](https://github.com/bolcom/libunftp) or the [API Documentation](https://docs.rs/libunftp) for more details.
See the [github page](https://github.com/Cloudinvoke/libunftp) or the [API Documentation](https://docs.rs/libunftp) for more details.
6 changes: 3 additions & 3 deletions docs/server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ title: The Server
# unFTP - The FTPS Server Application

[![Crate Version](https://img.shields.io/crates/v/unftp.svg)](https://crates.io/crates/unftp)
[![Docker Pulls](https://img.shields.io/docker/pulls/bolcom/unftp.svg?maxAge=2592000?style=plastic)](https://hub.docker.com/r/bolcom/unftp/)
[![Docker Pulls](https://img.shields.io/docker/pulls/cloudinvoke/unftp.svg?maxAge=2592000?style=plastic)](https://hub.docker.com/r/cloudinvoke/unftp/)
[![Follow on Telegram](https://img.shields.io/badge/follow%20on-Telegram-brightgreen.svg)](https://t.me/unftp)

[![Packaging status](https://repology.org/badge/vertical-allrepos/unftp.svg?exclude_unsupported=1)](https://repology.org/project/unftp/versions)


unFTP is a 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:
unFTP is a FTP(S) server written in [Rust](https://www.rust-lang.org) and built on top of [libunftp](https://github.com/Cloudinvoke/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)
Expand All @@ -25,4 +25,4 @@ techniques on the inside of your perimeter.

unFTP is maintained under the [CloudInvoke](https://github.com/Cloudinvoke) project by
[Hannes de Jager](https://github.com/hannesdejager) and
[Rob klein Gunnewiek](https://github.com/robklg). It is no longer affiliated with bol.com.
[Rob klein Gunnewiek](https://github.com/robklg).
4 changes: 2 additions & 2 deletions docs/server/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Docker

This page explains how to run unFTP using Docker, including downloading pre-built images and configuring the container with environment variables and volume mounts.

Starting with the next release, pre-made images will be published on
Since v0.16.0, pre-made images have been published on
[Docker Hub](https://hub.docker.com/r/cloudinvoke/unftp/tags) as `cloudinvoke/unftp` and on
GitHub Container Registry as `ghcr.io/cloudinvoke/unftp`. For example, with a released version:

Expand All @@ -13,7 +13,7 @@ docker pull cloudinvoke/unftp:vX.Y.Z-alpine
docker pull ghcr.io/cloudinvoke/unftp:vX.Y.Z-scratch
```

Older images remain available from the former
Older images also remain available from the former
[Docker Hub repository](https://hub.docker.com/r/bolcom/unftp/tags).

Releases with ARM64 support publish the `-alpine`, `-scratch`, and `-alpine-debug` image tags for both `linux/amd64`
Expand Down
4 changes: 3 additions & 1 deletion docs/server/jsonconfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@ unftp \

## Generating secure passwords

We provide a tool that generates a secure password for you.
We provide a tool that generates a secure password for you. Its container is
still published under the former Docker Hub namespace; there is no
`cloudinvoke/unftp-key-generator` image yet.

Generating a secure password is as simple as this:

Expand Down
Loading