ftpsync

A caching website uploader using FTPS

This is a tool to deploy web sites using FTPS.

Using with GitHub Actions

This assumes that you have already a GitHub Actions workflow that builds and tests your project.

Add ftpsync to your project

git submodule add https://github.com/oefe/ftpsync.git

Also, make sure that your workflow checks out submodules:

 - name: Checkoutuses: actions/checkout@v2with:
submodules: true

Create a GitHub Secret to store your FTP password

On GitHub, go to your repository, "Settings", "Secrets". Click "New Secret", enter:

Name: FTP_PASSWORD
Value: your FTP password

And click "Add Secret"

Add a deployment step

Add a deployment step to your GitHub Actions workflow that builds your site:

 - name: Deployrun: ftpsync/ftpsync.py example.com --user myself --password "${{ secrets.FTP_PASSWORD }}"

This should come after the build and tests steps.

Replace "example.com" with the hostname of your FTP server.
Replace "myself" with your FTP username.
Depending on your build process, you may also have to specify the source directory using the --source option. The default ("public") is suitable for the Hugo static site generator.
Depending on your hosting provider, you may also have to specify the destination directory using the --destination option. The default is "html".

Commit any push your changes

When you are ready, commit and push your changes.

git commit -a -m "Add deployment via ftpsync"

Your GitHub Actions workflow should now deploy your site automatically.

The first deployment may take a while, as ftpsync has to upload the entire site. Future deployments should be much faster, as ftpsync will upload only new and changed files.

Example workflow

This is a complete example how to build and deploy using Hugo and ftpsync.

name: Buildon:
push:
branches: [ master ]jobs:
build:
runs-on: ubuntu-lateststeps:
- name: Checkoutuses: actions/checkout@v2with:
submodules: truefetch-depth: 0
- name: Setup Hugouses: peaceiris/actions-hugo@v2with:
hugo-version: '0.74.2'
- name: Buildrun: hugo --minifyenv:
HUGO_ENV: production
- name: Deployrun: ftpsync/ftpsync.py example.cpm --user myself --password "${{ secrets.FTP_PASSWORD }}"

ftpsync

A caching website uploader using FTPS

This is a tool to deploy web sites using FTPS.

Using with GitHub Actions

This assumes that you have already a GitHub Actions workflow that builds and tests your project.

Add ftpsync to your project

git submodule add https://github.com/oefe/ftpsync.git

Also, make sure that your workflow checks out submodules:

 - name: Checkoutuses: actions/checkout@v2with:
submodules: true

Create a GitHub Secret to store your FTP password

On GitHub, go to your repository, "Settings", "Secrets". Click "New Secret", enter:

Name: FTP_PASSWORD
Value: your FTP password

And click "Add Secret"

Add a deployment step

Add a deployment step to your GitHub Actions workflow that builds your site:

 - name: Deployrun: ftpsync/ftpsync.py example.com --user myself --password "${{ secrets.FTP_PASSWORD }}"

This should come after the build and tests steps.

Replace "example.com" with the hostname of your FTP server.
Replace "myself" with your FTP username.
Depending on your build process, you may also have to specify the source directory using the --source option. The default ("public") is suitable for the Hugo static site generator.
Depending on your hosting provider, you may also have to specify the destination directory using the --destination option. The default is "html".

Commit any push your changes

When you are ready, commit and push your changes.

git commit -a -m "Add deployment via ftpsync"

Your GitHub Actions workflow should now deploy your site automatically.

The first deployment may take a while, as ftpsync has to upload the entire site. Future deployments should be much faster, as ftpsync will upload only new and changed files.

Example workflow

This is a complete example how to build and deploy using Hugo and ftpsync.

name: Buildon:
push:
branches: [ master ]jobs:
build:
runs-on: ubuntu-lateststeps:
- name: Checkoutuses: actions/checkout@v2with:
submodules: truefetch-depth: 0
- name: Setup Hugouses: peaceiris/actions-hugo@v2with:
hugo-version: '0.74.2'
- name: Buildrun: hugo --minifyenv:
HUGO_ENV: production
- name: Deployrun: ftpsync/ftpsync.py example.cpm --user myself --password "${{ secrets.FTP_PASSWORD }}"

ftpsync

A caching website uploader using FTPS

This is a tool to deploy web sites using FTPS.

Using with GitHub Actions

This assumes that you have already a GitHub Actions workflow that builds and tests your project.

Add ftpsync to your project

git submodule add https://github.com/oefe/ftpsync.git

Also, make sure that your workflow checks out submodules:

 - name: Checkoutuses: actions/checkout@v2with:
submodules: true

Create a GitHub Secret to store your FTP password

On GitHub, go to your repository, "Settings", "Secrets". Click "New Secret", enter:

Name: FTP_PASSWORD
Value: your FTP password

