sommerfeldio/ftp-client repository overview

⁠sommerfeldio/ftp-client

The sommerfeldio/ftp-client image ships with NCFTP and uses ncftpput⁠ for FTP uploads.

• sommerfeldio/ftp-client⁠ on Docker Hub
• Dockerfile source code⁠ on GitHub
• How to Contribute⁠
• Visit the projects documentation page⁠ for a list of all available container images.

⁠Software Tags and Versioning

Learn about our tagging policy and the difference between rolling tags and immutable tags on our documentation page⁠⁠.

⁠Software Bill of Materials (SBOM)

Starting with version 0.25.2, a Software Bill of Materials (SBOM) in SPDX format is generated for every image at build time and attached directly to the image in Docker Hub as an OCI attestation, available for the edge, latest and versioned tags. Retrieve it with

• docker scout sbom sommerfeldio/ftp-client:latest or
• docker buildx imagetools inspect sommerfeldio/ftp-client:latest --format "{{ json .SBOM }}".

The same SBOM is also attached as a downloadable asset on each GitHub release⁠.

⁠How to use this image

To use the image run the following command from a bash file.

FTP_HOST="ftp-host.example.com"
FTP_USER="the_username"
FTP_PASS="the_password"
# CAUTION: Storing credentials in variables like
# this is not a recommended way to handle secrets

docker run -i --rm \
    --volume "$(pwd):$(pwd)" \
    --workdir "$(pwd)" \
    sommerfeldio/ftp-client:latest ncftpput -R -v -u "$FTP_USER" -p "$FTP_PASS" "$FTP_HOST" / ./*

⁠License

This container image is inheriting the MIT License from the GitHub repository⁠.

The NCFTP software included within the image as a dependency is licensed under the Clarified Artistic License⁠.

The Clarified Artistic License is generally considered compatible with the MIT License. Both licenses are permissive open-source licenses, meaning they allow the software to be freely used, modified, and redistributed.

This means:

• MIT License: You are free to use, modify, and distribute this image, provided that you include the original MIT license text and give appropriate attribution to the author(s).
• Clarified Artistic License: The included software under this license remains unmodified. If you modify the included dependency under the Clarified Artistic License, ensure that any changes are clearly distinguished from the original work.