This FTP server is a gateway between old-school FTP devices and modern cloud based file systems, using the afero 's Fs interface and acting as a reference implementation of the ftpserverlib
At the current stage, supported FS are:
- Local disk
- S3 through fclairamb/afero-s3
- SFTP through afero's sftpfs
Planned FS are:
- Dropbox
- Google Drive
These features are brought by 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 for logging
- afero for generic file systems handling
- Supported extensions:
go get -u github.com/fclairamb/ftpserver
If you don't create a ftpserver.json
file, it will be created for you.
Here is a sample config file:
{
"version": 1,
"accesses": [
{
"user": "test",
"pass": "test",
"fs": "os",
"params": {
"basePath": "/tmp"
}
},
{
"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"
}
}
],
"passive_transfer_port_range": {
"start": 2122,
"end": 2130
}
}
You can build the binary and use it directly:
# Get and install the server
go get github.com/fclairamb/ftpserver
ftpserver &
# 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:https://test:test@localhost:2121/
# Download it back
curl ftp:https://test:test@localhost:2121/kitty.jpg -o kitty2.jpg
# Compare it
diff kitty.jpg kitty2.jpg
There's also a containerized version of the server (15MB, based on alpine).
# Starting the sample FTP server
docker run --rm -d -p 2121-2130:2121-2130 fclairamb/ftpserver
# Download some file
[ -f kitty.jpg ] || (curl -o kitty.jpg.tmp https://placekitten.com/2048/2048 && mv kitty.jpg.tmp kitty.jpg)
# Upload it
curl -v -T kitty.jpg ftp:https://test:test@localhost:2121/
# Download it back
curl ftp:https://test:test@localhost:2121/kitty.jpg -o kitty2.jpg
# Compare it
diff kitty.jpg kitty2.jpg