And click "Add Secret"

Add a deployment step

Add a deployment step to your GitHub Actions workflow that builds your site:

 - name: Deployrun: ftpsync/ftpsync.py example.com --user myself --password "${{ secrets.FTP_PASSWORD }}"

This should come after the build and tests steps.

Replace "example.com" with the hostname of your FTP server.
Replace "myself" with your FTP username.
Depending on your build process, you may also have to specify the source directory using the --source option. The default ("public") is suitable for the Hugo static site generator.
Depending on your hosting provider, you may also have to specify the destination directory using the --destination option. The default is "html".

Commit any push your changes

When you are ready, commit and push your changes.

git commit -a -m "Add deployment via ftpsync"

Your GitHub Actions workflow should now deploy your site automatically.

The first deployment may take a while, as ftpsync has to upload the entire site. Future deployments should be much faster, as ftpsync will upload only new and changed files.

Example workflow

This is a complete example how to build and deploy using Hugo and ftpsync.

name: Buildon:
push:
branches: [ master ]jobs:
build:
runs-on: ubuntu-lateststeps:
- name: Checkoutuses: actions/checkout@v2with:
submodules: truefetch-depth: 0
- name: Setup Hugouses: peaceiris/actions-hugo@v2with:
hugo-version: '0.74.2'
- name: Buildrun: hugo --minifyenv:
HUGO_ENV: production
- name: Deployrun: ftpsync/ftpsync.py example.cpm --user myself --password "${{ secrets.FTP_PASSWORD }}"

ftpsync

A caching website uploader using FTPS

This is a tool to deploy web sites using FTPS.

Using with GitHub Actions

This assumes that you have already a GitHub Actions workflow that builds and tests your project.

Add ftpsync to your project

git submodule add https://github.com/oefe/ftpsync.git

Also, make sure that your workflow checks out submodules:

 - name: Checkoutuses: actions/checkout@v2with:
submodules: true

Create a GitHub Secret to store your FTP password

On GitHub, go to your repository, "Settings", "Secrets". Click "New Secret", enter:

Name: FTP_PASSWORD
Value: your FTP password

And click "Add Secret"

Add a deployment step

Add a deployment step to your GitHub Actions workflow that builds your site:

 - name: Deployrun: ftpsync/ftpsync.py example.com --user myself --password "${{ secrets.FTP_PASSWORD }}"

This should come after the build and tests steps.

Replace "example.com" with the hostname of your FTP server.
Replace "myself" with your FTP username.
Depending on your build process, you may also have to specify the source directory using the --source option. The default ("public") is suitable for the Hugo static site generator.
Depending on your hosting provider, you may also have to specify the destination directory using the --destination option. The default is "html".

Commit any push your changes

When you are ready, commit and push your changes.

git commit -a -m "Add deployment via ftpsync"

Your GitHub Actions workflow should now deploy your site automatically.

The first deployment may take a while, as ftpsync has to upload the entire site. Future deployments should be much faster, as ftpsync will upload only new and changed files.

Example workflow

This is a complete example how to build and deploy using Hugo and ftpsync.

name: Buildon:
push:
branches: [ master ]jobs:
build:
runs-on: ubuntu-lateststeps:
- name: Checkoutuses: actions/checkout@v2with:
submodules: truefetch-depth: 0
- name: Setup Hugouses: peaceiris/actions-hugo@v2with:
hugo-version: '0.74.2'
- name: Buildrun: hugo --minifyenv:
HUGO_ENV: production
- name: Deployrun: ftpsync/ftpsync.py example.cpm --user myself --password "${{ secrets.FTP_PASSWORD }}"

ftpsync

A caching website uploader using FTPS

This is a tool to deploy web sites using FTPS.

Using with GitHub Actions

This assumes that you have already a GitHub Actions workflow that builds and tests your project.

Add ftpsync to your project

git submodule add https://github.com/oefe/ftpsync.git

Also, make sure that your workflow checks out submodules:

 - name: Checkoutuses: actions/checkout@v2with:
submodules: true

Create a GitHub Secret to store your FTP password

On GitHub, go to your repository, "Settings", "Secrets". Click "New Secret", enter:

Name: FTP_PASSWORD
Value: your FTP password

And click "Add Secret"

Add a deployment step

Add a deployment step to your GitHub Actions workflow that builds your site:

 - name: Deployrun: ftpsync/ftpsync.py example.com --user myself --password "${{ secrets.FTP_PASSWORD }}"

This should come after the build and tests steps.

Replace "example.com" with the hostname of your FTP server.
Replace "myself" with your FTP username.
Depending on your build process, you may also have to specify the source directory using the --source option. The default ("public") is suitable for the Hugo static site generator.
Depending on your hosting provider, you may also have to specify the destination directory using the --destination option. The default is "html".

Commit any push your changes

