├── .dockerignore ├── .gitignore ├── ansible.cfg ├── ansible ├── backup.yml ├── requirements.yml ├── roles │ └── tractorbeam │ │ ├── defaults │ │ └── main.yml │ │ ├── handlers │ │ └── main.yml │ │ ├── meta │ │ └── main.yml │ │ ├── tasks │ │ ├── healhcheck.yml │ │ ├── local.yml │ │ ├── sftp.yml │ │ ├── s3.yml │ │ ├── files.yml │ │ ├── platformshFiles.yml │ │ ├── databases.yml │ │ ├── platformshDatabases.yml │ │ ├── archives.yml │ │ ├── main.yml │ │ └── pantheon.yml │ │ └── vars │ │ └── main.yml ├── inventories │ └── all.ini ├── templates │ └── tractorbeam.sh.j2 ├── group_vars │ └── backup.yml └── build.yml ├── ansible-hosts ├── README.md ├── Dockerfile ├── .github └── workflows │ └── build-multiarch.yml └── LICENSE /.dockerignore: -------------------------------------------------------------------------------- 1 | test 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .idea 2 | test/* 3 | -------------------------------------------------------------------------------- /ansible.cfg: -------------------------------------------------------------------------------- 1 | [defaults] 2 | roles_path = /ansible/roles 3 | nocows = 1 4 | -------------------------------------------------------------------------------- /ansible/backup.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: backup 3 | roles: 4 | - tractorbeam 5 | -------------------------------------------------------------------------------- /ansible-hosts: -------------------------------------------------------------------------------- 1 | localhost ansible_connection=local ansible_python_interpreter=/usr/bin/python3 2 | -------------------------------------------------------------------------------- /ansible/requirements.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - src: ten7.flightdeck_base 3 | - src: socketwench.pantheon_terminus 4 | -------------------------------------------------------------------------------- /ansible/roles/tractorbeam/defaults/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | tractorbeam: 3 | stop_on_failure: no 4 | databases: [] 5 | -------------------------------------------------------------------------------- /ansible/inventories/all.ini: -------------------------------------------------------------------------------- 1 | [backup] 2 | localhost ansible_connection=local ansible_python_interpreter=/usr/bin/python3 3 | -------------------------------------------------------------------------------- /ansible/roles/tractorbeam/handlers/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: delete temp items 3 | file: 4 | path: "{{ item }}" 5 | state: absent 6 | with_items: 7 | - "{{ _run_temp_dir.path }}" 8 | -------------------------------------------------------------------------------- /ansible/roles/tractorbeam/meta/main.yml: -------------------------------------------------------------------------------- 1 | galaxy_info: 2 | author: socketwench 3 | description: backups databases from flight-deck-db to s3 4 | company: TEN7 5 | license: license (GPL-3.0-only) 6 | min_ansible_version: 2.4 7 | galaxy_tags: [] 8 | dependencies: [] 9 | 10 | -------------------------------------------------------------------------------- /ansible/roles/tractorbeam/tasks/healhcheck.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Send ping to healthchecks.io 3 | uri: 4 | url: "{{ _backup.healthcheckUrl }}" 5 | force: yes 6 | timeout: "10" 7 | validate_certs: no 8 | when: 9 | - _backup.healthcheckUrl is defined 10 | ignore_errors: yes 11 | -------------------------------------------------------------------------------- /ansible/templates/tractorbeam.sh.j2: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | case "$1" in 4 | "") 5 | echo $"Usage: $0 {backup_set_name}" 6 | exit 1 7 | ;; 8 | 9 | *) 10 | if [ -f "/config/tractorbeam/tractorbeam.yml" ]; then 11 | ansible-playbook -i /ansible/inventories/all.ini -e "@/config/tractorbeam/tractorbeam.yml" -e "tractorbeam_scope=${1}" /ansible/backup.yml 12 | else 13 | ansible-playbook -i /ansible/inventories/all.ini /ansible/backup.yml 14 | fi 15 | ;; 16 | 17 | esac 18 | -------------------------------------------------------------------------------- /ansible/group_vars/backup.yml: -------------------------------------------------------------------------------- 1 | --- 2 | flighdeck_motd_name: "Tractorbeam 2.6.0" 3 | 4 | flightdeck_groups: 5 | - name: "backup" 6 | 7 | flightdeck_users: 8 | - name: "backup" 9 | group: "backup" 10 | groups: 11 | - "cron" 12 | home: "/home/backup" 13 | 14 | flightdeck_root_prompt: '\u@tractorbeam:\w# ' 15 | flightdeck_user_prompt: '\u@tractorbeam:\w$ ' 16 | 17 | platformsh_cli_version: "v3.65.2" 18 | platformsh_cli_url: "https://github.com/platformsh/platformsh-cli/releases/download/{{ platformsh_cli_version }}/platform.phar" 19 | -------------------------------------------------------------------------------- /ansible/roles/tractorbeam/vars/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | _tractorbeam_default_backupSets: 3 | daily: 4 | retainCount: 7 5 | weekly: 6 | retainCount: 4 7 | monthly: 8 | retainCount: 12 9 | 10 | _tractorbeam_default_sets_for_backup: "{{ _tractorbeam_default_backupSets.keys() | list }}" 11 | 12 | _tractorbeam_default_files_excludes: 13 | - ".git" 14 | - "css/*" 15 | - "js/*" 16 | - "imagecache/*" 17 | - "styles/*" 18 | - "php/*" 19 | - "backup_migrate/*" 20 | - "private/backup_migrate/*" 21 | 22 | _tractorbeam_default_platformshFiles_excludes: "{{ _tractorbeam_default_files_excludes }}" 23 | 24 | _tractorbeam_archives_extensions: 25 | bz2: ".bz2" 26 | gz: ".tar.gz" 27 | tar: ".tar" 28 | xz: ".xz" 29 | zip: ".zip" 30 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Tractorbeam 2 | 3 | 4 | ## Open source multi-tier website backups 5 | 6 | [Tractorbeam](https://tractorbeam.ten7.com/) is a Docker container that can back up your entire website. Learn more at [tractorbeam.ten7.com](https://tractorbeam.ten7.com/) 7 | 8 | ## Using Tractorbeam 9 | 10 | Run the single shot container on your own infrastructure, anywhere you have Docker installed. See the [Getting Started](https://tractorbeam.ten7.com/setup.html) for how to do that. 11 | 12 | 13 | ## Built with love by TEN7 14 | 15 | [Tractorbeam](https://tractorbeam.ten7.com/) is built and supported by [TEN7](https://ten7.com/), whose mission is to Make Things That Matter. We use this in production on websites hosted at [DigitalOcean](https://m.do.co/c/5fb69d9c62e4), [Pantheon](https://pantheon.io/) and [platform.sh](https://platform.sh/). You can too! 16 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM alpine:3.12 2 | MAINTAINER tess@ten7.com 3 | 4 | # Update the package list and install Ansible. 5 | RUN apk -U upgrade &&\ 6 | apk add --update --no-cache ansible && \ 7 | rm -rf /tmp/* \ 8 | /var/cache/apk/* \ 9 | /usr/lib/python3.6/site-packages/ansible/modules/network/ \ 10 | /usr/lib/python3.6/site-packages/ansible/modules/windows/ 11 | 12 | # Copy the Ansible configuration files 13 | COPY ansible-hosts /etc/ansible/hosts 14 | COPY ansible.cfg /etc/ansible/ansible.cfg 15 | COPY ansible /ansible 16 | 17 | # Run the build. 18 | RUN ansible-galaxy install -fr /ansible/requirements.yml && \ 19 | ansible-playbook -i /ansible/inventories/all.ini /ansible/build.yml 20 | 21 | # Switch to the service account. 22 | USER backup 23 | 24 | # Set the entrypoint and default command. 25 | ENTRYPOINT ["docker-entrypoint.sh"] 26 | CMD ["tractorbeam"] 27 | -------------------------------------------------------------------------------- /.github/workflows/build-multiarch.yml: -------------------------------------------------------------------------------- 1 | name: build-multiarch 2 | on: 3 | push: 4 | tags: 5 | - '[0-9]+.[0-9]+.[0-9]+' 6 | branches: 7 | - main 8 | - develop 9 | 10 | jobs: 11 | buildx: 12 | runs-on: ubuntu-latest 13 | steps: 14 | - 15 | name: Docker meta 16 | id: meta 17 | uses: docker/metadata-action@v3 18 | with: 19 | images: | 20 | ${{ github.repository }} 21 | tags: | 22 | type=ref,event=branch 23 | type=semver,pattern={{version}} 24 | type=semver,pattern={{major}}.{{minor}} 25 | type=semver,pattern={{major}} 26 | type=sha 27 | - 28 | name: Set up QEMU 29 | uses: docker/setup-qemu-action@v1 30 | - 31 | name: Set up Docker Buildx 32 | uses: docker/setup-buildx-action@v1 33 | - 34 | name: Login to DockerHub 35 | uses: docker/login-action@v1 36 | with: 37 | username: ${{ secrets.DOCKERHUB_USERNAME }} 38 | password: ${{ secrets.DOCKERHUB_TOKEN }} 39 | - 40 | name: Build and push 41 | uses: docker/build-push-action@v2 42 | with: 43 | context: "{{defaultContext}}" 44 | platforms: linux/amd64,linux/arm64 45 | push: ${{ github.event_name != 'pull_request' }} 46 | tags: ${{ steps.meta.outputs.tags }} 47 | labels: ${{ steps.meta.outputs.labels }} 48 | -------------------------------------------------------------------------------- /ansible/roles/tractorbeam/tasks/local.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Create a tempfile for the rclone config 3 | tempfile: 4 | prefix: "tractorbeam-local-" 5 | suffix: ".conf" 6 | state: file 7 | register: _rclone_conf 8 | - name: Template the rclone conf 9 | copy: 10 | content: | 11 | [source] 12 | type = local 13 | copy_links = false 14 | links = false 15 | skip_links = true 16 | no_check_updated = true 17 | case_sensitive = true 18 | case_insensitive = false 19 | 20 | [dest] 21 | type = s3 22 | provider = {{ _backup.provider | default('AWS') }} 23 | env_auth = false 24 | access_key_id = {{ _dest_access_key }} 25 | secret_access_key = {{ _dest_secret_key }} 26 | endpoint = {{ _backup.endpoint | default('') | regex_replace('[A-z]*://', '') }} 27 | region = {{ _backup.region | default('') }} 28 | acl = {{ _backup.acl | default('private') }} 29 | dest: "{{ _rclone_conf.path }}" 30 | vars: 31 | _dest_access_key: "\ 32 | {% if _backup.accessKeyFile is defined %}\ 33 | {{ lookup('file', _backup.accessKeyFile) }}\ 34 | {% else %}\ 35 | {{ _backup.accessKey | default(omit) }}\ 36 | {% endif %}" 37 | _dest_secret_key: "\ 38 | {% if _backup.secretKeyFile is defined %}\ 39 | {{ lookup('file', _backup.secretKeyFile) }}\ 40 | {% else %}\ 41 | {{ _backup.secretKey | default(omit) }}\ 42 | {% endif %}" 43 | - name: Sync files using rclone 44 | shell: > 45 | rclone sync 46 | source:/{{ _backup.path }}/ 47 | dest:/{{ _backup.bucket }}/{% if _backup.prefix is defined %}{{ _backup.prefix }}/{% endif %} 48 | --config="{{ _rclone_conf.path }}" 49 | {% for _exclude in _backup.excludes | default(_tractorbeam_default_files_excludes) %} 50 | --exclude="{{ _exclude }}"{{ '' }} 51 | {% endfor %} 52 | {% if _backup.delete | default(true) %} 53 | --delete-during 54 | {% endif %} 55 | {% if (flightdeck_debug | default(false)) != true %} 56 | --quiet 57 | {% else %} 58 | --verbose="4" 59 | {% endif %} 60 | register: _fromlocal_result 61 | until: _fromlocal_result.rc == 0 62 | retries: "{{ _backup.retryCount | default(3) }}" 63 | delay: "{{ _backup.retryDelay | default(30) }}" 64 | - include_tasks: "healhcheck.yml" 65 | -------------------------------------------------------------------------------- /ansible/roles/tractorbeam/tasks/sftp.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Create a tempfile for the rclone config 3 | tempfile: 4 | prefix: "tractorbeam-rclone-" 5 | suffix: ".conf" 6 | state: file 7 | register: _rclone_conf 8 | - name: Template the rclone conf 9 | copy: 10 | content: | 11 | [source] 12 | type = s3 13 | provider = {{ _backup.srcProvider | default('AWS') }} 14 | env_auth = false 15 | access_key_id = {{ _src_access_key }} 16 | secret_access_key = {{ _src_secret_key }} 17 | endpoint = {{ _backup.srcEndpoint | default('') | regex_replace('[A-z]*://', '') }} 18 | region = {{ _backup.srcRegion | default('') }} 19 | acl = {{ _backup.srcAcl | default('private') }} 20 | 21 | [dest] 22 | type = sftp 23 | host = {{ _backup.host }} 24 | port = {{ _backup.port | default('22') }} 25 | user = {{ _backup.user }} 26 | password = {{ _dest_password }} 27 | key_file = {{ _backup.keyFile | default('') }} 28 | pubkey_file = {{ _backup.pubKeyFile | default('') }} 29 | dest: "{{ _rclone_conf.path }}" 30 | vars: 31 | _src_access_key: "\ 32 | {% if _backup.srcAccessKeyFile is defined %}\ 33 | {{ lookup('file', _backup.srcAccessKeyFile) }}\ 34 | {% else %}\ 35 | {{ _backup.srcAccessKey | default(omit) }}\ 36 | {% endif %}" 37 | _src_secret_key: "\ 38 | {% if _backup.srcSecretKeyFile is defined %}\ 39 | {{ lookup('file', _backup.srcSecretKeyFile) }}\ 40 | {% else %}\ 41 | {{ _backup.srcSecretKey | default(omit) }}\ 42 | {% endif %}" 43 | _dest_password: "\ 44 | {% if _backup.passwordFile is defined %}\ 45 | {{ lookup('file', _backup.passwordFile) }}\ 46 | {% else %}\ 47 | {{ _backup.password | default('') }}\ 48 | {% endif %}" 49 | - name: Create a cache directory for the backup 50 | file: 51 | state: directory 52 | path: "{{ _backup.cacheDir }}" 53 | owner: "backup" 54 | group: "backup" 55 | mode: "u=rwx,g=rxw,o=rwx" 56 | when: 57 | - _backup.cacheDir is defined 58 | - name: Sync files using rclone 59 | shell: > 60 | rclone sync 61 | source:/{{ _backup.srcBucket }}/{% if _backup.srcPrefix is defined %}{{ _backup.srcPrefix }}/{% endif %} 62 | dest:{% if _backup.prefix is defined %}{{ _backup.prefix }}/{% endif %} 63 | --config="{{ _rclone_conf.path }}" 64 | {% for _exclude in _backup.excludes | default(_tractorbeam_default_files_excludes) %} 65 | --exclude="{{ _exclude }}"{{ '' }} 66 | {% endfor %} 67 | {% if _backup.delete | default(true) %} 68 | --delete-during 69 | {% endif %} 70 | {% if (flightdeck_debug | default(false)) != true %} 71 | --quiet 72 | {% else %} 73 | --verbose="4" 74 | {% endif %} 75 | register: _froms3sftp_result 76 | until: _froms3sftp_result.rc == 0 77 | retries: "{{ _backup.retryCount | default(3) }}" 78 | delay: "{{ _backup.retryDelay | default(30) }}" 79 | - include_tasks: "healhcheck.yml" 80 | -------------------------------------------------------------------------------- /ansible/build.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: backup 3 | roles: 4 | - ten7.flightdeck_base 5 | tasks: 6 | - name: Install necessary software. 7 | apk: 8 | name: "{{ item }}" 9 | state: present 10 | update_cache: yes 11 | loop: 12 | - "curl" 13 | - "git" 14 | - "patch" 15 | - "mariadb-client" 16 | - "openssh-client" 17 | - "php7" 18 | - "php7-curl" 19 | - "php7-dom" 20 | - "php7-json" 21 | - "php7-mbstring" 22 | - "php7-openssl" 23 | - "php7-pcntl" 24 | - "php7-posix" 25 | - "php7-phar" 26 | - "php7-tokenizer" 27 | - "py3-boto3" 28 | - "py3-botocore" 29 | - "py3-chardet" 30 | - "py3-mysqlclient" 31 | - "py3-pip" 32 | - "py3-urllib3" 33 | - "rsync" 34 | - "rclone" 35 | - "tree" 36 | notify: 37 | - clear apk cache 38 | # - name: Install build deps 39 | # shell: > 40 | # apk add --virtual build-deps 41 | # gcc 42 | # libffi-dev 43 | # python3-dev 44 | # linux-headers 45 | # musl-dev 46 | # openssl-dev 47 | # rust 48 | # cargo 49 | # notify: remove build deps 50 | - name: Download the Platform.sh cli 51 | get_url: 52 | url: "{{ platformsh_cli_url }}" 53 | dest: "/usr/local/bin/platform" 54 | owner: "backup" 55 | group: "backup" 56 | mode: "u=rx,g=rx,o=" 57 | - name: Install Platform.sh cli 58 | shell: > 59 | /usr/local/bin/platform self:install 60 | - name: Deploy key scripts. 61 | template: 62 | src: "{{ item.src }}" 63 | dest: "{{ item.dest }}" 64 | owner: "backup" 65 | group: "backup" 66 | mode: "u=rx,g=rx,o=" 67 | loop: 68 | - src: "templates/tractorbeam.sh.j2" 69 | dest: "/usr/local/bin/tractorbeam" 70 | - name: Install Pantheon Terminus 71 | include_role: 72 | name: "socketwench.pantheon_terminus" 73 | - name: Set host key checking to accept new. 74 | lineinfile: 75 | path: "/home/backup/.ssh/config" 76 | regexp: "StrictHostKeyChecking=" 77 | line: "StrictHostKeyChecking=accept-new" 78 | state: present 79 | create: yes 80 | owner: "backup" 81 | group: "backup" 82 | mode: "u=rx,g=rx,o=" 83 | - name: Create the backup directory 84 | file: 85 | path: "/backups" 86 | state: directory 87 | owner: "backup" 88 | group: "backup" 89 | mode: "u=rwx,g=rwx,o=" 90 | - name: Update permissions of key directories 91 | file: 92 | path: "{{ item }}" 93 | state: directory 94 | owner: "backup" 95 | group: "backup" 96 | mode: "u=rwx,g=rwx,o=" 97 | loop: 98 | - "/home/backup/.ssh" 99 | handlers: 100 | - name: remove build deps 101 | shell: > 102 | apk del build-deps 103 | - name: clear apk cache 104 | file: 105 | path: "{{ item }}" 106 | state: absent 107 | loop: 108 | - "/tmp/*" 109 | - "/var/cache/apk/*" 110 | -------------------------------------------------------------------------------- /ansible/roles/tractorbeam/tasks/s3.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Create a tempfile for the rclone config 3 | tempfile: 4 | prefix: "tractorbeam-rclone-" 5 | suffix: ".conf" 6 | state: file 7 | register: _rclone_conf 8 | - name: Template the rclone conf 9 | copy: 10 | content: | 11 | [source] 12 | type = s3 13 | provider = {{ _backup.srcProvider | default('AWS') }} 14 | env_auth = false 15 | access_key_id = {{ _src_access_key }} 16 | secret_access_key = {{ _src_secret_key }} 17 | endpoint = {{ _backup.srcEndpoint | default('') | regex_replace('[A-z]*://', '') }} 18 | region = {{ _backup.srcRegion | default('') }} 19 | acl = {{ _backup.srcAcl | default('private') }} 20 | 21 | [dest] 22 | type = s3 23 | provider = {{ _backup.provider | default('AWS') }} 24 | env_auth = false 25 | access_key_id = {{ _dest_access_key }} 26 | secret_access_key = {{ _dest_secret_key }} 27 | endpoint = {{ _backup.endpoint | default('') | regex_replace('[A-z]*://', '') }} 28 | region = {{ _backup.region | default('') }} 29 | acl = {{ _backup.acl | default('private') }} 30 | dest: "{{ _rclone_conf.path }}" 31 | vars: 32 | _src_access_key: "\ 33 | {% if _backup.srcAccessKeyFile is defined %}\ 34 | {{ lookup('file', _backup.srcAccessKeyFile) }}\ 35 | {% else %}\ 36 | {{ _backup.srcAccessKey | default(omit) }}\ 37 | {% endif %}" 38 | _src_secret_key: "\ 39 | {% if _backup.srcSecretKeyFile is defined %}\ 40 | {{ lookup('file', _backup.srcSecretKeyFile) }}\ 41 | {% else %}\ 42 | {{ _backup.srcSecretKey | default(omit) }}\ 43 | {% endif %}" 44 | _dest_access_key: "\ 45 | {% if _backup.accessKeyFile is defined %}\ 46 | {{ lookup('file', _backup.accessKeyFile) }}\ 47 | {% else %}\ 48 | {{ _backup.accessKey | default(omit) }}\ 49 | {% endif %}" 50 | _dest_secret_key: "\ 51 | {% if _backup.secretKeyFile is defined %}\ 52 | {{ lookup('file', _backup.secretKeyFile) }}\ 53 | {% else %}\ 54 | {{ _backup.secretKey | default(omit) }}\ 55 | {% endif %}" 56 | - name: Create a cache directory for the backup 57 | file: 58 | state: directory 59 | path: "{{ _backup.cacheDir }}" 60 | owner: "backup" 61 | group: "backup" 62 | mode: "u=rwx,g=rxw,o=rwx" 63 | when: 64 | - _backup.cacheDir is defined 65 | - name: Sync files using rclone 66 | shell: > 67 | rclone sync 68 | source:/{{ _backup.srcBucket }}/{% if _backup.srcPrefix is defined %}{{ _backup.srcPrefix }}/{% elif _backup.prefix is defined %}{{ _backup.prefix }}/{% endif %} 69 | dest:/{{ _backup.bucket }}/{% if _backup.prefix is defined %}{{ _backup.prefix }}/{% endif %} 70 | --config="{{ _rclone_conf.path }}" 71 | {% for _exclude in _backup.excludes | default(_tractorbeam_default_files_excludes) %} 72 | --exclude="{{ _exclude }}"{{ '' }} 73 | {% endfor %} 74 | {% if _backup.delete | default(true) %} 75 | --delete-during 76 | {% endif %} 77 | {% if (flightdeck_debug | default(false)) != true %} 78 | --quiet 79 | {% else %} 80 | --verbose="4" 81 | {% endif %} 82 | register: _froms3_result 83 | until: _froms3_result.rc == 0 84 | retries: "{{ _backup.retryCount | default(3) }}" 85 | delay: "{{ _backup.retryDelay | default(30) }}" 86 | - include_tasks: "healhcheck.yml" 87 | -------------------------------------------------------------------------------- /ansible/roles/tractorbeam/tasks/files.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Create a temp directory to stage the backup 3 | tempfile: 4 | state: directory 5 | prefix: "files-{{ _backup.bucket }}-{{ _backup_timestamp }}" 6 | register: _files_temp_dir 7 | when: 8 | - _backup.cacheDir is not defined 9 | - name: Create a cache directory for the backup 10 | file: 11 | state: directory 12 | path: "{{ _backup.cacheDir }}" 13 | owner: "backup" 14 | group: "backup" 15 | mode: "u=rwx,g=rxw,o=rwx" 16 | when: 17 | - _backup.cacheDir is defined 18 | - name: Sync files from remote 19 | shell: > 20 | rsync 21 | {% for _option in _backup.options | default(['-az']) %} 22 | {{ _option }}{{ ' ' }} 23 | {% endfor %} 24 | -e "ssh -i {{ _backup.identityFile }} -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null {% if _backup.port is defined %}-p {{ _backup.port }}{% endif %}" 25 | {% for _exclude in _backup.excludes | default(_tractorbeam_default_files_excludes) %} 26 | --exclude={{ _exclude }}{{ ' ' }} 27 | {% endfor %} 28 | {% if _backup.delete | default(true) %} 29 | --delete 30 | {% endif %} 31 | --force 32 | --chown=backup:backup 33 | {{ _backup.user }}@{{ _backup.src }}:{{ _backup.path }}/ 34 | {{ _backup.cacheDir | default(_files_temp_dir.path) }} 35 | register: _files_rsync_result 36 | until: _files_rsync_result.rc == 0 37 | retries: "{{ _backup.retryCount | default(3) }}" 38 | delay: "{{ _backup.retryDelay | default(30) }}" 39 | - name: Create a tempfile for the rclone config 40 | tempfile: 41 | prefix: "tractorbeam-files-" 42 | suffix: ".conf" 43 | state: file 44 | register: _rclone_conf 45 | - name: Template the rclone conf 46 | copy: 47 | content: | 48 | [source] 49 | type = local 50 | copy_links = false 51 | links = false 52 | skip_links = true 53 | no_check_updated = true 54 | case_sensitive = true 55 | case_insensitive = false 56 | 57 | [dest] 58 | type = s3 59 | provider = {{ _backup.provider | default('AWS') }} 60 | env_auth = false 61 | access_key_id = {{ _dest_access_key }} 62 | secret_access_key = {{ _dest_secret_key }} 63 | endpoint = {{ _backup.endpoint | default('') | regex_replace('[A-z]*://', '') }} 64 | region = {{ _backup.region | default('') }} 65 | acl = {{ _backup.acl | default('private') }} 66 | dest: "{{ _rclone_conf.path }}" 67 | vars: 68 | _dest_access_key: "\ 69 | {% if _backup.accessKeyFile is defined %}\ 70 | {{ lookup('file', _backup.accessKeyFile) }}\ 71 | {% else %}\ 72 | {{ _backup.accessKey | default(omit) }}\ 73 | {% endif %}" 74 | _dest_secret_key: "\ 75 | {% if _backup.secretKeyFile is defined %}\ 76 | {{ lookup('file', _backup.secretKeyFile) }}\ 77 | {% else %}\ 78 | {{ _backup.secretKey | default(omit) }}\ 79 | {% endif %}" 80 | - name: Sync files using rclone 81 | shell: > 82 | rclone sync 83 | source:/{{ _backup.cacheDir | default(_files_temp_dir.path) }}/ 84 | dest:/{{ _backup.bucket }}/{% if _backup.prefix is defined %}{{ _backup.prefix }}/{% endif %} 85 | --config="{{ _rclone_conf.path }}" 86 | {% for _exclude in _backup.excludes | default(_tractorbeam_default_files_excludes) %} 87 | --exclude="{{ _exclude }}"{{ '' }} 88 | {% endfor %} 89 | {% if _backup.delete | default(true) %} 90 | --delete-during 91 | {% endif %} 92 | {% if (flightdeck_debug | default(false)) != true %} 93 | --quiet 94 | {% else %} 95 | --verbose="4" 96 | {% endif %} 97 | register: _fromlocal_result 98 | until: _fromlocal_result.rc == 0 99 | retries: "{{ _backup.retryCount | default(3) }}" 100 | delay: "{{ _backup.retryDelay | default(30) }}" 101 | - name: delete stage directory 102 | file: 103 | path: "_files_temp_dir.path" 104 | state: absent 105 | when: 106 | - _files_temp_dir.path is defined 107 | - include_tasks: "healhcheck.yml" 108 | -------------------------------------------------------------------------------- /ansible/roles/tractorbeam/tasks/platformshFiles.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Create a temp directory to stage the backup 3 | tempfile: 4 | state: directory 5 | prefix: "platformshFiles-{{ _backup.bucket }}-{{ _backup_timestamp }}" 6 | register: _platformshFiles_temp_dir 7 | when: 8 | - _backup.cacheDir is not defined 9 | - name: Create a cache directory for the backup 10 | file: 11 | state: directory 12 | path: "{{ _backup.cacheDir }}" 13 | owner: "backup" 14 | group: "backup" 15 | mode: "u=rwx,g=rxw,o=rwx" 16 | when: 17 | - _backup.cacheDir is defined 18 | - name: Copy identity files to ~/.ssh 19 | copy: 20 | src: "{{ item }}" 21 | dest: "/home/backup/.ssh/{{ item | basename }}" 22 | owner: "backup" 23 | group: "backup" 24 | mode: "u=rw,g=,o=" 25 | force: yes 26 | loop: 27 | - "{{ _backup.identityFile }}" 28 | - "{{ _backup.identityFile }}.pub" 29 | 30 | - name: Backup mounts 31 | shell: > 32 | platform mount:download 33 | -y 34 | {% for _exclude in _backup.excludes | default(_tractorbeam_default_platformshFiles_excludes) %} 35 | --exclude={{ _exclude }}{{ ' ' }} 36 | {% endfor %} 37 | {% if _backup.delete | default(true) %} 38 | --delete 39 | {% endif %} 40 | --project={{ _backup.project }} 41 | --environment={{ _backup.environment | default('master') }} 42 | --mount="{{ _backup.mount }}" 43 | --target="{{ _backup.cacheDir | default(_platformshFiles_temp_dir.path) }}/" 44 | register: _platformshFiles_download_result 45 | until: _platformshFiles_download_result.rc == 0 46 | retries: "{{ _backup.retryCount | default(3) }}" 47 | delay: "{{ _backup.retryDelay | default(30) }}" 48 | no_log: "{{ flightdeck_debug | default(false) | ternary(false, true) }}" 49 | environment: 50 | PLATFORMSH_CLI_TOKEN: "\ 51 | {% if _backup.cliTokenFile is defined %}\ 52 | {{ lookup('file', _backup.cliTokenFile) }}\ 53 | {% else %}\ 54 | {{ _backup.cliToken }}\ 55 | {% endif %}" 56 | 57 | - name: Create a tempfile for the rclone config 58 | tempfile: 59 | prefix: "tractorbeam-platformshFiles-" 60 | suffix: ".conf" 61 | state: file 62 | register: _rclone_conf 63 | - name: Template the rclone conf 64 | copy: 65 | content: | 66 | [source] 67 | type = local 68 | copy_links = false 69 | links = false 70 | skip_links = true 71 | no_check_updated = true 72 | case_sensitive = true 73 | case_insensitive = false 74 | 75 | [dest] 76 | type = s3 77 | provider = {{ _backup.provider | default('AWS') }} 78 | env_auth = false 79 | access_key_id = {{ _dest_access_key }} 80 | secret_access_key = {{ _dest_secret_key }} 81 | endpoint = {{ _backup.endpoint | default('') | regex_replace('[A-z]*://', '') }} 82 | region = {{ _backup.region | default('') }} 83 | acl = {{ _backup.acl | default('private') }} 84 | dest: "{{ _rclone_conf.path }}" 85 | vars: 86 | _dest_access_key: "\ 87 | {% if _backup.accessKeyFile is defined %}\ 88 | {{ lookup('file', _backup.accessKeyFile) }}\ 89 | {% else %}\ 90 | {{ _backup.accessKey | default(omit) }}\ 91 | {% endif %}" 92 | _dest_secret_key: "\ 93 | {% if _backup.secretKeyFile is defined %}\ 94 | {{ lookup('file', _backup.secretKeyFile) }}\ 95 | {% else %}\ 96 | {{ _backup.secretKey | default(omit) }}\ 97 | {% endif %}" 98 | 99 | - name: Sync files using rclone 100 | shell: > 101 | rclone sync 102 | source:/{{ _backup.cacheDir | default(_platformshFiles_temp_dir.path) }}/ 103 | dest:/{{ _backup.bucket }}/{% if _backup.prefix is defined %}{{ _backup.prefix }}/{% endif %} 104 | --config="{{ _rclone_conf.path }}" 105 | {% for _exclude in _backup.excludes | default(_tractorbeam_default_files_excludes) %} 106 | --exclude="{{ _exclude }}"{{ '' }} 107 | {% endfor %} 108 | {% if _backup.delete | default(true) %} 109 | --delete-during 110 | {% endif %} 111 | {% if (flightdeck_debug | default(false)) != true %} 112 | --quiet 113 | {% else %} 114 | --verbose="4" 115 | {% endif %} 116 | register: _platformshFiles_result 117 | until: _platformshFiles_result.rc == 0 118 | retries: "{{ _backup.retryCount | default(3) }}" 119 | delay: "{{ _backup.retryDelay | default(30) }}" 120 | 121 | - name: Removed identity files in ~/.ssh 122 | file: 123 | path: "/home/backup/.ssh/{{ item | basename }}" 124 | state: absent 125 | loop: 126 | - "{{ _backup.identityFile }}" 127 | - "{{ _backup.identityFile }}.pub" 128 | - name: delete stage directory 129 | file: 130 | path: "_platformshFiles_temp_dir.path" 131 | state: absent 132 | when: 133 | - _platformshFiles_temp_dir.path is defined 134 | - include_tasks: "healhcheck.yml" 135 | -------------------------------------------------------------------------------- /ansible/roles/tractorbeam/tasks/databases.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Backup database 3 | mysql_db: 4 | state: dump 5 | name: "{{ _backup.name }}" 6 | target: "{{ _run_temp_dir.path }}/{{ _backup.name }}_{{ _backup_timestamp }}.sql.gz" 7 | login_host: "{{ _backup.host | default('localhost') }}" 8 | login_port: "{{ _backup.port | default('3306') | int }}" 9 | login_user: "{{ _backup.user | default(omit) }}" 10 | client_cert: "{{ _backup.tlscert | default(omit) }}" 11 | client_key: "{{ _backup.tlskey | default(omit) }}" 12 | login_password: "\ 13 | {% if _backup.passwordFile is defined %}\ 14 | {{ lookup('file', _backup.passwordFile) }}\ 15 | {% else %}\ 16 | {{ _backup.password | default(omit) }}\ 17 | {% endif %}" 18 | no_log: "{{ flightdeck_debug | default(false) | ternary(false, true) }}" 19 | - name: Push backup to S3 20 | aws_s3: 21 | bucket: "{{ _backup.bucket }}" 22 | object: "{{ _backup.prefix | default('') }}/{{ tractorbeam_scope | default('') }}/{{ _backup.name }}_{{ _backup_timestamp }}.sql.gz" 23 | src: "{{ _run_temp_dir.path }}/{{ _backup.name }}_{{ _backup_timestamp }}.sql.gz" 24 | mode: put 25 | s3_url: "{{ _backup.endpoint | default(omit) }}" 26 | region: "{{ _backup.region | default(omit) }}" 27 | encrypt: no 28 | permission: private 29 | aws_access_key: "\ 30 | {% if _backup.accessKeyFile is defined %}\ 31 | {{ lookup('file', _backup.accessKeyFile) }}\ 32 | {% else %}\ 33 | {{ _backup.accessKey | default(omit) }}\ 34 | {% endif %}" 35 | aws_secret_key: "\ 36 | {% if _backup.secretKeyFile is defined %}\ 37 | {{ lookup('file', _backup.secretKeyFile) }}\ 38 | {% else %}\ 39 | {{ _backup.secretKey | default(omit) }}\ 40 | {% endif %}" 41 | no_log: "{{ flightdeck_debug | default(false) | ternary(false, true) }}" 42 | - name: Get list of files 43 | aws_s3: 44 | bucket: "{{ _backup.bucket }}" 45 | prefix: "{{ _backup.prefix }}/{{ tractorbeam_scope | default('') }}" 46 | mode: list 47 | aws_access_key: "\ 48 | {% if _backup.accessKeyFile is defined %}\ 49 | {{ lookup('file', _backup.accessKeyFile) }}\ 50 | {% else %}\ 51 | {{ _backup.accessKey | default(omit) }}\ 52 | {% endif %}" 53 | aws_secret_key: "\ 54 | {% if _backup.secretKeyFile is defined %}\ 55 | {{ lookup('file', _backup.secretKeyFile) }}\ 56 | {% else %}\ 57 | {{ _backup.secretKey | default(omit) }}\ 58 | {% endif %}" 59 | s3_url: "{{ _backup.endpoint | default(omit) }}" 60 | register: _list_backup 61 | - name: Filter and sort the list of files 62 | set_fact: 63 | _list_backup_sorted: "{{ _list_backup.s3_keys | select('regex', _regex) | list | sort }}" 64 | vars: 65 | _regex: "{{ _backup.name }}_[0-9]{14}\\.sql\\.gz" 66 | no_log: "{{ flightdeck_debug | default(false) | ternary(false, true) }}" 67 | - name: Delete old backups 68 | aws_s3: 69 | bucket: "{{ _backup.bucket }}" 70 | prefix: "{{ _backup.prefix }}/{{ tractorbeam_scope | default('') }}" 71 | mode: delobj 72 | object: "{{ item }}" 73 | aws_access_key: "\ 74 | {% if _backup.accessKeyFile is defined %}\ 75 | {{ lookup('file', _backup.accessKeyFile) }}\ 76 | {% else %}\ 77 | {{ _backup.accessKey | default(omit) }}\ 78 | {% endif %}" 79 | aws_secret_key: "\ 80 | {% if _backup.secretKeyFile is defined %}\ 81 | {{ lookup('file', _backup.secretKeyFile) }}\ 82 | {% else %}\ 83 | {{ _backup.secretKey | default(omit) }}\ 84 | {% endif %}" 85 | s3_url: "{{ _backup.endpoint | default(omit) }}" 86 | loop: "{{ _list_backup_sorted[:-(_retain_count | int)] }}" 87 | no_log: "{{ flightdeck_debug | default(false) | ternary(false, true) }}" 88 | - name: Push backup to S3 as latest 89 | aws_s3: 90 | bucket: "{{ _backup.bucket }}" 91 | object: "{{ _backup.prefix | default('') }}/{{ _backup.name }}_latest.sql.gz" 92 | src: "{{ _run_temp_dir.path }}/{{ _backup.name }}_{{ _backup_timestamp }}.sql.gz" 93 | mode: put 94 | s3_url: "{{ _backup.endpoint | default(omit) }}" 95 | region: "{{ _backup.region | default(omit) }}" 96 | encrypt: no 97 | permission: private 98 | overwrite: yes 99 | aws_access_key: "\ 100 | {% if _backup.accessKeyFile is defined %}\ 101 | {{ lookup('file', _backup.accessKeyFile) }}\ 102 | {% else %}\ 103 | {{ _backup.accessKey | default(omit) }}\ 104 | {% endif %}" 105 | aws_secret_key: "\ 106 | {% if _backup.secretKeyFile is defined %}\ 107 | {{ lookup('file', _backup.secretKeyFile) }}\ 108 | {% else %}\ 109 | {{ _backup.secretKey | default(omit) }}\ 110 | {% endif %}" 111 | no_log: "{{ flightdeck_debug | default(false) | ternary(false, true) }}" 112 | - include_tasks: "healhcheck.yml" 113 | -------------------------------------------------------------------------------- /ansible/roles/tractorbeam/tasks/platformshDatabases.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Generate the backup filename 3 | set_fact: 4 | _platform_db_file: "{{ _backup.project }}_{{ _backup.environment | default('master') }}_{{ _backup.relationship }}_{{ _backup_timestamp }}.sql.gz" 5 | _platform_db_latest: "{{ _backup.project }}_{{ _backup.environment | default('master') }}_{{ _backup.relationship }}_latest.sql.gz" 6 | - name: Backup database 7 | shell: > 8 | platform db:dump 9 | --directory={{ _run_temp_dir.path }} 10 | --file={{ _platform_db_file }} 11 | -z 12 | -y 13 | --project={{ _backup.project }} 14 | --environment={{ _backup.environment | default('master') }} 15 | --relationship={{ _backup.relationship }} 16 | {% if _backup.identityFile is defined %} 17 | --identity-file={{ _backup.identityFile }} 18 | {% endif %} 19 | register: _platformshDatabases_backup_result 20 | until: _platformshDatabases_backup_result.rc == 0 21 | retries: "{{ _backup.retryCount | default(3) }}" 22 | delay: "{{ _backup.retryDelay | default(30) }}" 23 | no_log: "{{ flightdeck_debug | default(false) | ternary(false, true) }}" 24 | environment: 25 | PLATFORMSH_CLI_TOKEN: "\ 26 | {% if _backup.cliTokenFile is defined %}\ 27 | {{ lookup('file', _backup.cliTokenFile) }}\ 28 | {% else %}\ 29 | {{ _backup.cliToken }}\ 30 | {% endif %}" 31 | - name: Push backup to S3 32 | aws_s3: 33 | bucket: "{{ _backup.bucket }}" 34 | object: "{{ _backup.prefix | default('') }}/{{ tractorbeam_scope | default('') }}/{{ _platform_db_file }}" 35 | src: "{{ _run_temp_dir.path }}/{{ _platform_db_file }}" 36 | mode: put 37 | s3_url: "{{ _backup.endpoint | default(omit) }}" 38 | region: "{{ _backup.region | default(omit) }}" 39 | encrypt: no 40 | permission: private 41 | aws_access_key: "\ 42 | {% if _backup.accessKeyFile is defined %}\ 43 | {{ lookup('file', _backup.accessKeyFile) }}\ 44 | {% else %}\ 45 | {{ _backup.accessKey | default(omit) }}\ 46 | {% endif %}" 47 | aws_secret_key: "\ 48 | {% if _backup.secretKeyFile is defined %}\ 49 | {{ lookup('file', _backup.secretKeyFile) }}\ 50 | {% else %}\ 51 | {{ _backup.secretKey | default(omit) }}\ 52 | {% endif %}" 53 | no_log: "{{ flightdeck_debug | default(false) | ternary(false, true) }}" 54 | - name: Get list of files 55 | aws_s3: 56 | bucket: "{{ _backup.bucket }}" 57 | prefix: "{{ _backup.prefix }}/{{ tractorbeam_scope | default('') }}" 58 | mode: list 59 | aws_access_key: "\ 60 | {% if _backup.accessKeyFile is defined %}\ 61 | {{ lookup('file', _backup.accessKeyFile) }}\ 62 | {% else %}\ 63 | {{ _backup.accessKey | default(omit) }}\ 64 | {% endif %}" 65 | aws_secret_key: "\ 66 | {% if _backup.secretKeyFile is defined %}\ 67 | {{ lookup('file', _backup.secretKeyFile) }}\ 68 | {% else %}\ 69 | {{ _backup.secretKey | default(omit) }}\ 70 | {% endif %}" 71 | s3_url: "{{ _backup.endpoint | default(omit) }}" 72 | register: _list_backup 73 | - name: Filter and sort the list of files 74 | set_fact: 75 | _list_backup_sorted: "{{ _list_backup.s3_keys | select('regex', _regex) | list | sort }}" 76 | vars: 77 | _regex: "{{ _backup.project }}_{{ _backup.environment | default('master') }}_{{ _backup.relationship }}_[0-9]{14}\\.sql\\.gz" 78 | no_log: "{{ flightdeck_debug | default(false) | ternary(false, true) }}" 79 | - name: Delete old backups 80 | aws_s3: 81 | bucket: "{{ _backup.bucket }}" 82 | prefix: "{{ _backup.prefix }}/{{ tractorbeam_scope | default('') }}" 83 | mode: delobj 84 | object: "{{ item }}" 85 | aws_access_key: "\ 86 | {% if _backup.accessKeyFile is defined %}\ 87 | {{ lookup('file', _backup.accessKeyFile) }}\ 88 | {% else %}\ 89 | {{ _backup.accessKey | default(omit) }}\ 90 | {% endif %}" 91 | aws_secret_key: "\ 92 | {% if _backup.secretKeyFile is defined %}\ 93 | {{ lookup('file', _backup.secretKeyFile) }}\ 94 | {% else %}\ 95 | {{ _backup.secretKey | default(omit) }}\ 96 | {% endif %}" 97 | s3_url: "{{ _backup.endpoint | default(omit) }}" 98 | loop: "{{ _list_backup_sorted[:-(_retain_count | int)] }}" 99 | no_log: "{{ flightdeck_debug | default(false) | ternary(false, true) }}" 100 | - name: Push backup to S3 as latest 101 | aws_s3: 102 | bucket: "{{ _backup.bucket }}" 103 | object: "{{ _backup.prefix | default('') }}/{{ _platform_db_latest }}" 104 | src: "{{ _run_temp_dir.path }}/{{ _platform_db_file }}" 105 | mode: put 106 | s3_url: "{{ _backup.endpoint | default(omit) }}" 107 | region: "{{ _backup.region | default(omit) }}" 108 | encrypt: no 109 | permission: private 110 | overwrite: yes 111 | aws_access_key: "\ 112 | {% if _backup.accessKeyFile is defined %}\ 113 | {{ lookup('file', _backup.accessKeyFile) }}\ 114 | {% else %}\ 115 | {{ _backup.accessKey | default(omit) }}\ 116 | {% endif %}" 117 | aws_secret_key: "\ 118 | {% if _backup.secretKeyFile is defined %}\ 119 | {{ lookup('file', _backup.secretKeyFile) }}\ 120 | {% else %}\ 121 | {{ _backup.secretKey | default(omit) }}\ 122 | {% endif %}" 123 | no_log: "{{ flightdeck_debug | default(false) | ternary(false, true) }}" 124 | - include_tasks: "healhcheck.yml" 125 | -------------------------------------------------------------------------------- /ansible/roles/tractorbeam/tasks/archives.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Create a temp directory to stage the backup 3 | tempfile: 4 | state: directory 5 | prefix: "archives-{{ _backup.bucket }}-{{ _backup_timestamp }}" 6 | register: _archives_temp_dir 7 | - name: Generate the archive filename 8 | set_fact: 9 | _archive_file_name: "{{ _backup.archivePrefix }}{{ _backup_timestamp }}{{ _tractorbeam_archives_extensions[_format] }}" 10 | _archive_latest_name: "{{ _backup.archivePrefix }}_latest{{ _tractorbeam_archives_extensions[_format] }}" 11 | _archive_file_regex: "{{ _backup.archivePrefix | regex_escape() }}[0-9]{14}{{ _tractorbeam_archives_extensions[_format] | regex_escape() }}" 12 | vars: 13 | _format: "{{ _backup.archiveFormat | default('gz') }}" 14 | - name: Sync files from remote 15 | shell: > 16 | rsync 17 | -az 18 | --safe-links 19 | -e "ssh -i {{ _backup.identityFile }} -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null" 20 | {% for _exclude in _backup.excludes | default(_tractorbeam_default_files_excludes) %} 21 | --exclude={{ _exclude }}{{ ' ' }} 22 | {% endfor %} 23 | {% if _backup.delete | default(true) %} 24 | --delete 25 | {% endif %} 26 | --force 27 | --chown=backup:backup 28 | {{ _backup.user }}@{{ _backup.src }}:{{ _backup.path }}/ 29 | {{ _archives_temp_dir.path }}/files 30 | - name: Create archive 31 | archive: 32 | path: "{{ _archives_temp_dir.path }}/files/*" 33 | dest: "{{ _archives_temp_dir.path }}/{{ _archive_file_name }}" 34 | format: "{{ _backup.archiveFormat | default('gz') }}" 35 | owner: "backup" 36 | group: "backup" 37 | mode: "u=r,g=r,o=" 38 | - name: Push backup to S3 39 | aws_s3: 40 | bucket: "{{ _backup.bucket }}" 41 | object: "{{ _backup.prefix | default('') }}/{{ tractorbeam_scope | default('') }}/{{ _archive_file_name }}" 42 | src: "{{ _archives_temp_dir.path }}/{{ _archive_file_name }}" 43 | mode: put 44 | s3_url: "{{ _backup.endpoint | default(omit) }}" 45 | region: "{{ _backup.region | default(omit) }}" 46 | encrypt: no 47 | permission: private 48 | aws_access_key: "\ 49 | {% if _backup.accessKeyFile is defined %}\ 50 | {{ lookup('file', _backup.accessKeyFile) }}\ 51 | {% else %}\ 52 | {{ _backup.accessKey | default(omit) }}\ 53 | {% endif %}" 54 | aws_secret_key: "\ 55 | {% if _backup.secretKeyFile is defined %}\ 56 | {{ lookup('file', _backup.secretKeyFile) }}\ 57 | {% else %}\ 58 | {{ _backup.secretKey | default(omit) }}\ 59 | {% endif %}" 60 | no_log: "{{ flightdeck_debug | default(false) | ternary(false, true) }}" 61 | - name: Get list of files 62 | aws_s3: 63 | bucket: "{{ _backup.bucket }}" 64 | prefix: "{{ _backup.prefix }}/{{ tractorbeam_scope | default('') }}" 65 | mode: list 66 | aws_access_key: "\ 67 | {% if _backup.accessKeyFile is defined %}\ 68 | {{ lookup('file', _backup.accessKeyFile) }}\ 69 | {% else %}\ 70 | {{ _backup.accessKey | default(omit) }}\ 71 | {% endif %}" 72 | aws_secret_key: "\ 73 | {% if _backup.secretKeyFile is defined %}\ 74 | {{ lookup('file', _backup.secretKeyFile) }}\ 75 | {% else %}\ 76 | {{ _backup.secretKey | default(omit) }}\ 77 | {% endif %}" 78 | s3_url: "{{ _backup.endpoint | default(omit) }}" 79 | register: _list_backup 80 | - name: Filter and sort the list of files 81 | set_fact: 82 | _list_backup_sorted: "{{ _list_backup.s3_keys | select('regex', _archive_file_regex) | list | sort }}" 83 | no_log: "{{ flightdeck_debug | default(false) | ternary(false, true) }}" 84 | - name: Delete old backups 85 | aws_s3: 86 | bucket: "{{ _backup.bucket }}" 87 | prefix: "{{ _backup.prefix }}/{{ tractorbeam_scope | default('') }}" 88 | mode: delobj 89 | object: "{{ item }}" 90 | aws_access_key: "\ 91 | {% if _backup.accessKeyFile is defined %}\ 92 | {{ lookup('file', _backup.accessKeyFile) }}\ 93 | {% else %}\ 94 | {{ _backup.accessKey | default(omit) }}\ 95 | {% endif %}" 96 | aws_secret_key: "\ 97 | {% if _backup.secretKeyFile is defined %}\ 98 | {{ lookup('file', _backup.secretKeyFile) }}\ 99 | {% else %}\ 100 | {{ _backup.secretKey | default(omit) }}\ 101 | {% endif %}" 102 | s3_url: "{{ _backup.endpoint | default(omit) }}" 103 | loop: "{{ _list_backup_sorted[:-(_retain_count | int)] }}" 104 | no_log: "{{ flightdeck_debug | default(false) | ternary(false, true) }}" 105 | - name: Push backup to S3 as latest 106 | aws_s3: 107 | bucket: "{{ _backup.bucket }}" 108 | object: "{{ _backup.prefix | default('') }}/{{ _archive_latest_name }}" 109 | src: "{{ _archives_temp_dir.path }}/{{ _archive_file_name }}" 110 | mode: put 111 | s3_url: "{{ _backup.endpoint | default(omit) }}" 112 | region: "{{ _backup.region | default(omit) }}" 113 | encrypt: no 114 | permission: private 115 | overwrite: yes 116 | aws_access_key: "\ 117 | {% if _backup.accessKeyFile is defined %}\ 118 | {{ lookup('file', _backup.accessKeyFile) }}\ 119 | {% else %}\ 120 | {{ _backup.accessKey | default(omit) }}\ 121 | {% endif %}" 122 | aws_secret_key: "\ 123 | {% if _backup.secretKeyFile is defined %}\ 124 | {{ lookup('file', _backup.secretKeyFile) }}\ 125 | {% else %}\ 126 | {{ _backup.secretKey | default(omit) }}\ 127 | {% endif %}" 128 | no_log: "{{ flightdeck_debug | default(false) | ternary(false, true) }}" 129 | - name: delete stage directory 130 | file: 131 | path: "_archives_temp_dir.path" 132 | state: absent 133 | - include_tasks: "healhcheck.yml" 134 | -------------------------------------------------------------------------------- /ansible/roles/tractorbeam/tasks/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Get a list of backupSets. 3 | set_fact: 4 | _backupSets: "{{ _tractorbeam_default_backupSets | combine(tractorbeam.backupSets | default({}), recursive=True) }}" 5 | - name: Stop if the backupSet doesn't exist. 6 | fail: 7 | msg: > 8 | The given backupSet name '{{ tractorbeam_scope | default() }}' is not in tractorbeam.yml. 9 | 10 | Known backupSets are: "{{ _backupSets.keys() | list | join(', ') }}" 11 | when: 12 | - (tractorbeam_scope is not defined) or (tractorbeam_scope not in _backupSets) 13 | - name: Get the backupSet {{ tractorbeam_scope | default() }}. 14 | set_fact: 15 | _backupSet: "{{ _backupSets[tractorbeam_scope] }}" 16 | # 17 | # Get ready for backups. 18 | # 19 | - name: Generate the backup timestamp. 20 | set_fact: 21 | _backup_timestamp: "{{lookup('pipe','date +%Y%m%d%H%M%S')}}" 22 | - name: Create a temp directory to store files needed by the run 23 | tempfile: 24 | state: directory 25 | prefix: "tractorbeam-run-{{ _backup_timestamp }}" 26 | register: _run_temp_dir 27 | notify: 28 | - delete temp items 29 | # 30 | # Backups start here. 31 | # 32 | - name: Work with databases 33 | include_tasks: "databases.yml" 34 | vars: 35 | _retain_count: "{{ _backupSet.retainCount }}" 36 | loop: "{{ tractorbeam.databases | default([]) }}" 37 | loop_control: 38 | loop_var: _backup 39 | no_log: "{{ flightdeck_debug | default(false) | ternary(false, true) }}" 40 | when: 41 | - _backup.disabled | default(false) == false 42 | - tractorbeam_scope in _backup.backupSets | default(_tractorbeam_default_sets_for_backup) 43 | ignore_errors: "{{ tractorbeam.stop_on_failure | default(false) | bool }}" 44 | 45 | - name: Work with pantheon backups 46 | include_tasks: "pantheon.yml" 47 | vars: 48 | _retain_count: "{{ _backupSet.retainCount }}" 49 | loop: "{{ tractorbeam.pantheon | default([]) }}" 50 | loop_control: 51 | loop_var: _backup 52 | no_log: "{{ flightdeck_debug | default(false) | ternary(false, true) }}" 53 | when: 54 | - _backup.disabled | default(false) == false 55 | - tractorbeam_scope in _backup.backupSets | default(_tractorbeam_default_sets_for_backup) 56 | ignore_errors: "{{ tractorbeam.stop_on_failure | default(false) | bool }}" 57 | 58 | - name: Work with platform.sh databases 59 | include_tasks: "platformshDatabases.yml" 60 | vars: 61 | _retain_count: "{{ _backupSet.retainCount }}" 62 | loop: "{{ tractorbeam.platformshDatabases | default([]) }}" 63 | loop_control: 64 | loop_var: _backup 65 | no_log: "{{ flightdeck_debug | default(false) | ternary(false, true) }}" 66 | when: 67 | - _backup.disabled | default(false) == false 68 | - tractorbeam_scope in _backup.backupSets | default(_tractorbeam_default_sets_for_backup) 69 | ignore_errors: "{{ tractorbeam.stop_on_failure | default(false) | bool }}" 70 | 71 | - name: Work with archives 72 | include_tasks: "archives.yml" 73 | vars: 74 | _retain_count: "{{ _backupSet.retainCount }}" 75 | loop: "{{ tractorbeam.archives | default([]) }}" 76 | loop_control: 77 | loop_var: _backup 78 | no_log: "{{ flightdeck_debug | default(false) | ternary(false, true) }}" 79 | when: 80 | - _backup.disabled | default(false) == false 81 | - tractorbeam_scope in _backup.backupSets | default(_tractorbeam_default_sets_for_backup) 82 | ignore_errors: "{{ tractorbeam.stop_on_failure | default(false) | bool }}" 83 | 84 | - name: Work with file backups 85 | include_tasks: "files.yml" 86 | vars: 87 | _retain_count: "{{ _backupSet.retainCount }}" 88 | loop: "{{ tractorbeam.files | default([]) }}" 89 | loop_control: 90 | loop_var: _backup 91 | no_log: "{{ flightdeck_debug | default(false) | ternary(false, true) }}" 92 | when: 93 | - _backup.disabled | default(false) == false 94 | - tractorbeam_scope in _backup.backupSets | default(_tractorbeam_default_sets_for_backup) 95 | ignore_errors: "{{ tractorbeam.stop_on_failure | default(false) | bool }}" 96 | 97 | - name: Work with platform.sh files 98 | include_tasks: "platformshFiles.yml" 99 | vars: 100 | _retain_count: "{{ _backupSet.retainCount }}" 101 | loop: "{{ tractorbeam.platformshFiles | default([]) }}" 102 | loop_control: 103 | loop_var: _backup 104 | no_log: "{{ flightdeck_debug | default(false) | ternary(false, true) }}" 105 | when: 106 | - _backup.disabled | default(false) == false 107 | - tractorbeam_scope in _backup.backupSets | default(_tractorbeam_default_sets_for_backup) 108 | ignore_errors: "{{ tractorbeam.stop_on_failure | default(false) | bool }}" 109 | # 110 | # Local file backups run second to last. 111 | # 112 | - name: Work with local files 113 | include_tasks: "local.yml" 114 | vars: 115 | _retain_count: "{{ _backupSet.retainCount }}" 116 | loop: "{{ tractorbeam.local | default([]) }}" 117 | loop_control: 118 | loop_var: _backup 119 | no_log: "{{ flightdeck_debug | default(false) | ternary(false, true) }}" 120 | when: 121 | - _backup.disabled | default(false) == false 122 | - tractorbeam_scope in _backup.backupSets | default(_tractorbeam_default_sets_for_backup) 123 | ignore_errors: "{{ tractorbeam.stop_on_failure | default(false) | bool }}" 124 | 125 | # 126 | # S3 to S3 backups always run last! 127 | # 128 | - name: Work with s3 backups 129 | include_tasks: "s3.yml" 130 | vars: 131 | _retain_count: "{{ _backupSet.retainCount }}" 132 | loop: "{{ tractorbeam.s3 | default([]) }}" 133 | loop_control: 134 | loop_var: _backup 135 | no_log: "{{ flightdeck_debug | default(false) | ternary(false, true) }}" 136 | when: 137 | - _backup.disabled | default(false) == false 138 | - tractorbeam_scope in _backup.backupSets | default(_tractorbeam_default_sets_for_backup) 139 | ignore_errors: "{{ tractorbeam.stop_on_failure | default(false) | bool }}" 140 | 141 | # 142 | # S3 to sftp always run last! 143 | # 144 | - name: Work with sftp backups 145 | include_tasks: "sftp.yml" 146 | vars: 147 | _retain_count: "{{ _backupSet.retainCount }}" 148 | loop: "{{ tractorbeam.sftp | default([]) }}" 149 | loop_control: 150 | loop_var: _backup 151 | no_log: "{{ flightdeck_debug | default(false) | ternary(false, true) }}" 152 | when: 153 | - _backup.disabled | default(false) == false 154 | - tractorbeam_scope in _backup.backupSets | default(_tractorbeam_default_sets_for_backup) 155 | ignore_errors: "{{ tractorbeam.stop_on_failure | default(false) | bool }}" 156 | -------------------------------------------------------------------------------- /ansible/roles/tractorbeam/tasks/pantheon.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Create a temp directory to stage the backup 3 | tempfile: 4 | state: directory 5 | prefix: "files-{{ _backup.bucket }}-{{ _backup_timestamp }}" 6 | register: _pantheon_temp_dir 7 | when: 8 | - _backup.cacheDir is not defined 9 | - name: Create a cache directory for the backup 10 | file: 11 | state: directory 12 | path: "{{ _backup.cacheDir }}" 13 | owner: "backup" 14 | group: "backup" 15 | mode: "u=rwx,g=rxw,o=rwx" 16 | when: 17 | - _backup.cacheDir is defined 18 | - name: Authenticate with Pantheon 19 | shell: > 20 | terminus auth:login 21 | --machine-token={{ _auth }} 22 | {% if (flightdeck_debug | default(false)) != true %} 23 | --quiet 24 | {% elif lookup('env', 'ANSIBLE_VERBOSITY') == 4 %} 25 | -vvv 26 | {% endif %} 27 | --no-interaction 28 | --yes 29 | register: _pantheon_login_result 30 | until: _pantheon_login_result.rc == 0 31 | retries: "{{ _backup.retryCount | default(3) }}" 32 | delay: "{{ _backup.retryDelay | default(30) }}" 33 | vars: 34 | _auth: "\ 35 | {% if _backup.machineTokenFile is defined %}\ 36 | {{ lookup('file', _backup.machineTokenFile) }}\ 37 | {% else %}\ 38 | {{ _backup.machineToken }}\ 39 | {% endif %}" 40 | - name: Create backup 41 | shell: > 42 | terminus backup:create 43 | {{ _backup.site }}.{{ _backup.environment }} 44 | --element={{ _backup.element | default('database') }} 45 | {% if (flightdeck_debug | default(false)) != true %} 46 | --quiet 47 | {% elif lookup('env', 'ANSIBLE_VERBOSITY') == 4 %} 48 | -vvv 49 | {% endif %} 50 | --no-interaction 51 | --yes 52 | register: _pantheon_backup_result 53 | until: _pantheon_backup_result.rc == 0 54 | retries: "{{ _backup.retryCount | default(3) }}" 55 | delay: "{{ _backup.retryDelay | default(30) }}" 56 | - name: Get list of backups 57 | shell: > 58 | terminus backup:list 59 | {{ _backup.site }}.{{ _backup.environment }} 60 | --element={{ _backup.element | default('database') }} 61 | --field=file 62 | {% if lookup('env', 'ANSIBLE_VERBOSITY') == 4 %} 63 | -vvv 64 | {% endif %} 65 | --no-interaction 66 | --yes 67 | register: _pantheon_backup_list 68 | - name: Get the most recent backup 69 | set_fact: 70 | _pantheon_backup_filename: "{{ _pantheon_backup_list.stdout_lines | default([]) | first }}" 71 | - name: Download backup 72 | shell: > 73 | terminus backup:get 74 | {{ _backup.site }}.{{ _backup.environment }} 75 | --file={{ _pantheon_backup_filename }} 76 | --to={{ _backup.cacheDir | default(_pantheon_temp_dir.path) }}/{{ _pantheon_backup_filename }} 77 | {% if lookup('env', 'ANSIBLE_VERBOSITY') == 4 %} 78 | -vvv 79 | {% endif %} 80 | --no-interaction 81 | --yes 82 | register: _pantheon_download_result 83 | until: _pantheon_download_result.rc == 0 84 | retries: "{{ _backup.retryCount | default(3) }}" 85 | delay: "{{ _backup.retryDelay | default(30) }}" 86 | args: 87 | creates: "{{ _backup.cacheDir | default(_pantheon_temp_dir.path) }}/{{ _pantheon_backup_filename }}" 88 | - name: Push backup to S3 89 | aws_s3: 90 | bucket: "{{ _backup.bucket }}" 91 | object: "{{ _backup.prefix | default('') }}/{{ tractorbeam_scope | default('') }}/{{ _pantheon_backup_filename }}" 92 | src: "{{ _backup.cacheDir | default(_pantheon_temp_dir.path) }}/{{ _pantheon_backup_filename }}" 93 | mode: put 94 | s3_url: "{{ _backup.endpoint | default(omit) }}" 95 | region: "{{ _backup.region | default(omit) }}" 96 | encrypt: no 97 | permission: private 98 | aws_access_key: "\ 99 | {% if _backup.accessKeyFile is defined %}\ 100 | {{ lookup('file', _backup.accessKeyFile) }}\ 101 | {% else %}\ 102 | {{ _backup.accessKey | default(omit) }}\ 103 | {% endif %}" 104 | aws_secret_key: "\ 105 | {% if _backup.secretKeyFile is defined %}\ 106 | {{ lookup('file', _backup.secretKeyFile) }}\ 107 | {% else %}\ 108 | {{ _backup.secretKey | default(omit) }}\ 109 | {% endif %}" 110 | no_log: "{{ flightdeck_debug | default(false) | ternary(false, true) }}" 111 | - name: Get list of files 112 | aws_s3: 113 | bucket: "{{ _backup.bucket }}" 114 | prefix: "{{ _backup.prefix }}/{{ tractorbeam_scope | default('') }}" 115 | mode: list 116 | aws_access_key: "\ 117 | {% if _backup.accessKeyFile is defined %}\ 118 | {{ lookup('file', _backup.accessKeyFile) }}\ 119 | {% else %}\ 120 | {{ _backup.accessKey | default(omit) }}\ 121 | {% endif %}" 122 | aws_secret_key: "\ 123 | {% if _backup.secretKeyFile is defined %}\ 124 | {{ lookup('file', _backup.secretKeyFile) }}\ 125 | {% else %}\ 126 | {{ _backup.secretKey | default(omit) }}\ 127 | {% endif %}" 128 | s3_url: "{{ _backup.endpoint | default(omit) }}" 129 | register: _list_backup 130 | - name: Filter and sort the list of files 131 | set_fact: 132 | _list_backup_sorted: "{{ _list_backup.s3_keys | select('regex', _regex) | list | sort }}" 133 | vars: 134 | _regex: "\ 135 | {% if _backup.element | default('database') == 'database' %}\ 136 | \\.sql\\.gz\ 137 | {% else %}\ 138 | \\.tar\\.gz\ 139 | {% endif %}" 140 | no_log: "{{ flightdeck_debug | default(false) | ternary(false, true) }}" 141 | - name: Delete old backups 142 | aws_s3: 143 | bucket: "{{ _backup.bucket }}" 144 | prefix: "{{ _backup.prefix }}/{{ tractorbeam_scope | default('') }}" 145 | mode: delobj 146 | object: "{{ item }}" 147 | aws_access_key: "\ 148 | {% if _backup.accessKeyFile is defined %}\ 149 | {{ lookup('file', _backup.accessKeyFile) }}\ 150 | {% else %}\ 151 | {{ _backup.accessKey | default(omit) }}\ 152 | {% endif %}" 153 | aws_secret_key: "\ 154 | {% if _backup.secretKeyFile is defined %}\ 155 | {{ lookup('file', _backup.secretKeyFile) }}\ 156 | {% else %}\ 157 | {{ _backup.secretKey | default(omit) }}\ 158 | {% endif %}" 159 | s3_url: "{{ _backup.endpoint | default(omit) }}" 160 | loop: "{{ _list_backup_sorted[:-(_retain_count | int)] }}" 161 | no_log: "{{ flightdeck_debug | default(false) | ternary(false, true) }}" 162 | - name: Push backup to S3 as latest 163 | aws_s3: 164 | bucket: "{{ _backup.bucket }}" 165 | object: "{{ _backup.prefix | default('') }}/{{ _backup.site }}_{{ _backup.environment }}_latest.tar.gz" 166 | src: "{{ _backup.cacheDir | default(_pantheon_temp_dir.path) }}/{{ _pantheon_backup_filename }}" 167 | mode: put 168 | s3_url: "{{ _backup.endpoint | default(omit) }}" 169 | region: "{{ _backup.region | default(omit) }}" 170 | encrypt: no 171 | permission: private 172 | overwrite: yes 173 | aws_access_key: "\ 174 | {% if _backup.accessKeyFile is defined %}\ 175 | {{ lookup('file', _backup.accessKeyFile) }}\ 176 | {% else %}\ 177 | {{ _backup.accessKey | default(omit) }}\ 178 | {% endif %}" 179 | aws_secret_key: "\ 180 | {% if _backup.secretKeyFile is defined %}\ 181 | {{ lookup('file', _backup.secretKeyFile) }}\ 182 | {% else %}\ 183 | {{ _backup.secretKey | default(omit) }}\ 184 | {% endif %}" 185 | no_log: "{{ flightdeck_debug | default(false) | ternary(false, true) }}" 186 | - name: Logout of Pantheon 187 | shell: > 188 | terminus auth:logout 189 | --no-interaction 190 | --yes 191 | - include_tasks: "healhcheck.yml" 192 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------