
Automate deploying websites and more with this GitHub action. It's free!
Place the following in /.github/workflows/main.yml
on: push
name: 🚀 Deploy website on push
jobs:
web-deploy:
name: 🎉 Deploy
runs-on: ubuntu-latest
steps:
- name: 🚚 Get latest code
uses: actions/checkout@v6
- name: 📂 Sync files
uses: SamKirkland/FTP-Deploy-Action@v4.4.0
with:
server: ftp.samkirkland.com
username: myFtpUserName
password: ${{ secrets.ftp_password }}
Actions tabBlank workflow file or Set up a workflow yourself, if you don't see these options manually create a yaml file Your_Project/.github/workflows/main.ymlsecrets section in your project. To add a secret go to the Settings tab in your project then select Secrets. Add a new Secret for passwordKeys can be added directly to your .yml config file or referenced from your project Secrets storage.
To add a secret go to the Settings tab in your project then select Secrets.
I strongly recommend you store your password as a secret.
| Key Name | Required | Example | Default Value | Description |
|---|---|---|---|---|
server |
Yes | ftp.samkirkland.com |
Deployment destination server | |
username |
Yes | username@samkirkland.com |
FTP user name | |
password |
Yes | CrazyUniquePassword&%123 |
FTP password, be sure to escape quotes and spaces | |
port |
No | 990 |
21 |
Server port to connect to (read your web hosts docs) |
protocol |
No | ftps |
ftp |
ftp: provides no encryption, ftps: full encryption newest standard (aka "explicit" ftps), ftps-legacy: full encryption legacy standard (aka "implicit" ftps) |
local-dir |
No | ./myFolderToPublish/ |
./ |
Folder to upload from, must end with trailing slash / |
server-dir |
No | public_html/www/ |
./ |
Folder to upload to (on the server), must end with trailing slash / |
state-name |
No | folder/.sync-state.json |
.ftp-deploy-sync-state.json |
Path and name of the state file - this file is used to track which files have been deployed |
dry-run |
No | true |
false |
Prints which modifications will be made with current config options, but doesn't actually make any changes |
dangerous-clean-slate |
No | true |
false |
Deletes ALL contents of server-dir, even items in excluded with 'exclude' argument |
exclude |
No | See Example | See Example | An array of glob patterns, these files will not be included in the publish/delete process. List MUST be in this format. You can use a glob tester to test your pattern(s). |
log-level |
No | minimal |
standard |
minimal: only important info, standard: important info and basic file changes, verbose: print everything the script is doing |
security |
No | strict |
loose |
strict: Reject any connection which is not authorized with the list of supplied CAs. loose: Allow connection even when the domain is not certificate |
timeout |
No | 60000 |
30000 |
Timeout in milliseconds for FTP operations |
Make sure you have an npm script named 'build'. This config should work for most node built websites.
```yml on: push name: 🚀 Deploy website
$ claude mcp add FTP-Deploy-Action \
-- python -m otcore.mcp_server <graph>