Git-ftp by git-ftp (original) (raw)

If you use Git and you need to upload your files to an FTP server, Git-ftp can save you some time and bandwidth by uploading only those files that changed since the last upload.

It keeps track of the uploaded files by storing the commit id in a log file on the server. It uses Git to determine which local files have changed.

You can easily deploy another branch or go back in the Git history to upload an older version.

Setup

git config git-ftp.url ftp.example.net git config git-ftp.user ftp-user git config git-ftp.password secr3t

Upload all files

git ftp init

Or if the files are already there

git ftp catchup

Work and deploy

echo "new content" >> index.txt git commit index.txt -m "Add new content" git ftp push

1 file to sync:

[1 of 1] Buffered for upload 'index.txt'.

Uploading ...

Last deployment changed to ded01b27e5c785fb251150805308d3d0f8117387.

Further Reading

• Read the manual for more options, features and examples.
• See the installation instructions for your system.
• Check git-ftp issues on GitHub for open issues.
• Follow this project on twitter @gitftp.

Limitations

• Windows and OS X: I am very limited in testing on Windows and OS X. Thanks for helping me out fixing bugs on these platforms.
• git-ftp as deployment tool: git-ftp was not designed as centralized deployment tool. While running git-ftp, you have to take care, no one pushes or touches this repo (e.g. no commits, no checkouts, no file modifications)!

Contributions

Don't hesitate to improve this tool. Don't forget to add yourself to the AUTHORS file. Core functionality is unit tested using shunit2. You can find the tests in tests/.

Copyright

This application is licensed under GNU General Public License, Version 3.0