A FTP server framework written by Golang
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Lunny Xiao 27cf3ace9d Add notifications with tests (#87) 1 week ago
.drone.yml Add minio driver (#86) 3 weeks ago
.gitignore update projects new package name 7 months ago
LICENSE release v0.3.0 1 year ago
README.md update projects new package name 7 months ago
auth.go Use constant-time compare for SimpleAuth (#68) 7 months ago
cmd.go Add notifications with tests (#87) 1 week ago
cmd_test.go release v0.3.0 1 year ago
conn.go Add notifications with tests (#87) 1 week ago
conn_test.go Remove unnecessary interface methods and implement cur direcoty (#95) 2 weeks ago
doc.go release v0.3.0 1 year ago
driver.go Remove unnecessary interface methods and implement cur direcoty (#95) 2 weeks ago
driver_file.go Fix some bugs and add tests for cur directory (#98) 2 weeks ago
driver_minio.go Remove unnecessary interface methods and implement cur direcoty (#95) 2 weeks ago
driver_minio_test.go Add notifications with tests (#87) 1 week ago
file_info.go Merge file driver into main repository (#83) 3 weeks ago
go.mod Add minio driver (#86) 3 weeks ago
go.sum Add minio driver (#86) 3 weeks ago
list_formatter.go Merge file driver into main repository (#83) 3 weeks ago
logger.go Improve shutdown behaviour (#42) 1 year ago
notifier.go Add notifications with tests (#87) 1 week ago
notifier_test.go Add notifications with tests (#87) 1 week ago
perm.go release v0.3.0 1 year ago
server.go Add notifications with tests (#87) 1 week ago
server_test.go Add notifications with tests (#87) 1 week ago
socket.go Fix some bugs and add tests for cur directory (#98) 2 weeks ago

README.md

server

Build Status

A FTP server framework forked from github.com/yob/graval and changed a lot.

Full documentation for the package is available on godoc

Version

v0.2.3

Installation

go get goftp.io/server

Usage

To boot a FTP server you will need to provide a driver that speaks to your persistence layer - the required driver contract is in the documentation.

Look at the file driver to see an example of how to build a backend.

There is a sample ftp server as a demo. You can build it with this command:

go install goftp.io/server/exampleftpd

Then run it if you have add $GOPATH to your $PATH:

exampleftpd -root /tmp

And finally, connect to the server with any FTP client and the following details:

host: 127.0.0.1
port: 2121
username: admin
password: 123456

This uses the file driver mentioned above to serve files.

Contributors

see https://gitea.com/goftp/server/graphs/contributors

Warning

FTP is an incredibly insecure protocol. Be careful about forcing users to authenticate with an username or password that are important.

License

This library is distributed under the terms of the MIT License. See the included file for more detail.

Contributing

All suggestions and patches welcome, preferably via a git repository I can pull from. If this library proves useful to you, please let me know.

Further Reading

There are a range of RFCs that together specify the FTP protocol. In chronological order, the more useful ones are:

For an english summary that's somewhat more legible than the RFCs, and provides some commentary on what features are actually useful or relevant 24 years after RFC959 was published:

For a history lesson, check out Appendix III of RCF959. It lists the preceding (obsolete) RFC documents that relate to file transfers, including the ye old RFC114 from 1971, “A File Transfer Protocol”

This library is heavily based on em-ftpd, an FTPd framework with similar design goals within the ruby and EventMachine ecosystems. It worked well enough, but you know, callbacks and event loops make me something something.