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.

67 lines
1.9 KiB

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