Skip to content

Latest commit

 

History

History
120 lines (89 loc) · 3.33 KB

README.md

File metadata and controls

120 lines (89 loc) · 3.33 KB
Raw

puppet-thumbor

Build Status Puppet Forge Puppet Forge

Table of Contents

  1. Overview
  2. Requirements
  3. Usage
  4. Reference
  5. Development

Overview

Puppet module to deploy and manage Thumbor.

Requirements

  • A supported version of Puppet
  • A platform/distribution where Python 3.8+ is readily available
  • Only Thumbor 7+ is supported
  • EPEL repositories on RHEL-based distributions

Usage

Basic usage

Install Thumbor in your environment:

class { 'thumbor':
  ports        => [ '8000' ],
  security_key => 'AAAAABBBBCCCCC111112222233333',
}

Next run a simple test on the same machine to verify that Thumbor is working as expected:

curl -v http://localhost:8000/unsafe/200x200/https%3A%2F%2Fgithub.com%2Fthumbor%2Fthumbor%2Fraw%2Fmaster%2Fexample.jpg

It is also supported to run multiple instances and to customize various installation parameters:

class { 'thumbor':
  config       => {
    'AUTO_WEBP'               => true,
    'ENGINE_THREADPOOL_SIZE'  => 4,
    'HTTP_LOADER_MAX_CLIENTS' => 1024,
  },
  listen       => '127.0.0.1',
  ports        => [ '8000', '8001', '8002' ],
  security_key => 'AAAAABBBBCCCCC111112222233333',
  version      => '7.0.9',
}

Python venv

It is possible to run Thumbor in a Python venv and configure various aspects of the Python installation:

class { 'thumbor':
  manage_python  => true,
  ports          => [ '8000' ],
  python_config  => {
    version => 'python3',
    pip     => 'present',
    dev     => 'present',
    venv    => 'present',
  },
  security_key   => 'AAAAABBBBCCCCC111112222233333',
  update_enabled => true,
  venv_path      => '/opt/thumbor_venv',
}

This configuration will also automatically update the Python venv to the specified version (if necessary).

Plugins

Additional Thumbor plugins may also be installed via PIP:

class { 'thumbor':
  plugins => [ 'opencv-python', 'tc_aws', 'thumbor_spaces' ],
  ...
}

Updating Thumbor

When using the default configuration, the module will only install the currently available version of Thumbor. In order to update Thumbor, the $version parameter must be changed:

class { 'thumbor':
  version        => '7.1.0',
  update_enabled => true,
  ...
}

The value is directly passed through to the pip defined type. All values supported by this defined type may be used.

Reference

Classes and parameters are documented in REFERENCE.md.

Development

Contributing

Please use the GitHub issues functionality to report any bugs or requests for new features. Feel free to fork and submit pull requests for potential contributions.