You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

71 lines
2.1 KiB

6 years ago
6 years ago
6 years ago
6 years ago
  1. [![Build Status](https://travis-ci.org/martialblog/puppet-limesurvey.svg?branch=master)](https://travis-ci.org/martialblog/puppet-limesurvey)
  2. # limesurvey
  3. #### Table of Contents
  4. 1. [Description](#description)
  5. 1. [Setup - The basics of getting started with limesurvey](#setup)
  6. * [Beginning with limesurvey](#beginning-with-limesurvey)
  7. 1. [Usage - Configuration options and additional functionality](#usage)
  8. 1. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
  9. 1. [Limitations - OS compatibility, etc.](#limitations)
  10. 1. [Development - Guide for contributing to the module](#development)
  11. ## Description
  12. This module installs Limesurvey from the limesurvey.org website..
  13. Optionally MySQL and Apache2 are installed and managed by this module. However, both classes can be overwritten.
  14. ## Setup
  15. ### Beginning with limesurvey
  16. Basically this module downloads the code from limesurey.org and places it into the specified directory.
  17. Without the database class included you need to install and manage the database by yourself. Same for the websever and PHP.
  18. ## Usage
  19. A basic example using both webserver and database
  20. ```puppet
  21. class { 'limesurvey':
  22. dbname => 'limesurvey',
  23. dbpassword => 'foobar',
  24. dbuser => 'lemongrab',
  25. sql_root_password => 'foobar',
  26. manage_webserver => false,
  27. }
  28. ```
  29. ## Reference
  30. ## Classes
  31. #### Public classes
  32. * [`limesurey::init`]: Installs and configures Limesurvey.
  33. * [`limesurey::extract`]: Downloads the code from limesurey.org
  34. * [`limesurey::config`]: Manages the configuration of Limesurvey.
  35. * [`limesurey::database`]: Installs and configures a MySQL database.
  36. * [`limesurey::webserver`]: Installs and configures an Apacha2 webserver.
  37. * [`limesurey::php`]: Installs the required PHP packages.
  38. For details on parameters see manifests
  39. ## Limitations
  40. This module has been tested on:
  41. * Debian 7, 8
  42. Using Puppet >=4.5
  43. The CentOS Build needs fixing, but the module should work.
  44. ## Development
  45. For further details see CONTRIBUTING.md
  46. ## Authors
  47. * Markus Opolka