httpfile

Custom type for downloading files via HTTP and HTTPS

Module Stats

14,603 downloads

10,538 latest version

3.8 quality score

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

released Jul 20th 2015

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'KimNorgaard-httpfile', '0.1.9'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add KimNorgaard-httpfile

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install KimNorgaard-httpfile --version 0.1.9

Tags: file, http, checksum, md5

Documentation

KimNorgaard/httpfile — version 0.1.9 Jul 20th 2015

KimNorgaard-httpfile

Transfer files via HTTP(S).

Uses various methods to verify the checksum before actually fetching the file.

Basic Usage

    httpfile { '/path/to/file.ext':
      source                    => 'http://example.com/my_file.bin',
    }

By default, the Content-MD5 header is used to compare checksums. For apache, this can be achieved by setting the 'ContentDigest' directive to 'On'.

If you prefer to use sidecar files (i.e. .md5 or .sha1) placed on the server, you can do that by setting the checksum_type parameter.

Types in this module release

httpfile

Fetch a file using HTTP(S). Basic usage:

httpfile { '/path/to/file.ext':
  path                      => '/path/to/file.ext',
  source                    => 'http://example.com/my_file.bin',
  expected_checksum         => 'b96af7576939a17ac4b2d4b6edb50ce7',
  http_user                 => 'foo',
  http_pass                 => 'bar',
}

Parameters
checksum_type	The checksum type to use. Currenly only content_md5 is supported. Possible values are: `* content_md5 (32 bytes hex digest) - Content-MD5 header is used * sidecar_md5 (32 bytes hex digest) - sidecar md5 file is used * sidecar_sha1 (40 bytes hex digest) - sidecar sha1 file is used Default: content_md5'`
ensure
expected_checksum	The exptected checksum of the file. This option is mutually exclusive with quick_check.
force	Always download the file. Default: false.
http_open_timeout	Number of seconds to wait for the connection to open. `Default: none`
http_pass	HTTP Basic Auth Password.
http_post_form_data	HTTP POST Form Data (hash). Only used when setting http_vers to :post.
http_request_body	HTTP Request Body.
http_request_content_type	HTTP Request Content Type.
http_request_headers	HTTP Request Headers (Hash).
http_ssl_ca_file	Sets path of a CA certification file in PEM format.
http_ssl_ca_path	Sets path of a CA certification directory containing certifications in PEM format
http_ssl_cert	Sets path of a client certificate file in PEM format.
http_ssl_key	Sets path of a client key file in PEM format.
http_ssl_verify	Enable/disable HTTPS Certificate Verification. Default: true.
http_user	HTTP Basic Auth User.
http_verb	The HTTP verb to use (get or post). Default: get.
path	The destination path (including file name). Must be fully qualified.
print_progress	Whether to print download progress or not. Default: false.
provider
quick_check	Skips checksum comparison and relies solely on rsync style "quick checks" where we only compare the timestamp and size. Default: false.
sidecar_http_post_form_data	HTTP POST Form Data (hash) of sidecar file. Only used when setting http_vers to :post.
sidecar_http_request_headers	HTTP Request Headers of sidecar file (Hash).
sidecar_http_verb	The HTTP verb to use for sidecar files (get or post). Default: :http_verb value.
sidecar_source	Sidecar URL to use for fetching the expected checksum. If this parameter is not specified, it is assumed that the sidecar file is placed next to :source and is named with an appropriate extension (e.g. .md5 for sidecar_md5).
source	The url of the file to be fetched. http and https are supported.

Providers
ruby_net_http	Manage files fetched via HTTP.

The MIT License (MIT)

Copyright (c) 2013 KimNorgaard

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Modules

Discover

Contribute

Puppet

Premium features

Downloads

Resources

About Forge

Getting Started

httpfile

Contributions Requested

Support the Puppet Community by contributing to this module

Version information

Start using this module

Documentation

KimNorgaard-httpfile

Basic Usage

Types in this module release

httpfile