Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fclairamb/ftpserver
Golang based autonomous FTP server with SFTP, S3, Dropbox, and Google Drive connectors.
https://github.com/fclairamb/ftpserver
afero ftp ftp-server go golang google-drive s3
Last synced: about 2 months ago
JSON representation
Golang based autonomous FTP server with SFTP, S3, Dropbox, and Google Drive connectors.
- Host: GitHub
- URL: https://github.com/fclairamb/ftpserver
- Owner: fclairamb
- License: mit
- Created: 2020-05-10T16:58:08.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-23T01:42:04.000Z (7 months ago)
- Last Synced: 2024-05-23T02:18:35.526Z (7 months ago)
- Topics: afero, ftp, ftp-server, go, golang, google-drive, s3
- Language: Go
- Homepage:
- Size: 5.46 MB
- Stars: 570
- Watchers: 13
- Forks: 94
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Golang FTP Server
[](https://goreportcard.com/report/fclairamb/ftpserver)
[](https://godoc.org/github.com/fclairamb/ftpserver/server)
This FTP server is a gateway between old-school FTP devices and modern cloud based file systems, using the
[afero](https://github.com/spf13/afero)'s Fs interface and acting as a reference implementation of the [ftpserverlib](https://github.com/fclairamb/ftpserverlib).
At the current stage, supported backend are:
- Local disk
- [S3](https://aws.amazon.com/s3/) through [afero-s3](https://github.com/fclairamb/afero-s3)
- [Dropbox](https://www.dropbox.com/) (see [doc](https://github.com/fclairamb/ftpserver/tree/master/fs/dropbox)) through [afero-dropbox](https://github.com/fclairamb/afero-dropbox)
- [Google Drive](https://developers.google.com/drive) (see [doc](https://github.com/fclairamb/ftpserver/tree/master/fs/gdrive)) through [afero-gdrive](https://github.com/fclairamb/afero-gdrive)
- [SFTP](https://en.wikipedia.org/wiki/SSH_File_Transfer_Protocol) through [afero's sftpfs](https://github.com/spf13/afero/)
- Email through [go-mail](https://github.com/go-mail/mail) thanks to [@x-way](https://github.com/x-way)
- Telegram through [telebot](https://github.com/tucnak/telebot) by [@slayer](https://github.com/slayer), see [doc](fs/telegram/README.md)
And with those are supported common parameters to switch them to read-only, enable login access, or use a temporary directory file (see [doc](https://github.com/fclairamb/ftpserver/tree/master/fs)).
## Current status of the project
### Features
#### FTP protocol
These features are brought by [ftpserverlib](https://github.com/fclairamb/ftpserverlib) itself:
* Uploading and downloading files
* Directory listing (LIST + MLST)
* File and directory deletion and renaming
* TLS support (AUTH + PROT)
* File download/upload resume support (REST)
* Complete driver for all the above features
* Passive socket connections (EPSV and PASV commands)
* Active socket connections (PORT command)
* Small memory footprint
* Only relies on the standard library except for:
* [go-kit log](https://github.com/go-kit/kit/tree/master/log) for logging
* [afero](https://github.com/spf13/afero) for generic file systems handling
* Supported extensions:
* [AUTH](https://tools.ietf.org/html/rfc2228#page-6) - Control session protection
* [AUTH TLS](https://tools.ietf.org/html/rfc4217#section-4.1) - TLS session
* [PROT](https://tools.ietf.org/html/rfc2228#page-8) - Transfer protection
* [EPRT/EPSV](https://tools.ietf.org/html/rfc2428) - IPv6 support
* [MDTM](https://tools.ietf.org/html/rfc3659#page-8) - File Modification Time
* [SIZE](https://tools.ietf.org/html/rfc3659#page-11) - Size of a file
* [REST](https://tools.ietf.org/html/rfc3659#page-13) - Restart of interrupted transfer
* [MLST](https://tools.ietf.org/html/rfc3659#page-23) - Simple file listing for machine processing
* [MLSD](https://tools.ietf.org/html/rfc3659#page-23) - Directory listing for machine processing
## Getting started
### Get it
#### Download it
Fetch a binary from the [latest release](/releases) and run it.
#### Build & run it locally
```bash
go install github.com/fclairamb/ftpserver@main
ftpserver &
```
#### Run it with docker
There's also a containerized version of the server (31MB, based on alpine).
```sh
# Creating a directory
mkdir -p files
# Starting the sample FTP server
docker run --rm -d -p 2121-2130:2121-2130 -v $(pwd)/files:/tmp -v $(pwd):/app fclairamb/ftpserver
```
#### Run it with docker compose
```yml
# docker-compose.yml
version: '3.3'
services:
ftpserver:
ports:
- '2121-2130:2121-2130'
volumes:
- ./files:/tmp
- .:/app
image: fclairamb/ftpserver
```
```sh
docker-compose up -d
```
### Test it
This is a quick way to see if it's working correctly:
```sh
# Download some file
[ -f kitty.jpg ] || (curl -o kitty.jpg.tmp https://placekitten.com/2048/2048 && mv kitty.jpg.tmp kitty.jpg)
# Upload it to the server
curl -v -T kitty.jpg ftp://test:test@localhost:2121/
# Download it back
curl ftp://test:test@localhost:2121/kitty.jpg -o kitty2.jpg
# Compare it
diff kitty.jpg kitty2.jpg
```
### Config file
If you don't create a `ftpserver.json` file, one will be created for you.
Here is a sample config file:
```json
{
"version": 1,
"passive_transfer_port_range": {
"start": 2122,
"end": 2130
},
"tls": {
"server_cert": {
"cert": "cert.pem",
"key": "key.pem"
}
},
"accesses": [
{
"user": "test",
"pass": "test",
"fs": "os",
"params": {
"basePath": "/tmp"
}
},
{
"user": "test",
"pass": "test",
"fs": "os",
"params": {
"basePath": "/tmp"
}
},
{
"user": "dropbox",
"pass": "dropbox",
"fs": "dropbox",
"params": {
"token": "..."
}
},
{
"user": "gdrive",
"pass": "gdrive",
"fs": "gdrive",
"params": {
"google_client_id": "***.apps.googleusercontent.com",
"google_client_secret": "****",
"base_path": "ftp"
}
},
{
"user": "s3",
"pass": "s3",
"fs": "s3",
"params": {
"endpoint": "https://s3.amazonaws.com",
"region": "eu-west-1",
"bucket": "my-bucket",
"access_key_id": "AKIA....",
"secret_access_key": "IDxd....",
"disable_ssl": "false",
"path_style": "false"
}
},
{
"user": "sftp",
"pass": "sftp",
"fs": "sftp",
"params": {
"username": "user",
"password": "password",
"hostname": "192.168.168.11:22"
}
},
{
"user": "telegram",
"pass": "telegram",
"fs": "telegram",
"shared": true,
"params": {
"Token": "",
"ChatID": ""
}
}
]
}
```
You can generate the TLS key pair files with the following command:
```bash
openssl req -new -newkey rsa:4096 -x509 -sha256 -days 365 -nodes -out cert.pem -keyout key.pem
```