├── travis ├── foreman.yml ├── katello.yml └── Dockerfile.centos-7 ├── tasks ├── main.yml ├── facts.yml ├── packages.yml ├── upgrade.yml ├── module_pr.yml ├── installer.yml ├── ha-extras.yml ├── katello-server-certs.yml └── katello-proxy-certs.yml ├── templates ├── encryption_key.rb.j2 ├── scenario-answers.yaml.j2 ├── foreman_installer.fact.rb.j2 └── custom-hiera.yaml.j2 ├── meta └── main.yml ├── defaults └── main.yml ├── handlers └── main.yml ├── .travis.yml ├── README.md └── LICENSE /travis/foreman.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: localhost, 3 | vars: 4 | foreman_installer_scenario: foreman 5 | foreman_installer_scenarios_answers: 6 | foreman: 7 | admin_password: changeme 8 | roles: 9 | - ../../sean797.foreman_installer 10 | -------------------------------------------------------------------------------- /travis/katello.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: localhost, 3 | vars: 4 | foreman_installer_scenario: katello 5 | foreman_installer_pkg: katello 6 | foreman_installer_scenarios_answers: 7 | foreman: 8 | admin_password: changeme 9 | roles: 10 | - ../../sean797.foreman_installer 11 | -------------------------------------------------------------------------------- /tasks/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - include_tasks: packages.yml 3 | 4 | # Dev use only 5 | - include_tasks: module_pr.yml 6 | when: foreman_installer_module_prs is defined 7 | 8 | - include_tasks: facts.yml 9 | 10 | - include_tasks: installer.yml 11 | 12 | - include_tasks: upgrade.yml 13 | when: foreman_installer_upgrade == True 14 | 15 | - include_tasks: ha-extras.yml 16 | tags: 17 | - ha_extras 18 | -------------------------------------------------------------------------------- /tasks/facts.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Create facts directory 3 | file: 4 | path: /etc/ansible/facts.d 5 | recurse: yes 6 | state: directory 7 | 8 | - name: Write /etc/ansible/facts.d/foreman_installer.fact 9 | template: 10 | src: templates/foreman_installer.fact.rb.j2 11 | dest: /etc/ansible/facts.d/foreman_installer.fact 12 | mode: 0755 13 | notify: 14 | - reload ansible_local 15 | 16 | - name: run notified handlers 17 | meta: flush_handlers 18 | -------------------------------------------------------------------------------- /templates/encryption_key.rb.j2: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # Your encryption key for encrypting and decrypting database fields. 4 | # If you change this key, all encrypted data will NOT be able to be decrypted by Foreman! 5 | # Make sure the key is at least 32 bytes such as SecureRandom.hex(20) 6 | 7 | # You can use `rake security:generate_encryption_key` to regenerate this file. 8 | 9 | module EncryptionKey 10 | ENCRYPTION_KEY = "{{ foreman_installer_encryption_key }}" 11 | end 12 | -------------------------------------------------------------------------------- /templates/scenario-answers.yaml.j2: -------------------------------------------------------------------------------- 1 | # Format: 2 | # : false - don't include this class 3 | # : true - include and use the defaults 4 | # : 5 | # : - include and override the default(s) 6 | # 7 | # See params.pp in each class for what options are available 8 | 9 | --- 10 | {% set answers = ansible_local.foreman_installer[foreman_installer_scenario~'_answers'] | combine(foreman_installer_scenarios_answers, recursive=True) %} 11 | {{ answers | to_nice_yaml(indent=2) | indent(width=2, indentfirst=True) }} 12 | -------------------------------------------------------------------------------- /tasks/packages.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: "Install {{ foreman_installer_pkg }}" 3 | package: 4 | name: "{{ foreman_installer_pkg }}" 5 | state: "{{ foreman_installer_pkg_state }}" 6 | notify: 7 | - reload ansible_local 8 | - 'set dont_save_answers to False' 9 | - Workaround 18818 10 | 11 | - name: Apply installer fixes 12 | patch: 13 | src: "{{ item.src }}" 14 | basedir: "{{ item.basedir }}" 15 | strip: "{{ item.strip | default(1) }}" 16 | with_items: "{{ foreman_installer_patches }}" 17 | when: foreman_installer_patches is defined 18 | -------------------------------------------------------------------------------- /meta/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | galaxy_info: 3 | author: Sean O'Keeffe 4 | description: Interacts with foreman-installer/satellite-installer to build Foreman, Katello, Satllite 6, Capsules or Smart Proxies. 5 | issue_tracker_url: https://github.com/sean797/ansible-role-foreman_installer/issues 6 | license: GPLv2 7 | min_ansible_version: 2.4 8 | platforms: 9 | - name: EL 10 | versions: 11 | - 7 12 | - name: Debian 13 | versions: 14 | - jessie 15 | - name: Ubuntu 16 | versions: 17 | - xenial 18 | - trusty 19 | galaxy_tags: 20 | - theforeman 21 | - foreman 22 | - katello 23 | - satellite 24 | - satellite6 25 | - sat6 26 | - installer 27 | - cloud 28 | - system 29 | dependencies: [] 30 | -------------------------------------------------------------------------------- /tasks/upgrade.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: 'Update packages' 3 | yum: 4 | name: '*' 5 | update_cache: yes 6 | state: latest 7 | when: ansible_os_family == "RedHat" 8 | notify: 9 | - 'set dont_save_answers to False' 10 | - execute foreman-installer 11 | - reload ansible_local 12 | - rewrite answers file 13 | tags: 14 | - skip_ansible_lint 15 | 16 | - name: 'Update sources' 17 | apt: 18 | update_cache: yes 19 | when: ansible_os_family == "Debian" or ansible_os_family == "Ubuntu" 20 | 21 | - name: 'Update packages' 22 | apt: 23 | upgrade: dist 24 | when: ansible_os_family == "Debian" or ansible_os_family == "Ubuntu" 25 | notify: 26 | - 'set dont_save_answers to False' 27 | - execute foreman-installer 28 | - reload ansible_local 29 | - rewrite answers file 30 | -------------------------------------------------------------------------------- /templates/foreman_installer.fact.rb.j2: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | 3 | require 'json' 4 | require 'yaml' 5 | 6 | def last_scenario 7 | if File.exists? ("/etc/foreman-installer/scenarios.d/last_scenario.yaml") 8 | path = File.readlink('/etc/foreman-installer/scenarios.d/last_scenario.yaml') 9 | File.basename(path,File.extname(path)) 10 | end 11 | end 12 | 13 | def get_answers(scenario=last_scenario) 14 | if File.exists? ("/etc/foreman-installer/scenarios.d/#{scenario}-answers.yaml") 15 | yaml = YAML.load_file("/etc/foreman-installer/scenarios.d/#{scenario}-answers.yaml") 16 | end 17 | end 18 | 19 | output = {} 20 | output['last_scenario'] = last_scenario if last_scenario 21 | output["{{ foreman_installer_scenario }}_answers"] = get_answers("{{ foreman_installer_scenario }}") if get_answers("{{ foreman_installer_scenario }}") 22 | 23 | puts JSON.pretty_generate(output) 24 | -------------------------------------------------------------------------------- /templates/custom-hiera.yaml.j2: -------------------------------------------------------------------------------- 1 | --- 2 | # This YAML file lets you set your own custom configuration in Hiera for the 3 | # installer puppet modules that might not be exposed to users directly through 4 | # installer arguments. 5 | # 6 | # For example, to set 'TraceEnable Off' in Apache, a common requirement for 7 | # security auditors, add this to this file: 8 | # 9 | # apache::trace_enable: Off 10 | # 11 | # Consult the full module documentation on http://forge.puppetlabs.com, 12 | # or the actual puppet classes themselves, to discover options to configure. 13 | # 14 | # Do note, setting some values may have unintended consequences that affect the 15 | # performance or functionality of the application. Consider the impact of your 16 | # changes before applying them, and test them in a non-production environment 17 | # first. 18 | {% for key, value in foreman_installer_custom_hiera.items() -%} 19 | {{ key }}: {{ value }} 20 | {% endfor -%} 21 | -------------------------------------------------------------------------------- /tasks/module_pr.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: "Determine if Puppet 4 is used" 3 | stat: 4 | path: /opt/puppetlabs/puppet/bin/gem 5 | register: puppetlabs_gem 6 | 7 | - name: "Install gems to rebuild the kafo module cache" 8 | gem: 9 | name: "{{ item }}" 10 | executable: /opt/puppetlabs/puppet/bin/gem 11 | with_items: 12 | - yard 13 | - puppet-strings 14 | - rgen # https://tickets.puppetlabs.com/browse/PDOC-168 15 | when: puppetlabs_gem.stat.exists 16 | tags: 17 | - packages 18 | 19 | - name: "install git" 20 | package: 21 | name: 'git' 22 | state: 'present' 23 | 24 | - name: "install module PR into installer directory" 25 | shell: > 26 | cd {{ (item.split("/")[0] == 'theforeman') | ternary("/usr/share/foreman-installer/modules", "/usr/share/katello-installer-base/modules") }} && 27 | rm -rf {{ item.split("/")[1] }} && 28 | git clone https://github.com/{{ item.split("/")[0] }}/puppet-{{ item.split("/")[1] }} {{ item.split("/")[1] }} && 29 | cd {{ item.split("/")[1] }} && 30 | git fetch origin pull/{{ item.split("/")[2] }}/head:pr && 31 | git {{ foreman_installer_module_prs_strategy }} pr 32 | with_items: "{{ foreman_installer_module_prs.split(',') }}" 33 | tags: 34 | - packages 35 | - skip_ansible_lint 36 | -------------------------------------------------------------------------------- /tasks/installer.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Check Scenario isn't being changed 3 | fail: 4 | msg: Currently we cannot change to a different Scenario. 5 | when: 6 | - ansible_local.foreman_installer.last_scenario is defined 7 | - ansible_local.foreman_installer.last_scenario != foreman_installer_scenario 8 | 9 | - name: run notified handlers 10 | meta: flush_handlers 11 | 12 | - include_tasks: katello-server-certs.yml 13 | when: 14 | - foreman_installer_katello_cert is defined 15 | - foreman_installer_scenario == 'katello' or foreman_installer_scenario == 'foreman' or foreman_installer_scenario == 'satellite' 16 | 17 | - include_tasks: katello-proxy-certs.yml 18 | when: 19 | - foreman_installer_scenario == 'capsule' or foreman_installer_scenario == 'foreman-proxy-content' 20 | - foreman_installer_generate_proxy_certs_from is defined 21 | 22 | - name: Write /etc/foreman-installer/custom-hiera.yaml 23 | template: 24 | src: templates/custom-hiera.yaml.j2 25 | dest: /etc/foreman-installer/custom-hiera.yaml 26 | owner: root 27 | group: root 28 | mode: 0644 29 | when: foreman_installer_custom_hiera is defined 30 | notify: 31 | - execute foreman-installer 32 | 33 | - name: "Write /etc/foreman-installer/scenarios.d/{{ foreman_installer_scenario }}-answers.yaml" 34 | template: 35 | src: templates/scenario-answers.yaml.j2 36 | dest: "/etc/foreman-installer/scenarios.d/{{ foreman_installer_scenario }}-answers.yaml" 37 | owner: root 38 | group: root 39 | mode: 0600 40 | notify: 41 | - reload ansible_local 42 | - rewrite answers file 43 | - execute foreman-installer 44 | -------------------------------------------------------------------------------- /travis/Dockerfile.centos-7: -------------------------------------------------------------------------------- 1 | FROM centos:7 2 | 3 | ARG ansible_version 4 | ENV ansible_version=$ansible_version 5 | ARG foreman_version 6 | ENV foreman_version=$foreman_version 7 | ARG katello_version 8 | ENV katello_version=$katello_version 9 | 10 | # Install systemd -- See https://hub.docker.com/_/centos/ 11 | RUN yum -y swap -- remove fakesystemd -- install systemd systemd-libs 12 | RUN yum -y update; \ 13 | (cd /lib/systemd/system/sysinit.target.wants/; for i in *; do [ $i == systemd-tmpfiles-setup.service ] || rm -f $i; done); \ 14 | rm -f /lib/systemd/system/multi-user.target.wants/*; \ 15 | rm -f /etc/systemd/system/*.wants/*; \ 16 | rm -f /lib/systemd/system/local-fs.target.wants/*; \ 17 | rm -f /lib/systemd/system/sockets.target.wants/*udev*; \ 18 | rm -f /lib/systemd/system/sockets.target.wants/*initctl*; \ 19 | rm -f /lib/systemd/system/basic.target.wants/*; \ 20 | rm -f /lib/systemd/system/anaconda.target.wants/*; 21 | 22 | RUN yum -y install epel-release https://yum.puppetlabs.com/puppet5/puppet5-release-el-7.noarch.rpm https://yum.theforeman.org/releases/$foreman_version/el7/x86_64/foreman-release.rpm 23 | RUN if [ "$katello_version" != "" ]; then yum -y install https://fedorapeople.org/groups/katello/releases/yum/$katello_version/katello/el7/x86_64/katello-repos-latest.rpm ; fi 24 | RUN yum -y install git python-pip sudo 25 | RUN if [ "$ansible_version" = "latest" ]; then pip install ansible; else pip install ansible==$ansible_version; fi 26 | RUN pip install ansible-lint urllib3 pyOpenSSL ndg-httpsclient pyasn1 27 | 28 | RUN sed -i -e 's/^\(Defaults\s*requiretty\)/#--- \1/' /etc/sudoers 29 | 30 | VOLUME ["/sys/fs/cgroup"] 31 | 32 | CMD ["/usr/sbin/init"] 33 | EXPOSE 443 34 | -------------------------------------------------------------------------------- /defaults/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | foreman_installer_pkg: foreman-installer 3 | foreman_installer_pkg_state: present 4 | foreman_installer_verbose: False 5 | foreman_installer_scenario: foreman 6 | foreman_installer_options: [] 7 | foreman_installer_custom_hiera: {} 8 | foreman_installer_scenarios_answers: {} 9 | foreman_installer_upgrade: False 10 | 11 | ## Custom Certs. Katello only 12 | foreman_installer_katello_certs_dir: /root/certs 13 | #foreman_installer_katello_ca: 14 | #katello_cert: 15 | #foreman_installer_katello_key: 16 | #foreman_installer_katello_csr: 17 | foreman_installer_update_certs: False 18 | foreman_installer_update_certs_tar: False 19 | 20 | ## Advanced Options 21 | # foreman_installer_patches: 22 | # - { src: files/proxy.patch, basedir: /usr/share/katello-installer-base/modules/pulp/ } 23 | # 24 | ## Generally you only need these if you are building a Foreman cluster. 25 | # foreman_installer_encryption_key: 26 | # Group name contain all the Katello servers in a cluster 27 | # foreman_installer_katello_cluster_group: 28 | 29 | ## Development use 30 | # Comma-separated list of "organization/module/pr_number", e.g. "katello/foreman_proxy_content/37,katello/certs/34" 31 | #foreman_installer_module_prs: "" 32 | foreman_installer_module_prs_strategy: merge 33 | 34 | ## Internal Only 35 | cert_generate_command: "{{ (foreman_installer_scenario == 'capsule') | ternary('capsule-certs-generate', 'foreman-proxy-certs-generate') }}" 36 | cert_generate_fqdn_opt: "{{ (foreman_installer_scenario == 'capsule') | ternary('capsule-fqdn', 'foreman-proxy-fqdn') }}" 37 | certs_puppet_module: "{{ (foreman_installer_scenario == 'capsule') | ternary('capsule', 'foreman_proxy_content') }}" 38 | dont_save_answers: True 39 | -------------------------------------------------------------------------------- /handlers/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # http://projects.theforeman.org/issues/18818 3 | - name: Workaround 18818 4 | command: > 5 | foreman-installer --scenario "{{ foreman_installer_scenario }}" --migrations-only > /dev/null 6 | changed_when: False 7 | when: foreman_installer_scenario == "foreman-proxy-content" 8 | 9 | - name: restart httpd 10 | service: 11 | name: httpd 12 | state: restarted 13 | 14 | - name: 'set foreman_installer_update_certs to True' 15 | set_fact: 16 | foreman_installer_update_certs: True 17 | when: certs_stat.results[0].stat.exists or certs_stat.results[1].stat.exists or certs_stat.results[2].stat.exists 18 | 19 | - name: 'set dont_save_answers to False' 20 | set_fact: 21 | dont_save_answers: False 22 | 23 | - name: write answers file 24 | template: 25 | src: templates/scenario-answers.yaml.j2 26 | dest: "/etc/foreman-installer/scenarios.d/{{ foreman_installer_scenario }}-answers.yaml" 27 | owner: root 28 | group: root 29 | mode: 0600 30 | notify: 31 | - reload ansible_local 32 | 33 | - name: execute foreman-installer 34 | command: > 35 | foreman-installer {{ (foreman_installer_verbose == True) | ternary("-v", "") }} 36 | --scenario "{{ foreman_installer_scenario }}" 37 | {{ (dont_save_answers == True) | ternary("--dont-save-answers", "") }} 38 | {{ (foreman_installer_update_certs == True and foreman_installer_update_certs_tar == False) | ternary("--certs-update-server --certs-update-server-ca", "") }} 39 | {{ (foreman_installer_update_certs == True and foreman_installer_update_certs_tar == True) | ternary("--certs-update-server", "") }} 40 | {{ (foreman_installer_upgrade == True and (foreman_installer_scenario == "katello" or foreman_installer_scenario == "satellite")) | ternary("--upgrade", "") }} 41 | {{ foreman_installer_options | join(" ") }} 42 | 43 | - name: reload ansible_local 44 | setup: 45 | filter: ansible_local 46 | 47 | - name: rewrite answers file 48 | template: 49 | src: templates/scenario-answers.yaml.j2 50 | dest: "/etc/foreman-installer/scenarios.d/{{ foreman_installer_scenario }}-answers.yaml" 51 | owner: root 52 | group: root 53 | mode: 0600 54 | notify: 55 | - reload ansible_local 56 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | --- 2 | sudo: required 3 | 4 | env: 5 | - distribution: centos 6 | version: 7 7 | ansible_version: 2.4.6 8 | foreman_version: 1.18 9 | scenario: foreman 10 | - distribution: centos 11 | version: 7 12 | ansible_version: 2.5.6 13 | foreman_version: 1.18 14 | scenario: foreman 15 | - distribution: centos 16 | version: 7 17 | ansible_version: latest 18 | foreman_version: 1.18 19 | scenario: foreman 20 | # TODO 21 | # - distribution: centos 22 | # version: 7 23 | # ansible_version: latest 24 | # foreman_version: 1.18 25 | # katello_version: 3.6 26 | # scenario: katello 27 | 28 | services: 29 | - docker 30 | 31 | before_install: 32 | - 'sudo docker pull ${distribution}:${version}' 33 | - 'sudo docker build --no-cache --rm --build-arg ansible_version=${ansible_version} --build-arg foreman_version=${foreman_version} --build-arg katello_version=${katello_version} --file=travis/Dockerfile.${distribution}-${version} --tag=${distribution}-${version}:ansible travis' 34 | 35 | script: 36 | - container_id=$(mktemp) 37 | - 'sudo docker run --detach --privileged -v /sys/fs/cgroup:/sys/fs/cgroup:ro --volume="${PWD}":/sean797.foreman_installer:ro --hostname ${scenario}.example.com -p 443:443/tcp ${distribution}-${version}:ansible > "${container_id}"' 38 | - 'sudo docker exec "$(cat ${container_id})" ansible-lint /sean797.foreman_installer' 39 | - 'sudo docker exec "$(cat ${container_id})" env ANSIBLE_FORCE_COLOR=1 ansible-playbook -v --extra-vars "foreman_installer_scenario=${scenario}" /sean797.foreman_installer/travis/${scenario}.yml' 40 | - > 41 | sudo docker exec "$(cat ${container_id})" env ANSIBLE_FORCE_COLOR=1 ansible-playbook -v --extra-vars "foreman_installer_scenario=${scenario}" /sean797.foreman_installer/travis/${scenario}.yml 42 | | grep -q 'changed=0.*failed=0' 43 | && (echo 'Idempotence test: pass' && exit 0) 44 | || (echo 'Idempotence test: fail' && exit 1) 45 | - | 46 | status=$(curl -s -o /dev/null -w "%{http_code}" -H "Accept:application/json,version=2" -H "Content-Type:application/json" -u admin:changeme -k https://$(hostname -f)/api) 47 | [ $status -eq 200 ] || (echo "API FAILED, got $status" && exit 1) 48 | - 'sudo docker rm -f "$(cat ${container_id})"' 49 | 50 | notifications: 51 | email: false 52 | -------------------------------------------------------------------------------- /tasks/ha-extras.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: run notified handlers 3 | meta: flush_handlers 4 | 5 | - name: Write /etc/foreman/encryption_key.rb 6 | template: 7 | src: templates/encryption_key.rb.j2 8 | dest: /etc/foreman/encryption_key.rb 9 | owner: root 10 | group: "{{ ((ansible_local.foreman_installer[foreman_installer_scenario~'_answers'] | default({})).foreman | default({})).user | 11 | default( (foreman_installer_scenarios_answers.foreman | default({})).user ) | 12 | default('foreman') }}" 13 | mode: 0640 14 | when: foreman_installer_encryption_key is defined 15 | notify: 16 | - restart httpd 17 | 18 | - name: reload ansible_local to get local CA certs 19 | setup: 20 | filter: ansible_local 21 | 22 | - name: Fetch katello-default-ca certs to localhost 23 | fetch: 24 | src: "{{ ((ansible_local.foreman_installer[foreman_installer_scenario~'_answers'] | default({})).foreman | default({})).server_ssl_ca | 25 | default('/etc/pki/katello/certs/katello-default-ca.crt') }}" 26 | dest: /var/tmp/ 27 | when: foreman_installer_katello_cluster_group is defined 28 | 29 | - name: Distribute katello-default-ca cert 30 | copy: 31 | src: "/var/tmp/{{ ansible_fqdn + (((ansible_local.foreman_installer[foreman_installer_scenario~'_answers'] | default({})).foreman | default({})).server_ssl_ca | default('/etc/pki/katello/certs/katello-default-ca.crt')) }}" 32 | dest: "{{ foreman_installer_katello_certs_dir }}/{{ ansible_nodename }}-katello-default-ca.crt" 33 | delegate_to: "{{ item }}" 34 | with_items: "{{ groups[foreman_installer_katello_cluster_group] }}" 35 | when: foreman_installer_katello_cluster_group is defined 36 | notify: 37 | - write answers file 38 | - execute foreman-installer 39 | 40 | - name: Include other katello-default-ca Certificates in foreman_installer_scenarios_answers 41 | set_fact: 42 | foreman_installer_scenarios_answers: "{{ foreman_installer_scenarios_answers | combine( { 'certs': {'other_default_ca_certs': ((foreman_installer_scenarios_answers.certs | default({})).other_default_ca_certs | default([])) + [ foreman_installer_katello_certs_dir + '/' + hostvars[item]['ansible_nodename'] + '-katello-default-ca.crt' ] } }, recursive=True ) }}" 43 | with_items: "{{ groups[foreman_installer_katello_cluster_group] }}" 44 | when: foreman_installer_katello_cluster_group is defined 45 | -------------------------------------------------------------------------------- /tasks/katello-server-certs.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: "Create {{ foreman_installer_katello_certs_dir }}" 3 | file: 4 | path: "{{ foreman_installer_katello_certs_dir }}" 5 | state: directory 6 | owner: root 7 | group: root 8 | mode: 0755 9 | 10 | - name: Register cert files stat 11 | stat: 12 | path: "{{ item }}" 13 | with_items: 14 | - "{{ foreman_installer_katello_certs_dir }}/katello-ca-cert.pem" 15 | - "{{ foreman_installer_katello_certs_dir }}/katello-server-cert.cer" 16 | - "{{ foreman_installer_katello_certs_dir }}/katello-server-cert.key" 17 | - "{{ foreman_installer_katello_certs_dir }}/katello-server-cert.csr" 18 | register: certs_stat 19 | 20 | - name: Write custom CA certificate file 21 | copy: 22 | content: "{{ foreman_installer_katello_ca }}" 23 | dest: "{{ foreman_installer_katello_certs_dir }}/katello-ca-cert.pem" 24 | owner: root 25 | group: root 26 | mode: 0600 27 | notify: 28 | - 'set foreman_installer_update_certs to True' 29 | - execute foreman-installer 30 | 31 | - name: Write custom certificate file 32 | copy: 33 | content: "{{ foreman_installer_katello_cert }}" 34 | dest: "{{ foreman_installer_katello_certs_dir }}/katello-server-cert.cer" 35 | owner: root 36 | group: root 37 | mode: 0600 38 | notify: 39 | - 'set foreman_installer_update_certs to True' 40 | - execute foreman-installer 41 | 42 | - name: Write custom key certificate file 43 | copy: 44 | content: "{{ foreman_installer_katello_key }}" 45 | dest: "{{ foreman_installer_katello_certs_dir }}/katello-server-cert.key" 46 | owner: root 47 | group: root 48 | mode: 0600 49 | notify: 50 | - 'set foreman_installer_update_certs to True' 51 | - execute foreman-installer 52 | 53 | - name: Write custom CSR certificate file 54 | copy: 55 | content: "{{ foreman_installer_katello_csr }}" 56 | dest: "{{ foreman_installer_katello_certs_dir }}/katello-server-cert.csr" 57 | owner: root 58 | group: root 59 | mode: 0600 60 | notify: 61 | - 'set foreman_installer_update_certs to True' 62 | - execute foreman-installer 63 | 64 | - name: Include katello certificate options in foreman_installer_scenarios_answers 65 | set_fact: 66 | foreman_installer_scenarios_answers: "{{ foreman_installer_scenarios_answers | combine( { 'certs': {'server_cert': foreman_installer_katello_certs_dir + '/katello-server-cert.cer','server_cert_req': foreman_installer_katello_certs_dir + '/katello-server-cert.csr','server_key': foreman_installer_katello_certs_dir + '/katello-server-cert.key','server_ca_cert': foreman_installer_katello_certs_dir + '/katello-ca-cert.pem' } }, recursive=True ) }}" 67 | -------------------------------------------------------------------------------- /tasks/katello-proxy-certs.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: "Create {{ foreman_installer_katello_certs_dir }}" 3 | file: 4 | path: "{{ foreman_installer_katello_certs_dir }}" 5 | state: directory 6 | owner: root 7 | group: root 8 | mode: 0755 9 | delegate_to: "{{ item }}" 10 | with_items: 11 | - "{{ hostvars[foreman_installer_generate_proxy_certs_from].inventory_hostname }}" 12 | - "{{ inventory_hostname }}" 13 | 14 | - name: Register proxy cert files stat 15 | stat: 16 | path: "{{ item }}" 17 | with_items: 18 | - "{{ foreman_installer_katello_certs_dir }}/{{ ansible_nodename }}-proxy-cert.cer" 19 | - "{{ foreman_installer_katello_certs_dir }}/{{ ansible_nodename }}-proxy-cert.key" 20 | - "{{ foreman_installer_katello_certs_dir }}/{{ ansible_nodename }}-proxy-cert.csr" 21 | delegate_to: "{{ hostvars[foreman_installer_generate_proxy_certs_from].inventory_hostname }}" 22 | register: certs_proxy_stat 23 | 24 | - name: Write proxy custom CA certificate file 25 | copy: 26 | content: "{{ foreman_installer_katello_ca }}" 27 | dest: "{{ foreman_installer_katello_certs_dir }}/katello-ca-cert.pem" 28 | owner: root 29 | group: root 30 | mode: 0600 31 | register: ca_cert 32 | notify: 33 | - execute foreman-installer 34 | delegate_to: "{{ hostvars[foreman_installer_generate_proxy_certs_from].inventory_hostname }}" 35 | when: foreman_installer_katello_ca is defined 36 | 37 | - name: Write proxy custom certificate file 38 | copy: 39 | content: "{{ foreman_installer_katello_proxy_cert }}" 40 | dest: "{{ foreman_installer_katello_certs_dir }}/{{ ansible_nodename }}-proxy-cert.cer" 41 | owner: root 42 | group: root 43 | mode: 0600 44 | register: custom_cert 45 | notify: 46 | - execute foreman-installer 47 | delegate_to: "{{ hostvars[foreman_installer_generate_proxy_certs_from].inventory_hostname }}" 48 | when: foreman_installer_katello_proxy_cert is defined 49 | 50 | - name: Write proxy custom key certificate file 51 | copy: 52 | content: "{{ foreman_installer_katello_proxy_key }}" 53 | dest: "{{ foreman_installer_katello_certs_dir }}/{{ ansible_nodename }}-proxy-cert.key" 54 | owner: root 55 | group: root 56 | mode: 0600 57 | register: key_cert 58 | notify: 59 | - execute foreman-installer 60 | delegate_to: "{{ hostvars[foreman_installer_generate_proxy_certs_from].inventory_hostname }}" 61 | when: foreman_installer_katello_proxy_key is defined 62 | 63 | - name: Write proxy custom CSR certificate file 64 | copy: 65 | content: "{{ foreman_installer_katello_proxy_csr }}" 66 | dest: "{{ foreman_installer_katello_certs_dir }}/{{ ansible_nodename }}-proxy-cert.csr" 67 | owner: root 68 | group: root 69 | mode: 0600 70 | register: csr_cert 71 | notify: 72 | - execute foreman-installer 73 | delegate_to: "{{ hostvars[foreman_installer_generate_proxy_certs_from].inventory_hostname }}" 74 | when: foreman_installer_katello_proxy_csr is defined 75 | 76 | - name: 'set foreman_installer_update_certs_tar to True' 77 | set_fact: 78 | foreman_installer_update_certs_tar: True 79 | foreman_installer_update_certs: True 80 | when: 81 | - certs_proxy_stat.results[0].stat.exists or certs_proxy_stat.results[1].stat.exists or certs_proxy_stat.results[2].stat.exists 82 | - (ca_cert.changed | default(False)) or (custom_cert.changed | default(False)) or (key_cert.changed | default(False)) or (csr_cert.changed | default(False)) 83 | tags: 84 | - skip_ansible_lint 85 | 86 | 87 | - name: Register proxy cert tar stat 88 | stat: 89 | path: "{{ foreman_installer_katello_certs_dir }}/{{ ansible_nodename }}-certs.tar" 90 | register: proxy_cert_tar 91 | 92 | - name: Generate Proxy Certs 93 | command: > 94 | {{ cert_generate_command }} --{{ cert_generate_fqdn_opt }} {{ ansible_fqdn }} 95 | --certs-tar {{ foreman_installer_katello_certs_dir }}/{{ ansible_nodename }}-certs.tar 96 | {{ ('--server-cert ' + foreman_installer_katello_certs_dir + '/' + ansible_nodename + '-proxy-cert.cer') if foreman_installer_katello_proxy_cert is defined else '' }} 97 | {{ ('--server-cert-req ' + foreman_installer_katello_certs_dir + '/' + ansible_nodename + '-proxy-cert.csr') if foreman_installer_katello_proxy_csr is defined else '' }} 98 | {{ ('--server-key ' + foreman_installer_katello_certs_dir + '/' + ansible_nodename + '-proxy-cert.key') if foreman_installer_katello_proxy_key is defined else '' }} 99 | {{ ('--server-ca-cert ' + foreman_installer_katello_certs_dir + '/katello-ca-cert.pem') if foreman_installer_katello_ca is defined else '' }} 100 | {{ (foreman_installer_update_certs_tar) | ternary('--certs-update-server', '') }} 101 | when: (ca_cert.changed | default(False)) or (custom_cert.changed | default(False)) or (key_cert.changed | default(False)) or (csr_cert.changed | default(False)) or proxy_cert_tar.stat.exists == False 102 | delegate_to: "{{ hostvars[foreman_installer_generate_proxy_certs_from].inventory_hostname }}" 103 | tags: 104 | - skip_ansible_lint 105 | 106 | - name: Fetch certs-tar to localhost 107 | fetch: 108 | src: "{{ foreman_installer_katello_certs_dir }}/{{ ansible_nodename }}-certs.tar" 109 | dest: /var/tmp/ 110 | delegate_to: "{{ hostvars[foreman_installer_generate_proxy_certs_from].inventory_hostname }}" 111 | 112 | - name: Copy certs tar to Proxy 113 | copy: 114 | src: "/var/tmp/{{ inventory_hostname + foreman_installer_katello_certs_dir }}/{{ ansible_nodename }}-certs.tar" 115 | dest: "{{ foreman_installer_katello_certs_dir }}/{{ ansible_nodename }}-certs.tar" 116 | notify: 117 | - write answers file 118 | - execute foreman-installer 119 | 120 | - name: "Gather facts about {{ foreman_installer_generate_proxy_certs_from }}" 121 | setup: 122 | delegate_to: "{{ hostvars[foreman_installer_generate_proxy_certs_from].inventory_hostname }}" 123 | delegate_facts: True 124 | 125 | - name: Include smart proxy certificate options in foreman_installer_scenarios_answers 126 | set_fact: 127 | foreman_installer_scenarios_answers: "{{ foreman_installer_scenarios_answers | combine( { certs_puppet_module: {'certs_tar': foreman_installer_katello_certs_dir + '/' + ansible_nodename + '-certs.tar', 'pulp_oauth_secret': hostvars[foreman_installer_generate_proxy_certs_from]['ansible_local']['foreman_installer'][hostvars[foreman_installer_generate_proxy_certs_from]['ansible_local']['foreman_installer'].last_scenario~'_answers']['katello']['oauth_secret'] }, 'foreman_proxy': { 'oauth_consumer_key': hostvars[foreman_installer_generate_proxy_certs_from]['ansible_local']['foreman_installer'][hostvars[foreman_installer_generate_proxy_certs_from]['ansible_local']['foreman_installer'].last_scenario~'_answers']['foreman']['oauth_consumer_key'], 'oauth_consumer_secret': hostvars[foreman_installer_generate_proxy_certs_from]['ansible_local']['foreman_installer'][hostvars[foreman_installer_generate_proxy_certs_from]['ansible_local']['foreman_installer'].last_scenario~'_answers']['foreman']['oauth_consumer_secret'] } }, recursive=True ) }}" 128 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # foreman_installer [![Build Status](https://travis-ci.org/sean797/ansible-role-foreman_installer.svg?branch=master)](https://travis-ci.org/sean797/ansible-role-foreman_installer) 2 | 3 | Role to interact with foreman-installer 4 | 5 | 6 | ## Requirements 7 | 8 | N/A 9 | 10 | ## Role Variables 11 | 12 | ```yaml 13 | vars: 14 | foreman_installer: 15 | foreman_installer_pkg: # foreman installer package. You probably want either "foreman-installer" or "katello". 16 | foreman_installer_verbose: # Run the installe with -v option 17 | foreman_installer_scenario: # Scenario. Required 18 | foreman_installer_scenarios_answers: # Dict of custom answers that for your scenario. See [FAQs](https://github.com/sean797/ansible-role-foreman_installer#faqs). 19 | foreman_installer_options: [] # Array of extra options to pass to whenever the installer is ran 20 | foreman_installer_generate_proxy_certs_from: # String containing the ansible host to Generate Certificates for a Katello Smart Proxy 21 | foreman_installer_katello_ca: # String containing the custom CA cert. Katello & Katello Smart Proxy Only. 22 | foreman_installer_katello_cert: # String containing the custom cert. Katello Only. 23 | foreman_installer_katello_key: # String containing the custom key. Katello Only. 24 | foreman_installer_katello_csr: # String containing the custom csr. Katello Only. 25 | foreman_installer_katello_proxy_cert: # String containing the custom cert. Katello Smart Proxy Only. 26 | foreman_installer_katello_proxy_key: # String containing the custom key. Katello Smart Proxy Only. 27 | foreman_installer_katello_proxy_csr: # String containing the custom csr. Katello Smart Proxy Only. 28 | foreman_installer_katello_certs_dir: # Directory to store the certificates 29 | foreman_installer_update_certs: False # Set to True to force Certificate Update. 30 | foreman_installer_update_certs_tar: False # Set to True to force new Proxy Certificates tar to be generated & applied. 31 | 32 | # Advanced Options 33 | foreman_installer_patches: # Array of Dicts allowing patches against the installer files. See defaults/main.yml for an example. 34 | foreman_installer_encryption_key: # Encryption key that is put into /etc/foreman/encryption_key.rb. Must be the same across a Foreman cluster. 35 | foreman_installer_katello_cluster_group: # Name of the inventory group will all Katello servers in. Requires http://projects.theforeman.org/issues/20021 36 | ``` 37 | 38 | ## Example Playbook 39 | 40 | ### Basic Foreman scenario: 41 | 42 | ```yaml 43 | - hosts: 44 | - foreman.example.com 45 | roles: 46 | - role: foreman_installer 47 | foreman_installer_scenario: foreman 48 | foreman_installer_scenarios_answers: 49 | foreman: 50 | admin_password: changeme 51 | ``` 52 | 53 | ### Katello scenario with custom certificates: 54 | 55 | ```yaml 56 | - hosts: 57 | - katello.example.com 58 | var_files: 59 | - group_vars/vault_certs.yml 60 | roles: 61 | - role: foreman_installer 62 | foreman_installer_pkg: katello 63 | foreman_installer_scenario: katello 64 | foreman_installer_scenarios_answers: 65 | foreman: 66 | admin_password: changeme 67 | foreman_installer_katello_ca: "{{ vault_foreman_installer_katello_ca }}" 68 | foreman_installer_katello_cert: "{{ vault_katello_cert }}" 69 | foreman_installer_katello_key: "{{ vault_foreman_installer_katello_key }}" 70 | foreman_installer_katello_csr: "{{ vault_foreman_installer_katello_csr }}" 71 | ``` 72 | 73 | ### Katello Proxy scenario with supplied certificates tar: 74 | 75 | ```yaml 76 | - hosts: 77 | - foreman-proxy.example.com 78 | roles: 79 | - role: foreman_installer 80 | foreman_installer_pkg: foreman-proxy-content 81 | foreman_installer_scenario: foreman-proxy-content 82 | foreman_installer_scenarios_answers: 83 | foreman_proxy_content: 84 | certs_tar: /root/foreman-proxy.example.com-certs.tar #This must already be on-disk 85 | pulp_oauth_secret: 86 | parent_fqdn: katello.example.com 87 | foreman_proxy: 88 | oauth_consumer_key: 89 | oauth_consumer_secret: 90 | foreman_base_url: https://katello.example.com 91 | trusted_hosts: 92 | - katello.example.com 93 | - "{{ ansible_fqdn }}" 94 | ``` 95 | 96 | ### Katello Proxy scenario without supplied certificates tar: 97 | 98 | ```yaml 99 | - hosts: 100 | - foreman-proxy.example.com 101 | roles: 102 | - role: foreman_installer 103 | foreman_installer_pkg: foreman-proxy-content 104 | foreman_installer_scenario: foreman-proxy-content 105 | foreman_installer_generate_proxy_certs_from: katello.example.com 106 | foreman_installer_katello_proxy_cert: "{{ vault_proxy1_cert }}" 107 | foreman_installer_katello_proxy_key: "{{ vault_proxy1_key }}" 108 | foreman_installer_katello_proxy_csr: "{{ vault_proxy1_csr }}" 109 | foreman_installer_katello_ca: "{{ vault_foreman_installer_katello_ca }}" 110 | foreman_installer_scenarios_answers: 111 | foreman_proxy_content: 112 | parent_fqdn: katello.example.com 113 | foreman_proxy: 114 | foreman_base_url: https://katello.example.com 115 | trusted_hosts: 116 | - katello.example.com 117 | ``` 118 | 119 | ### Katello cluster with custom certificates: 120 | 121 | Couple of things to note: 122 | - All the key, secret & password answers are there as these must be the same across the cluster. Please don't use the values in this example. 123 | - The `foreman_installer_patches` options was only used to backport http://projects.theforeman.org/issues/20021 to my Katello version. 124 | 125 | ```yaml 126 | - hosts: 127 | - katello1.example.com 128 | - katello2.example.com 129 | var_files: 130 | - group_vars/vault_certs.yml 131 | roles: 132 | - role: foreman_installer 133 | foreman_installer_pkg: katello 134 | foreman_installer_scenario: katello 135 | foreman_installer_scenarios_answers: 136 | foreman_proxy_content: 137 | pulp_oauth_secret: uC2qfoQfPVhdFTBEbS89ykZWQz6BVpcu 138 | foreman: 139 | db_password: KmVzXiWuVWCUZrn4kWF8PRsFG4H4ecqo 140 | initial_location: Global 141 | initial_organization: AMCE 142 | admin_password: changeme 143 | servername: katello.example.com 144 | foreman_url: https://katello.example.com 145 | oauth_consumer_key: xmi95B9qNQoX6owdg4MT8WMCBNhgudYy 146 | oauth_consumer_secret: x6TheD8Z9ZBtgdgBUrqSbPR2rh6k7UQE 147 | foreman_proxy: 148 | registered_name: katello.example.com 149 | registered_proxy_url: https://katello.example.com:9090 150 | oauth_consumer_key: xmi95B9qNQoX6owdg4MT8WMCBNhgudYy 151 | oauth_consumer_secret: x6TheD8Z9ZBtgdgBUrqSbPR2rh6k7UQE 152 | foreman_base_url: https://katello.example.com 153 | trusted_hosts: 154 | - katello.example.com 155 | - katello1.example.com 156 | - katello2.example.com 157 | katello: 158 | oauth_secret: uC2qfoQfPVhdFTBEbS89ykZWQz6BVpcu 159 | foreman_installer_custom_hiera: 160 | candlepin::db_password: L45DkebcvWdgXG9ryzWkfavSvQ23dw8U 161 | foreman_installer_encryption_key: dfc6799e4d722a4e86c786cb0fc96cbbae0151f6 162 | foreman_installer_katello_cluster_group: katello-servers 163 | foreman_installer_katello_ca: "{{ vault_foreman_installer_katello_ca }}" 164 | foreman_installer_katello_cert: "{{ vault_katello_cert }}" # Certificate must use dns-alt-names with all cluster Hostnames and VIP hostname. 165 | foreman_installer_katello_key: "{{ vault_foreman_installer_katello_key }}" 166 | foreman_installer_katello_csr: "{{ vault_foreman_installer_katello_csr }}" 167 | foreman_installer_patches: 168 | - { src: files/katello_certs_tools.patch, basedir: /usr/lib/python2.7/site-packages/ } 169 | - { src: files/puppet-certs.patch, basedir: /usr/share/katello-installer-base/modules/certs/ } 170 | ``` 171 | 172 | ### Foreman proxy cluster that connected to a Katello cluster with custom certificates: 173 | 174 | Each proxy is there own proxy in Foreman, but a client can use a VIP address to connect to either of them for packages. 175 | 176 | ```yaml 177 | - hosts: 178 | - foreman-proxy1.example.com 179 | - foreman-proxy2.example.com 180 | roles: 181 | - role: foreman_installer 182 | foreman_installer_pkg: foreman-proxy-content 183 | foreman_installer_scenario: foreman-proxy-content 184 | foreman_installer_generate_proxy_certs_from: katello1.example.com 185 | foreman_installer_katello_proxy_cert: "{{ vault_proxy1_cert }}" # Certificate must use dns-alt-names with all cluster Hostnames and VIP hostname. 186 | foreman_installer_katello_proxy_key: "{{ vault_proxy1_key }}" 187 | foreman_installer_katello_proxy_csr: "{{ vault_proxy1_csr }}" 188 | foreman_installer_katello_ca: "{{ vault_foreman_installer_katello_ca }}" 189 | foreman_installer_scenarios_answers: 190 | foreman_proxy_content: 191 | parent_fqdn: katello.example.com 192 | foreman_proxy: 193 | foreman_base_url: https://katello.example.com 194 | trusted_hosts: 195 | - katello1.example.com 196 | - katello2.example.com 197 | - katello.example.com 198 | - foreman-proxy1.example.com 199 | - foreman-proxy2.example.com 200 | - foreman-proxy.example.com 201 | ``` 202 | 203 | ## FAQs 204 | 205 | ### How do I know what options to put in `foreman_installer_scenarios_answers` var? ### 206 | 207 | You need to check in /etc/foreman-installer/scenarios.d/{{ foreman_installer_scenario }}-answers.yaml file. Storing answers like this makes the role idempotent, if you use `foreman_installer_options` instead we would have run the installer during every run to make sure its applied. Whereas this method allows us to manage the answer file and run the installer as a handler (only if something changes). 208 | 209 | ### How do I remove options from `foreman_installer_scenarios_answers` var? ### 210 | 211 | You'll need to set the value to `null`. 212 | 213 | ```yaml 214 | foreman_installer_scenarios_answers: 215 | foreman: 216 | admin_password: changeme 217 | admin_last_name: null 218 | ``` 219 | 220 | ### How do I enable or disable a plug-in? 221 | 222 | To enable set the value to an empty hash. To disable set the value to false. 223 | 224 | ```yaml 225 | foreman_installer_scenarios_answers: 226 | foreman: 227 | admin_password: changeme 228 | admin_last_name: null 229 | "foreman::plugin::remote_execution": {} 230 | "foreman::plugin::discovery": false 231 | ``` 232 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------