Version information
This version is compatible with:
Start using this module
Add this module to your Puppetfile:
mod 'landcareresearch-ckan', '2.1.4'
Learn more about managing modules with a PuppetfileDocumentation
CKAN Puppet Module
About
This module installs, configures, and manages ckan.
Customizations such as site logo, about page, license, and
customized css are easily configurable from this module.
The ckan database is automatically backed up every day to
/backup/ckan_database.pg_dump.
Backup Notes
In order to backup the entire ckan installation, the database and the file store need to be included in your backup system. The following paths should be backed up.
- /backup/ckan_database.pg_dump
- /var/lib/ckan/default/resources
- /var/lib/ckan/default/storage
Recovery Notes
In order to recover from a data failure or to just install a new instance do the following as root.
. /usr/lib/ckan/default/bin/activate
cd /usr/lib/ckan/default/src/ckan
paster db clean --config=/etc/ckan/default/production.ini /backup/ckan_database.pg_dump
paster db load --config=/etc/ckan/default/production.ini /backup/ckan_database.pg_dump
Installation
The module can be obtained from the Puppet Forge. The easiest method for installation is to use the puppet-module tool. Run the following command from your modulepath:
puppet-module install landcareresearch/ckan
Requirements
In order to get all of the dependencies do the following:
- puppet module install landcareresearch-ckan
Other Requirements
-
Ubuntu 12.04 Operating System.
Note, Ubuntu 14.04 has been tested and currently does not install properly.
Classes
ckan
The class installs and manages a single instance of ckan. The ckan class is a paramaterized class.
Required Parameters within ckan
:
The parameters listed are required.
site_url
The url for the ckan site.
param site_title
The title of the web site.
site_description
The description (found in header) of the web site.
site_intro
The introduction on the landing page.
site_about
Information on the about page.
plugins
Contains the ckan plugins to be used by the installation.
DO NOT add extensions that are managed by puppet to this parameter. As of patch 1.0.12. All plugins for extensions are now handled in the ext modules.
Note,the following plugins have been tested.
- stats
- text_preview recline_preview
- datastore
- resource_proxy
- pdf_preview
app_instance_id
The secret password for the app instance which is populated in the production.ini file. Use paster make-config to generate a config file that contains a new password. Note, there should be a better method of generating the secrets
beaker_secret
The secret password for beaker which is populated in the production.ini file. Use paster make-config to generate a config file that contains a new password. Note, there should be a better method of generating the secrets
Optional Parameters within ckan
:
The parameters listed in this section can optionally be configured.
site_logo
The source of the logo. The logo format requires a png file.
Should be spedified as
puppet:///<your module>/<image>.png
license
The source to the license file. The license format requies a json file. Should be specified as
puppet:///<your module>/<license file>
and maintained by your module
ckan_version
Helps identify settings and configuration necessary between the different version of ckan.
Valid format: '2.2', '2.3', etc.
Note, ckan_package_url & ckan_package_filename are not set, than the ckan version will use the package url from ckan.org and the appropriate name.
Defaults to undef
is_ckan_from_repo
A boolean to indicate if the ckan package should be installed through an already configured repository setup outside of this module. If using Ubuntu/Deb, should be able to do "apt-get install python-ckan" Its the same idea for yum and other package managers (untested).
ckan_package_url
If not using a repo, then this url needs to be specified with the location to download the package. Note, this is using dpkg so deb/ubuntu only.
ckan_package_filename
The filename of the ckan package.
custom_css
The source to a css file used for the ckan site. This replaces the default main.css. Should be specified as
puppet:///<your module>/<css filename>
and maintained by your module.
Note, images used in the custom css should be set in custom_imgs.
custom_imgs
An array of source for the images to be used by the css. Only required if the custom_css uses new images.
Should be specified as
[ 'puppet:///<your module>/<img1>' , 'puppet:///<your module>/<img2>' , ... ]
recaptcha_publickey
The public key for recaptcha (by default not set).
recaptcha_privatekey
The private key for recaptcha (by default not set).
max_resource_size
The maximum in megabytes a resource upload can be. Default: 100
max_image_size
The maximum in megabytes an image upload can be. Default: 10
datapusher_formats
File formats that will be pushed to the DataStore by the DataPusher.
When adding or editing a resource which links to a file in one of these formats, the DataPusher
will automatically try to import its contents to the DataStore.
default_views
Defines the resource views that should be created by default when creating or updating a dataset. From this list only the views that are relevant to a particular resource format will be created. This is determined by each individual view. Default: image_view recline_view
preview_loadable
Depricated
preview_loadable
Defines the resource formats which should be loaded directly in an iframe tag when previewing them if no Data Viewer can preview it. Only used in CKAN version 2.2 and below. As of CKAN 2.3, use default_views
Defaults to 'html htm rdf+xml owl+xml xml n3 n-triples turtle plain atom csv tsv rss txt json'
text_formats
Formats used for the text preview
Defaults to not being set in the configuration (since its an empty string)
postgres_pass
The password for the postgres user of the database (admin user).
ckan_pass
The password for the ckan user of the database.
pg_hba_conf_defaults
True if use the default hbas and false to configure your own. This module uses puppetlabs/postgresql so this setting informs the postgresql module that the hba's should be handled outside of this module. Requires your own hba configuration.
install_ckanapi
Installs the ckan api if set to true. Default is false. Also installs a helper script in /usr/bin/ckan/ckanapi.bash which launches ckanapi with the environment setup. Additional information: https://github.com/ckan/ckanapi
enable_backup
Backs up the database to /backup/ckan_database.pg_dump. Default: true
backup_daily
If backups enabled, sets backups to either daily (true) or weekly (false). Default: true
solr_url
The base url for downloading solr. Default: 'http://apache.mirrors.lucidnetworks.net/lucene/solr'
solr_version
The version of solr to install. Default: '5.0.3'
solr_schema_version
The version of the solr schema to use. Valid options:
- '1.2'
- '1.3'
- '1.4'
- '2.0'
- 'spatial' - configures solar with the spatial extensions. Only supports bounding box.
- 'spatial-ext' - configures solar with the extended spatial extension. This allows for bounding box, point, and Polygon.
- 'default'
The options correspond to the following structure.
/usr/lib/ckan/default/src/ckan/ckan/config/solr/schema-<solr_schema_version>
The only exception is default which means schema.xml (required as of ckan 2.3).
jts_url
The url to be used to download the jts library for solr spatial ext. Only used if spatial-ext option is set. Default: uses version 1.13
locale_default
Use this to specify the locale (language of the text) displayed in the CKAN Web UI. Default: 'en'
i18n_directory
By default, the locales are searched for in the ckan/i18n directory. Use this option if you want to use another folder. Default: ''
ckan_storage_path
The location where files will be stored for the file store. Note, this module handles creating the directory; however, ensure the path leading up to the directory has already been created. Default: '/var/lib/ckan/default'
display_timezone
By default, all datetimes are considered to be in the UTC timezone. Use this option to change the displayed dates on the frontend. Internally, the dates are always saved as UTC. This option only changes the way the dates are displayed. The valid values for this options can be found at pytz Available from CKAN 2.5+ (has no effect on previous versions). Default: UTC
Extensions The following are classes that utialize the ckan modularization framework known as extensions.
ckan::ext::googleanalytics
Installs the "googleanalytics" extension, which sends tracking data to Google Analytics and retrieves statistics from Google Analytics and inserts them into CKAN pages.
Parameters within ckan::ext::googleanalytics
:
id
The Google Analytics tracking ID (usually of the form UA-XXXXXX-X).
account
The account name (e.g. example.com -- see the top-level item at https://www.google.com/analytics).
username
Google Analytics username.
password
Google Analytics password
track_events
Adds Google Analytics Event tracking. Default: false
ckan::ext::hierarchy
Installs the "hierarchy" extension from data.gov.uk, which allows organisations to have parents, and displays them in a tree.
Note, untested so probably needs some development effort.
ckan::ext::newzealand
Installs the Landcare Research extension. Also installs the following dependency extensions:
- ckan::ext::repeating
- ckan::ext::ldap
Parameters within ckan::ext::newzealand
:
uri
The uri to the ldap server to connect. Example: 'ldap://localhost:389'
base_dn
The ldap base dn to use for user authentication. Example: 'ou=users,dc=landcareresearch,dc=co,dc=nz'
organization_id
If this is set, users that log in using LDAP will automatically get added to the given organization.
ckan::ext::ldap
Installs the "ldap" extension.
Parameters within ckan::ext::ldap
:
uri
The uri to the ldap server to connect. Example: 'ldap://localhost:389'
base_dn
The ldap base dn to use for user authentication. Example: 'ou=users,dc=landcareresearch,dc=co,dc=nz'
search_filter
The filter for searching through identities in ldap. Default: 'uid={login}'
username
The user name to use as a lookup. Default: 'uid'
email
The field that contains the user's email address. Default: 'email'
fullname
The field that contains the user's full name. Default: cn'
organization_role
The role of the user when logged in through ldap. Default: member
organization_id
If this is set, users that log in using LDAP will automatically get added to the given organization.
To create the organisation specified in ckanext.ldap.organization.id use the paste command:
paster --plugin=ckanext-ldap ldap setup-org -c /etc/ckan/default/development.ini
ckan::ext::pdfview
Installs the "pdf_view" extension Note: if you want to enable pdf views of documents outside of the ckan instance, you will need to enable resource_proxy plugin.
ckan::ext::repeating
Installs the "repeating" extension.
This extension provides a way to store repeating fields in CKAN datasets, resources, organizations and groups.
ckan::ext::spatial
Installs the "spatial" extension, which allows for the association of datasets with geographic locations, and for searches across datasets to be restricted to a particular geographical area. Additionally, it provides some support for previewing geographical datasets.
See the plugin documentation for full details.
if $ckan::solr_schema_version == 'spatial-ext'{
Parameters within ckan::ext::spatial
:
default_extent
Sets the default extent for the map. Should be a string in the format:
'[[15.62, -139.21], [64.92, -61.87]]'
or GeoJSON
'{ \"type\":
\"Polygon\", \"coordinates\": [[[74.89, 29.39],[74.89, 38.45], [60.50,
38.45], [60.50, 29.39], [74.89, 29.39]]]}'
If undefined, will not set an extent. Default: undef
Manual Configuration
A systems admin account is still required to be created manually. If using Ubuntu, use the following command:
/usr/local/bin/ckan_create_admin.bash <username>
Usage
This section shows example uses of the ckan module.
Example 1
This example demonstrates the most basic usage of the ckan module.
class { 'ckan':
site_url => 'test.ckan.com',
site_title => 'CKAN Test',
site_description => 'A shared environment for managing Data.',
site_intro => 'A CKAN test installation',
site_about => 'Pilot data catalogue and repository.',
plugins => 'stats text_preview recline_preview datastore resource_proxy pdf_preview',
app_instance_id => '{xxxxxxxxxxxxxxxx}',
beaker_secret => 'xxxxxxxxxxxx',
is_ckan_from_repo => 'false',
ckan_package_url => 'http://packaging.ckan.org/python-ckan_2.2_amd64.deb',
ckan_package_filename => 'python-ckan_2.2_amd64.deb',
}
Example 2
This example demonstrates a customize the ckan module.
Declaring a class that manages the configuration files.
class {landcare_ckan::config: }
Declaring the ckan module with the customized parameters.
class { 'ckan':
site_url => 'test.ckan.zen.landcareresearch.co.nz',
site_title => 'Landcare Research Test CKAN Repository',
site_description => 'A shared environment for managing Landcare Research Data.',
site_intro => 'Welcome to the Landcare Research Pilot Data Repository. This is a trial installation of the CKAN software, for us to test ahead of (all going well) a wider company rollout.',
site_about => 'Pilot data catalogue and repository for [Landcare Research] (http://www.landcareresearch.co.nz)',
plugins => 'stats text_preview recline_preview datastore resource_proxy pdf_preview',
app_instance_id => '{xxxxxxxxxxxxxxxx}',
beaker_secret => 'xxxxxxxxxxxx',
site_logo => $landcare_ckan::config::logo_src,
license => $landcare_ckan::config::license_src,
is_ckan_from_repo => false,
ckan_package_url => 'http://packaging.ckan.org/python-ckan_2.2_amd64.deb',
ckan_package_filename => 'python-ckan_2.2_amd64.deb',
custom_css => $landcare_ckan::config::css_src,
custom_imgs => $landcare_ckan::config::custom_images_array,
require => Class['landcare_ckan::config'],
}
Class where the customized configuration files are managed
class landcare_ckan::config {
$img_dir = '/usr/lib/ckan/default/src/ckan/ckan/public/base/images'
$landcare_src = 'puppet:///modules/landcare_ckan'
$css_src = "$landcare_src/custom.css"
$background_img_src = "$landcare_src/LCR-ckan-homepage-background.jpg"
$custom_images_array = [$background_img_src]
$logo_filename = 'lcr_logo_white_sm.png'
$logo_src = "$landcare_src/$logo_filename"
$license = 'NZ_licenses_ckan.json'
$license_src = "$landcare_src/$license"
$backup_dir = '/backup',
}
Extensions
Requires 2 puppet runs to realize.
Deploying with Vagrant
Vagrant can be used to easily deploy the ckan module for testing or production environments. Vagrant was used for the development of the ckan module.
Vagrantfile
The following content should be copied to a clean Vagrantfile. Note, make sure to edit puppet.module_path with a path to where the ckan module and the ckan module dependencies are located.
# -*- mode: ruby -*-
# vi: set ft=ruby :
Vagrant.configure("2") do |config|
config.vm.box = "precise64"
config.vm.box = "ubuntu/precise64"
config.vm.network "private_network", ip: "192.168.33.10"
config.vm.provider "virtualbox" do |v|
v.memory = 2048
v.cpus = 1
end
config.vm.provision :shell, :path => "upgrade-puppet.sh"
config.vm.provision "puppet" do |puppet|
puppet.module_path = "</path to modules>/modules/"
puppet.manifests_path = "manifests"
puppet.manifest_file = "test-ckan.pp"
end
end
test-ckan.pp
This is the file that contains the declaration of the ckan module. The file test-ckan.pp should be created in project_home/manifests/.
class { 'ckan':
site_url => 'http://192.168.33.10',
site_title => 'CKAN Test',
site_description => 'A shared environment for managing Data.',
site_intro => 'A CKAN test installation',
site_about => 'Pilot data catalogue and repository.',
plugins => 'stats text_preview recline_preview datastore resource_proxy pdf_preview',
app_instance_id => '{xxxxxxxxxxxxxxxx}',
beaker_secret => 'xxxxxxxxxxxx',
is_ckan_from_repo => false,
ckan_package_url => 'http://packaging.ckan.org/python-ckan_2.2_amd64.deb',
ckan_package_filename => 'python-ckan_2.2_amd64.deb',
pg_hba_conf_defaults => true,
}
upgrade-puppet.sh
This file manages installing the latest puppet from puppetlabs and updates apt-get The file upgrade-puppet.sh should be created in project_home/ (same directory as the Vagrantfile).
#!/bin/bash
DISTRIB_CODENAME=$(lsb_release --codename --short)
DEB="puppetlabs-release-${DISTRIB_CODENAME}.deb"
DEB_PROVIDES="/etc/apt/sources.list.d/puppetlabs.list" # Assume that this file's existence means we have the Puppet Labs repo added
if [ ! -e $DEB_PROVIDES ]
then
apt-get install --yes lsb-release
# Print statement useful for debugging, but automated runs of this will interpret any output as an error
# print "Could not find $DEB_PROVIDES - fetching and installing $DEB"
wget -q http://apt.puppetlabs.com/$DEB
sudo dpkg -i $DEB
sudo apt-get update
sudo apt-get install --yes puppet
fi
Usage
In the project directory (vagrant directory),
- Run vagrant: vagrant up
- Wait for vagrant to finish deploying and installing ckan Basically, wait for the console to return. You will see the following line:
notice: Finished catalog run in 648.91 seconds
- Open a web browser and enter the following url http://192.168.33.10
Limitations
Only works with debian based OS's.
Development
The module is Free and Open Source Software. Its available on bitbucket. Please fork!
Changed
2015-10-30 Release 2.1.4
Summary
Minor changes
Changed
- Added the json_formats and xml_formats for the configuration file.
- Text Formats will always be added to configuration.
- Changed recaptcha public/private defaults to undef.
- Updated for future parser compliance (puppet 4)
2015-09-xx Release 2.1.0
Summary
Enabling ckan version 2.3
Changed
- Added default_locale param for ckan configuration
- Added ckan.i18n_directory param for ckan configuration
- Added support for 2.3 changes like preview vrs new view system
- Upgraded Landcare Research ext to lcrnz
- Added repeating extension
- Added ldap extension
- Enabled the storage path of the file store to be set by module.
- Updated to using Solr 5.x
- Enabled both solr and solr-spatial-field for the backend to spatiel search.
2015-04-02 Releaes 2.0.1
Summary
Postgresql Password hash
Changed
- The changed to using the postgresql password hash function.
- Added ckan version specifing the version of ckan to use.
2015-03-23 Releaes 2.0.0
Summary
Solr integration
NOTE
Due to a change of how the database is initialized, upgrading from previous version of this module will re-initialize your database!!!! This means, you need to backup the database before doing this upgrade.
To recover your database use the following command (make sure you sudo su first)
paster --plugin=ckan db clean --config=/etc/ckan/default/production.ini ckan_database.pg_dump
paster --plugin=ckan db load --config=/etc/ckan/default/production.ini ckan_database.pg_dump
Changed
- Added the landcareresearch/solr puppet module.
- Tested with solr 4.10.3.
- Database initialization is now moved to a bash script in /usr/local/bin
- Added a solr schema parameter that instructs which schema version to use.
2015-03-04 Release 1.0.13
Summary
Account Migration
Changed
- Migrated from github to bitbucket
- Changed ownership of puppetforge account
- Added openhub badge to readme.
- Migrated changelog into md format.
- Changed ckan_run dependancy to landcareresearch account.
Fixes
- Output of new CKAN Fact now correctly reports if the /etc/ckan/plugins.out file doesn't exist.
2015-02-16 Version 1.0.12
Summary
Ext Plugin Reworked
Changes
- Including extension plugins in the plugins parameter caused the module to fail due to a depedancy on the extension to already be installed prior to ckan started. This patch incorperates the plugin into the extension so the extension plugins no longer need to be set via the plugin option. It will require 2 puppet runs in order to bring the extensions online though (there isn't any way around this that I know of).
2015-01-29 Version 1.0.11
Summary
Hot Fix
Fixes:
- Added ckan user password string to ckan.ini.
- Added puppetforge badge
2015-01-28 Version 1.0.10
Summary
Minor Changes
Features
- Added an option to enable event tracking for the Google Analystics which pushes events every hour
- Added a convience script for creating admin accounts.
Fixes
- Cleaned up code
- Added documentation for ckan::config
- Added configuration for backup directory
- Added configuration for ckan database password
2015-01-14 Version 1.0.9
Summary
Added ckanapi support
Features
- The ckanapi can now be installed (optional)
- A helper script for calling ckanapi command line tool
2015-01-08 Version 1.0.8
Summary
Quality Control
Fixes
- Cleaned up the code based on puppet-lint (via puppetlinter.com)
- Enabled github hook for puppetlinter so future commits are checked and reported
2015-01-07 Version 1.0.7
Summary
Fixed a recent security exploit that has effected CKAN sites globally
Fixes
- Set the security settings to restrict anonymous users from creating groups and datasets
- Set the default backend for spatial search to solr in the spatial search extension
- Changed backups from weekly to daily
2014-11-12 Version 1.0.6
Summary:
CKAN Developers have added a new submodule for managing CKAN extensions.
Features
- Added ckan::ext submodule
- Added Google Analytics extension
- Added Hierarchy extesion
- Added New Zealand Landcare extension
- Added Spatial extension
- Updated to using metadata.json
2014-08-13 Version 1.0.5
Summary
A CKAN Developer has cleaned up the module and prepared for ckan extensions.
Features
- Removed apache module dependency
- Removed module stage complexity with anchor pattern
- Removed hard coded security keys from production.ini.erb
- Added security keys to module parameters
2014-07-23 Version 1.0.4
Summary
Updated Dependencies
Features
- Removed the reset_apt module as vagrant can handle updating puppet with a recomended script
- Updated to the latest apache module which has the necessary changes integrated
- Changed default value of the apache headers variable
2014-06-09 Version 1.0.3
Features
- Added dependancy for Debian/Ubuntu based systems only
- Updated readme with new installation parameters
- Added Server admin's email specified
- Added recaptcha support
- Added max_resource_size parameter
- Added data pusher formats
- Added apache head configuration (in order to control search engine crawlers) and is optional
- Added the postgres password as a parameter
- Added postgres hba configuration to pass in as a parameter
2014-06-08 Version 1.0.2
Summary
Minor bug fixes and supports CKAN 2.2 package version
Features
- Fixed a bug if the license was left off, caused errors in datastore
- Added support for CKAN 2.2 package
2014-01-15 Version 1.0.1
Summary
Minor bug fix when deploying outside of a Vagrant environment
Features
- Added a parameter to disable the apt reset
Fixes
- Removed puppetlabs-apt and apt::ppa which was causing dependency loops if a class outside of ckan required apt::ppa
- Removed ppa for nodejs & ubuntugis
- Added puppetlabs-nodejs class
- Added dependency for puppetlabs-nodejs
Version 1.0.0
Summary
Initial Release.
Dependencies
- puppetlabs/concat (>= 1.1.0)
- puppetlabs/stdlib (>= 4.5.0)
- puppetlabs/nodejs (>= 0.4.0)
- puppetlabs/postgresql (>= 4.5.0)
- puppetlabs/apt (>= 2.1.1)
- puppetlabs/vcsrepo (>= 1.1.0)
- maestrodev/wget (>= 1.3.0)
- landcareresearch/check_run (>= 0.3.0)
- landcareresearch/solr (>= 0.3.4)
- landcareresearch/postgis (>= 0.1.3)
GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>. Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: <program> Copyright (C) <year> <name of author> This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <http://www.gnu.org/licenses/>. The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <http://www.gnu.org/philosophy/why-not-lgpl.html>.