├── s3 ├── build ├── Dockerfile └── s3.sh ├── doc ├── backup.timer └── backup.service ├── Dockerfile ├── backup.sh ├── README.md └── LICENSE /s3/build: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | docker build --force-rm -t boombatower/docker-backup-s3 . 3 | -------------------------------------------------------------------------------- /doc/backup.timer: -------------------------------------------------------------------------------- 1 | # http://www.freedesktop.org/software/systemd/man/systemd.timer.html 2 | # http://www.freedesktop.org/software/systemd/man/systemd.time.html 3 | 4 | [Unit] 5 | Description=Backup data-container every night. 6 | 7 | [Timer] 8 | OnCalendar=daily 9 | Persistent=true 10 | Unit=backup.service 11 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | # http://docs.docker.com/reference/builder 2 | # docker backup image (boombatower/docker-backup). 3 | 4 | FROM boombatower/opensuse 5 | MAINTAINER Jimmy Berry 6 | 7 | RUN zypper refresh && \ 8 | zypper -n in --no-recommends tar xz 9 | 10 | ADD backup.sh /root/bin/ 11 | 12 | VOLUME /backup 13 | ENTRYPOINT ["/root/bin/backup.sh"] 14 | CMD ["backup"] 15 | -------------------------------------------------------------------------------- /doc/backup.service: -------------------------------------------------------------------------------- 1 | # http://www.freedesktop.org/software/systemd/man/systemd.service.html 2 | 3 | [Unit] 4 | Description=Backup data-container. 5 | After=docker.service 6 | 7 | [Service] 8 | Type=oneshot 9 | ExecStart=/usr/bin/docker run --rm \ 10 | --volumes-from data-container \ 11 | -e ACCESS_KEY="..." \ 12 | -e SECRET_KEY="..." \ 13 | -e BUCKET="s3://[BUCKET]/" \ 14 | boombatower/docker-backup-s3 backup data-container.tar.xz 15 | -------------------------------------------------------------------------------- /s3/Dockerfile: -------------------------------------------------------------------------------- 1 | # http://docs.docker.com/reference/builder 2 | # docker backup via s3 image (boombatower/docker-backup-s3). 3 | 4 | FROM boombatower/docker-backup 5 | MAINTAINER Jimmy Berry 6 | 7 | RUN zypper refresh && \ 8 | zypper -n in --no-recommends python-boto python-dateutil python-magic python-xml 9 | 10 | ADD https://github.com/s3tools/s3cmd/archive/v1.5.0.tar.gz /root/ 11 | RUN cd /root && tar -zxvf v1.5.0.tar.gz && cd s3cmd-1.5.0 && python setup.py install 12 | 13 | ADD s3.sh /root/bin/ 14 | 15 | ENTRYPOINT ["/root/bin/s3.sh"] 16 | CMD ["backup"] 17 | -------------------------------------------------------------------------------- /s3/s3.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # Usage: s3.sh backup|restore [filename] 3 | # - filename: backup.tar.xz 4 | # Environment variables: 5 | # - required: ACCESS_KEY, SECRET_KEY, and BUCKET 6 | # - optional: S3CMD_OPTS 7 | 8 | if [ -z "$ACCESS_KEY" -o -z "$SECRET_KEY" -o -z $BUCKET ] 9 | then 10 | echo "ACCESS_KEY, SECRET_KEY, and BUCKET environment variables are required" 11 | exit 1 12 | fi 13 | 14 | file="backup.tar.xz" 15 | if [ $# -eq 2 ]; then 16 | file="$2" 17 | fi 18 | 19 | if [ "$1" = "backup" ]; then 20 | /root/bin/backup.sh backup "$file" 21 | s3cmd --access_key="$ACCESS_KEY" --secret_key="$SECRET_KEY" \ 22 | -c /dev/null $S3CMD_OPTS put "/backup/$file" $BUCKET 23 | elif [ "$1" = "restore" ]; then 24 | s3cmd --access_key="$ACCESS_KEY" --secret_key="$SECRET_KEY" \ 25 | -c /dev/null $S3CMD_OPTS get "$BUCKET$file" "/backup/$file" 26 | /root/bin/backup.sh restore "$file" 27 | fi 28 | -------------------------------------------------------------------------------- /backup.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # Usage: backup.sh backup|restore [filename] 3 | # - filename: backup.tar.xz 4 | # Environment variables: 5 | # - optional: TAR_OPTS 6 | 7 | file="backup.tar.xz" 8 | if [ $# -eq 2 ]; then 9 | file="$2" 10 | fi 11 | file="/backup/$file" 12 | 13 | if [ "$1" = "backup" ]; then 14 | # Skip the three host configuration entries always setup by Docker and 4th which is /backup provided by this image. 15 | volumes=$(cat /proc/mounts | \ 16 | grep -oP "/dev/[^ ]+ \K(/[^ ]+)" | \ 17 | grep -v "/backup" | \ 18 | grep -v "/etc/resolv.conf" | \ 19 | grep -v "/etc/hostname" | \ 20 | grep -v "/etc/hosts" | \ 21 | tr '\n' ' ') 22 | 23 | if [ -z "$volumes" ]; then 24 | echo "No volumes were detected." 25 | exit 1 26 | fi 27 | 28 | echo "Volumes detected: $volumes" 29 | echo "Creating archive..." 30 | 31 | tar --create --recursion --xz $TAR_OPTS \ 32 | --file "$file" \ 33 | --one-file-system \ 34 | $volumes 35 | 36 | echo "Written to $file" 37 | elif [ "$1" = "restore" ]; then 38 | echo "Restoring from $file" 39 | 40 | tar --extract --preserve-permissions $TAR_OPTS \ 41 | --file "$file" \ 42 | -C / 43 | fi 44 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | docker-backup 2 | ============= 3 | Simple utility for backing up a Docker data container (optionally to s3). 4 | 5 | other solutions 6 | --------------- 7 | There are a number of existing solutions available which typically operate in a 8 | similar fashion. 9 | 10 | - `docker inspect` (api call) to determine volumes provided by a container 11 | - access container volumes using `--volumes-from` or `/var/lib/docker/vfs/dir` 12 | - store container description (from inspect) and volumes 13 | - restore using container description to re-create data container before 14 | restoring files 15 | 16 | The above approach results in a fairly sizable tool mostly due to unuseful 17 | complexity which unfortunately also restricts flexibility. 18 | 19 | advantages 20 | ---------- 21 | Unlike other solutions this tool opperates entirely from within the container 22 | in which it resides. There is no communication with Docker API or storage of 23 | data container description. This results in a number of advantages and provides 24 | increased flexibility as described below. 25 | 26 | - does not break on Docker API change or container description format 27 | - restore into container using different image 28 | - merge backups into single data container 29 | - simplicity allows for easy customization and expansion 30 | - does not act like a daemon to allow scheduling via typical system tools 31 | - separates base backup from remote storage 32 | - does not require bind mounting the docker socket nor `/var/lib/docker/vfs/dir` 33 | 34 | assumptions 35 | ----------- 36 | This tool assumes that the data container it is to operate on exists. In the 37 | event of a catastrophic failure this means the data container must be 38 | initialized before this tool can restore the data into it. 39 | 40 | Typically that will look something like the following. 41 | ```sh 42 | $ docker run --name data-container -v /some/volume boombatower/opensuse /bin/true 43 | ``` 44 | 45 | usage 46 | ----- 47 | ``` 48 | backup.sh backup|restore [filename] 49 | - filename: backup.tar.xz 50 | Environment variables: 51 | - optional: TAR_OPTS 52 | ``` 53 | 54 | Backups are placed in the `/backup` directory which is exposed as a volume so 55 | that other containers may access the tarballs after they are created. The 56 | backup can either be transported directly from the container to remote storage 57 | or using Docker bind mount can be extracted onto the host. 58 | 59 | To dump backup archive from `data-container` into current directory: 60 | ```sh 61 | $ docker run --rm \ 62 | --volumes-from data-container \ 63 | -v $(pwd):/backup \ 64 | boombatower/docker-backup backup 65 | ``` 66 | 67 | To restore: 68 | ```sh 69 | $ docker run --rm \ 70 | --volumes-from data-container \ 71 | -v $(pwd):/backup \ 72 | boombatower/docker-backup restore 73 | ``` 74 | 75 | To use a date based file name and add `--verbose` flag to tar command: 76 | ```sh 77 | $ docker run --rm \ 78 | --volumes-from data-container \ 79 | -v $(pwd):/backup \ 80 | -e TAR_OPTS="--verbose" \ 81 | boombatower/docker-backup backup "$(date +%F_%R).tar.xz" 82 | ``` 83 | 84 | One interesting option would be to remove the `--rm` flag a simply let the 85 | backup containers persist as they will provide a backup until they are removed. 86 | Using other tools the containers could be perged at desired intervals. Since 87 | this image exposes `/backup` as a volume the backup container could be accessed 88 | via `--volumes-from` for the restore script. 89 | 90 | Any existing container or tools designed to work with a tarball can be compiled 91 | into a Docker container that builds on the basic tool as the s3 tool included 92 | in this repository. 93 | 94 | ``` 95 | s3.sh backup|restore [filename] 96 | - filename: backup.tar.xz 97 | Environment variables: 98 | - required: ACCESS_KEY, SECRET_KEY, and BUCKET 99 | - optional: S3CMD_OPTS 100 | ``` 101 | 102 | To upload backup directly to s3: 103 | ```sh 104 | $ docker run --rm \ 105 | --volumes-from data-container \ 106 | -e ACCESS_KEY="..." \ 107 | -e SECRET_KEY="..." \ 108 | -e BUCKET="s3://[BUCKET]/" \ 109 | boombatower/docker-backup-s3 backup data-container.tar.xz 110 | ``` 111 | 112 | Used in combination with a versioned s3 bucket and even glacier this static 113 | file name is still quite powerful. 114 | 115 | To restore backup directly from s3: 116 | ```sh 117 | $ docker run --rm \ 118 | --volumes-from data-container \ 119 | -e ACCESS_KEY="..." \ 120 | -e SECRET_KEY="..." \ 121 | -e BUCKET="s3://[BUCKET]/" \ 122 | boombatower/docker-backup-s3 restore data-container.tar.xz 123 | ``` 124 | 125 | systemd scheduling 126 | ------------------ 127 | If you are using CoreOS or similar it can be convenient to schedule the backups 128 | using systemd and include them in your cloud-config. An example timer and 129 | backup service are provided in [doc directory](doc). 130 | 131 | docker registry 132 | --------------- 133 | The Docker registry repositories can be found at: 134 | - https://registry.hub.docker.com/u/boombatower/docker-backup 135 | - https://registry.hub.docker.com/u/boombatower/docker-backup-s3 136 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {description} 294 | Copyright (C) {year} {fullname} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | 341 | --------------------------------------------------------------------------------