When you are ready, commit and push your changes.

git commit -a -m "Add deployment via ftpsync"

Your GitHub Actions workflow should now deploy your site automatically.

The first deployment may take a while, as ftpsync has to upload the entire site. Future deployments should be much faster, as ftpsync will upload only new and changed files.

Example workflow

This is a complete example how to build and deploy using Hugo and ftpsync.

name: Buildon:
push:
branches: [ master ]jobs:
build:
runs-on: ubuntu-lateststeps:
- name: Checkoutuses: actions/checkout@v2with:
submodules: truefetch-depth: 0
- name: Setup Hugouses: peaceiris/actions-hugo@v2with:
hugo-version: '0.74.2'
- name: Buildrun: hugo --minifyenv:
HUGO_ENV: production
- name: Deployrun: ftpsync/ftpsync.py example.cpm --user myself --password "${{ secrets.FTP_PASSWORD }}"

ftpsync

A caching website uploader using FTPS

This is a tool to deploy web sites using FTPS.

Using with GitHub Actions

This assumes that you have already a GitHub Actions workflow that builds and tests your project.

Add ftpsync to your project

git submodule add https://github.com/oefe/ftpsync.git

Also, make sure that your workflow checks out submodules:

 - name: Checkoutuses: actions/checkout@v2with:
submodules: true

Create a GitHub Secret to store your FTP password

On GitHub, go to your repository, "Settings", "Secrets". Click "New Secret", enter:

Name: FTP_PASSWORD
Value: your FTP password

And click "Add Secret"

Add a deployment step

Add a deployment step to your GitHub Actions workflow that builds your site:

 - name: Deployrun: ftpsync/ftpsync.py example.com --user myself --password "${{ secrets.FTP_PASSWORD }}"

This should come after the build and tests steps.

Replace "example.com" with the hostname of your FTP server.
Replace "myself" with your FTP username.
Depending on your build process, you may also have to specify the source directory using the --source option. The default ("public") is suitable for the Hugo static site generator.
Depending on your hosting provider, you may also have to specify the destination directory using the --destination option. The default is "html".

Commit any push your changes

When you are ready, commit and push your changes.

git commit -a -m "Add deployment via ftpsync"

Your GitHub Actions workflow should now deploy your site automatically.

The first deployment may take a while, as ftpsync has to upload the entire site. Future deployments should be much faster, as ftpsync will upload only new and changed files.

Example workflow

This is a complete example how to build and deploy using Hugo and ftpsync.

name: Buildon:
push:
branches: [ master ]jobs:
build:
runs-on: ubuntu-lateststeps:
- name: Checkoutuses: actions/checkout@v2with:
submodules: truefetch-depth: 0
- name: Setup Hugouses: peaceiris/actions-hugo@v2with:
hugo-version: '0.74.2'
- name: Buildrun: hugo --minifyenv:
HUGO_ENV: production
- name: Deployrun: ftpsync/ftpsync.py example.cpm --user myself --password "${{ secrets.FTP_PASSWORD }}"

ftpsync

A caching website uploader using FTPS

This is a tool to deploy web sites using FTPS.

Using with GitHub Actions

This assumes that you have already a GitHub Actions workflow that builds and tests your project.

Add ftpsync to your project

git submodule add https://github.com/oefe/ftpsync.git

Also, make sure that your workflow checks out submodules:

 - name: Checkoutuses: actions/checkout@v2with:
submodules: true

Create a GitHub Secret to store your FTP password

On GitHub, go to your repository, "Settings", "Secrets". Click "New Secret", enter:

Name: FTP_PASSWORD
Value: your FTP password

And click "Add Secret"

Add a deployment step

Add a deployment step to your GitHub Actions workflow that builds your site:

 - name: Deployrun: ftpsync/ftpsync.py example.com --user myself --password "${{ secrets.FTP_PASSWORD }}"

This should come after the build and tests steps.

Replace "example.com" with the hostname of your FTP server.
Replace "myself" with your FTP username.
Depending on your build process, you may also have to specify the source directory using the --source option. The default ("public") is suitable for the Hugo static site generator.
Depending on your hosting provider, you may also have to specify the destination directory using the --destination option. The default is "html".

Commit any push your changes

When you are ready, commit and push your changes.

git commit -a -m "Add deployment via ftpsync"

Your GitHub Actions workflow should now deploy your site automatically.

The first deployment may take a while, as ftpsync has to upload the entire site. Future deployments should be much faster, as ftpsync will upload only new and changed files.

Example workflow

This is a complete example how to build and deploy using Hugo and ftpsync.

name: Buildon:
push:
branches: [ master ]jobs:
build:
runs-on: ubuntu-lateststeps:
- name: Checkoutuses: actions/checkout@v2with:
submodules: truefetch-depth: 0
- name: Setup Hugouses: peaceiris/actions-hugo@v2with:
hugo-version: '0.74.2'
- name: Buildrun: hugo --minifyenv:
HUGO_ENV: production
- name: Deployrun: ftpsync/ftpsync.py example.cpm --user myself --password "${{ secrets.FTP_PASSWORD }}"

ftpsync

A caching website uploader using FTPS

This is a tool to deploy web sites using FTPS.

Using with GitHub Actions

This assumes that you have already a GitHub Actions workflow that builds and tests your project.

Add ftpsync to your project

git submodule add https://github.com/oefe/ftpsync.git

Also, make sure that your workflow checks out submodules:

 - name: Checkoutuses: actions/checkout@v2with:
submodules: true

Create a GitHub Secret to store your FTP password

On GitHub, go to your repository, "Settings", "Secrets". Click "New Secret", enter:

Name: FTP_PASSWORD
Value: your FTP password

And click "Add Secret"

Add a deployment step

Add a deployment step to your GitHub Actions workflow that builds your site:

 - name: Deployrun: ftpsync/ftpsync.py example.com --user myself --password "${{ secrets.FTP_PASSWORD }}"

This should come after the build and tests steps.

Replace "example.com" with the hostname of your FTP server.
Replace "myself" with your FTP username.
Depending on your build process, you may also have to specify the source directory using the --source option. The default ("public") is suitable for the Hugo static site generator.
Depending on your hosting provider, you may also have to specify the destination directory using the --destination option. The default is "html".

Commit any push your changes

When you are ready, commit and push your changes.

git commit -a -m "Add deployment via ftpsync"

Your GitHub Actions workflow should now deploy your site automatically.

The first deployment may take a while, as ftpsync has to upload the entire site. Future deployments should be much faster, as ftpsync will upload only new and changed files.

Example workflow

This is a complete example how to build and deploy using Hugo and ftpsync.

name: Buildon:
push:
branches: [ master ]jobs:
build:
runs-on: ubuntu-lateststeps:
- name: Checkoutuses: actions/checkout@v2with:
submodules: truefetch-depth: 0
- name: Setup Hugouses: peaceiris/actions-hugo@v2with:
hugo-version: '0.74.2'
- name: Buildrun: hugo --minifyenv:
HUGO_ENV: production
- name: Deployrun: ftpsync/ftpsync.py example.cpm --user myself --password "${{ secrets.FTP_PASSWORD }}"

Name		Name	Last commit message	Last commit date
.github		.github
test-data		test-data
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
ftpsync.py		ftpsync.py
pyproject.toml		pyproject.toml
renovate.json		renovate.json
test_ftpsync.py		test_ftpsync.py
uv.lock		uv.lock

Name		Name	Last commit message	Last commit date
.github		.github
test-data		test-data
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
ftpsync.py		ftpsync.py
pyproject.toml		pyproject.toml
renovate.json		renovate.json
test_ftpsync.py		test_ftpsync.py
uv.lock		uv.lock

Name		Name	Last commit message	Last commit date
.github		.github
test-data		test-data
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
ftpsync.py		ftpsync.py
pyproject.toml		pyproject.toml
renovate.json		renovate.json
test_ftpsync.py		test_ftpsync.py
uv.lock		uv.lock

Name		Name	Last commit message	Last commit date
.github		.github
test-data		test-data
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
ftpsync.py		ftpsync.py
pyproject.toml		pyproject.toml
renovate.json		renovate.json
test_ftpsync.py		test_ftpsync.py
uv.lock		uv.lock

Name		Name	Last commit message	Last commit date
.github		.github
test-data		test-data
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
ftpsync.py		ftpsync.py
pyproject.toml		pyproject.toml
renovate.json		renovate.json
test_ftpsync.py		test_ftpsync.py
uv.lock		uv.lock

Latest commit

History

Folders and files

Repository files navigation

ftpsync

Using with GitHub Actions

Add ftpsync to your project

Create a GitHub Secret to store your FTP password

Add a deployment step

Commit any push your changes

Example workflow

About

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages

Latest commit

History

Folders and files

Repository files navigation

ftpsync

Using with GitHub Actions

Add ftpsync to your project

Create a GitHub Secret to store your FTP password

Add a deployment step

Commit any push your changes

Example workflow

About

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages

Latest commit

History

Folders and files

Repository files navigation

ftpsync

Using with GitHub Actions

Add ftpsync to your project

Create a GitHub Secret to store your FTP password

Add a deployment step

Commit any push your changes

Example workflow

About

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages

Latest commit

History

Folders and files

Repository files navigation

ftpsync

Using with GitHub Actions

Add ftpsync to your project

Create a GitHub Secret to store your FTP password

Add a deployment step

Commit any push your changes

Example workflow

About

Resources

Stars

Watchers

Forks

Releases