├── Dockerfile
├── Contribute.md
├── learn.md
├── .github
└── workflows
│ └── docker-ci-cd.yml
├── src
└── index.html
├── README.md
└── LICENSE
/Dockerfile:
--------------------------------------------------------------------------------
1 | FROM nginx
2 | ADD src/* /usr/share/nginx/html/
3 | EXPOSE 80
4 | CMD ["nginx","-g","daemon off;"]
5 |
--------------------------------------------------------------------------------
/Contribute.md:
--------------------------------------------------------------------------------
1 | ## Contribution guide
2 | - Contribution to guide is fully welcome
3 | - Any type of contribution will be appreciated
4 | - Open an issue if needed
5 |
--------------------------------------------------------------------------------
/learn.md:
--------------------------------------------------------------------------------
1 | ## Build CI-CD for docker Image
2 | Learn how to build ⚙ a CI-CD pipeline for docker 🐳 images with github Actions. If you found this repo useful please star ⭐ it. [Learn](./README.md)
3 |
--------------------------------------------------------------------------------
/.github/workflows/docker-ci-cd.yml:
--------------------------------------------------------------------------------
1 | name: Docker image CI
2 | on:
3 | push:
4 | branches: [ "main" ]
5 | jobs:
6 | docker-build:
7 | runs-on: ubuntu-latest
8 | steps:
9 | - uses: actions/checkout@v3
10 | - name: Build the Docker image
11 | run: |
12 | docker build . --file Dockerfile --tag hackthenumber
13 | docker login -u ${{secrets.USERNAME}} -p ${{secrets.TOKEN}}
14 | docker tag hackthenumber ${{secrets.USERNAME}}/hackthenumber
15 | docker push ${{secrets.USERNAME}}/hackthenumber && echo "✅ Deployed to Docker Hub" || ( echo "❌ Deployment to Docker Hub failed" && exit 1 )
16 |
17 |
18 | docker-test:
19 | runs-on: ubuntu-latest
20 | needs: docker-build
21 | steps:
22 | - uses: actions/checkout@v3
23 | - name: Test image presence
24 | run: |
25 | docker pull ${{secrets.USERNAME}}/hackthenumber
26 | docker image inspect ${{secrets.USERNAME}}/hackthenumber
27 | if [[ $? -eq 1 ]]; then
28 | echo "❌ Image not found!"
29 | exit 1 # This will cause the job to fail
30 | else
31 | echo "✅ Image Build Successfully!"
32 | fi
33 | - name: Test image response
34 | run: |
35 | docker run --rm --name test -d ${{secrets.USERNAME}}/hackthenumber
36 | response=$(docker exec test curl -s -o /dev/null -w "%{http_code}" http://localhost )
37 | if [[ $response -ne 200 ]]; then
38 | echo "❌ Image response is not 200!"
39 | exit 1
40 | else
41 | echo "✅ Image response is 200!"
42 | fi
43 |
44 |
--------------------------------------------------------------------------------
/src/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 | Demo Site : Hack The number
8 |
69 |
87 |
88 |
89 |
90 |
91 |
92 | Hack The Number
93 |
94 |
95 |
96 |
97 |
98 |
99 |
100 |
101 |
102 |
103 |
104 |
105 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Docker-Image-with-GitHub-Actions
2 | This repo provides a guide 📗 to creating a simple pipeline to build ⚙ and upload docker 🐳 image artifacts to the docker hub 🐳 repo with the help of GitHub actions
3 | as changes take place in GitHub main branch.
4 |
5 | ## Prerequisites
6 | 1. Docker 🐳 basics.
7 | - [introduction to docker 🐳](https://youtu.be/17Bl31rlnRM)
8 | - [Docker 🐳 complete course](https://youtu.be/3c-iBn73dDE)
9 |
10 | 1. Yaml 📄 basics
11 | - [Yaml 📄 tutorial](https://youtu.be/1uFVr15xDGg)
12 | - [Yaml 📄 Complete course](https://youtu.be/IA90BTozdow)
13 |
14 | ## Note
15 | If you are viewing this page from GitHub pages then some code for GitHub secrets will not be shown, you will only
16 | see a $ sign. Check out GitHub repo from 👉[Here](https://github.com/Sandeep-source/Docker-Image-with-GitHub-Actions)
17 | for the correct code.
18 |
19 | ## Scanario
20 |
21 | For this demo, the application is to be dockerized 🐳 in a static site. It is a simple game of guessing 🤔 numbers between 0 0️⃣ to 9 9️⃣. You access this page
22 | [Here](https://sandeep-source.github.io/Docker-Image-with-GitHub-Actions/src/)
23 |
24 | 
25 |
26 | ## Repository structure
27 |
28 | ```
29 | /src
30 | index.html
31 | index.css
32 | /Dockerfile
33 | /README.md
34 | ```
35 | Let's take a look 👀 at source files 🗃
36 |
37 | 1. `/src` - This folder contains source files 📁 for our static site.
38 | 1. `Dockerfile` - This is a basic Dockerfile 🐳 which specifies how the image should be built from the source. We will take a look 👀 at this in a moment.
39 | 3. `README.md` - This is the file 📄 you currently reading.
40 |
41 | ## Dockerfile
42 |
43 | Dockerfile 🐳 provides a set of instuctions to build ⚙ the image. For this repo it looks 👀 like the following.
44 |
45 | ```Dockerfile
46 | FROM nginx
47 | ADD src/* /usr/share/nginx/html/
48 | EXPOSE 80
49 | CMD ["nginx","-g","daemon off;"]
50 | ```
51 |
52 | Let's take a look 👀 at each instruction to understand what these instructions mean
53 |
54 | 1. `FROM nginx` - This line tells docker 🐳 to use Nginx 🆖 as the official image as a base image for our new image.
55 | 2. `ADD src/* /usr/share/nginx/html/` - This line copies files 🗃 of `src` folder inside the `/usr/share/nginx/html/` folder of image. `/usr/share/nginx/html/` folder is used by the nginx 🆖 server as entry point of website.
56 | 3. ```EXPOSE 80``` - This line tells docker 🐳 to open port 80 inside the docker 🐳 container so that we can communicate with the nginx 🆖 server inside.
57 | 4. ```CMD ["nginx","-g","daemon off;"]``` - This last cline starts Nginx 🆖 server and runs ▶ every time the docker 🐳 container start.
58 |
59 | It's all about what we need to get started. Let's take a look 👀 how to setup GitHub actions to create a pipeline.
60 |
61 | ## Steps to create 🛠 a pipeline
62 | ### Create github workflow
63 |
64 | 1. Open github repo and click on actions option.
65 | 2. Search 🔍 for Simple workflow and select the most suitable from the option that appeared.
66 | 3. Rename the file 📄 with the name you want for your workflow.
67 |
68 | ### Writing Code 👨💻 for workflow
69 |
70 | 1. Replace 🔁 the code 👩💻 of workflow with the following.
71 |
72 | ```yaml
73 | name:
74 | on:
75 | jobs:
76 |
77 | ```
78 | Let's understand 🤔 what this code 👩💻 means
79 |
80 | - The lines starting with # represents comments in YAML.
81 | - ```name:``` - Defines the name for your workflow.
82 | - ```on:``` - When we create a GitHub action, we want the action to run ▶ on certain events i.e push to a branch. This `on` parameter describes the events in which the action is going to run ▶.
83 | - ```jobs:``` - jobs work section is the place where we define what going to happen when events specified in the `on:` section occurs.
84 |
85 | 2. Give a name to your workflow
86 |
87 | ```yaml
88 | name: Docker image CI
89 | ```
90 |
91 | 3. Specify the event of our interest in this case push event
92 |
93 | - Add event
94 |
95 | ```yaml
96 | name: Docker image CI
97 | on:
98 | push:
99 | ```
100 |
101 | - Add branches for which we going to perform some action
102 |
103 | ```yaml
104 | name: Docker image CI
105 | on:
106 | push:
107 | branches: [ "main" ]
108 | ```
109 |
110 | 4. Now the remaining part of the workflow is jobs section. Jobs define the set of actions (Tasks) to be performed. These action can run ▶ sequentially or in parallel.
111 | for this demo we are just going to create one job named docker-build.
112 |
113 | ```yaml
114 | name: Docker image CI
115 | on:
116 | push:
117 | branches: [ "main" ]
118 | jobs:
119 | docker-build:
120 | ```
121 |
122 | 5. Each job section has following things
123 |
124 | - `runs-on:` - Tells 📢 the platform on which this job(Task) is going to run ▶ on. For this demo, we are taking 'ubuntu-latest'.
125 | - `steps:` - This defines a set of steps to be performed to get the job done.
126 | - Now our code 👩💻 will look 👀 like this.
127 |
128 | ```yaml
129 | name: Docker image CI
130 | on:
131 | push:
132 | branches: [ "main" ]
133 | jobs:
134 | docker-build:
135 | runs-on: ubuntu-latest
136 | steps:
137 | ```
138 |
139 | Each step in steps walk section has the following parts
140 |
141 | - `name:` - name of the step
142 | - `run:` - set of command 💻 to run ▶
143 | - `uses:` - rerefence of any other action which is used by the current steps. The referenced action will run ▶ first.`optional`
144 | - Apart from these, there are many other optional parts.
145 |
146 | 5. Add the following code 👨💻 in the steps section
147 |
148 | ```yaml
149 | - uses: actions/checkout@v3
150 | - name: Build the Docker image
151 | run: |
152 | ```
153 |
154 | - notice `|` after `run:` this allows us to write multiple commands 💻.
155 |
156 | 6. To build ⚙ image add the following command 💻 to the `Build the Docker image` step and replace `` With the name of your choice.
157 |
158 | ```yaml
159 | docker build . --file Dockerfile --tag
160 | ```
161 |
162 | - Now our file 📄 look 👀 something like this
163 |
164 | ```yaml
165 | name: Docker image CI
166 | on:
167 | push:
168 | branches: [ "main" ]
169 | jobs:
170 | docker-build:
171 | runs-on: ubuntu-latest
172 | steps:
173 | - uses: actions/checkout@v3
174 | - name: Build the Docker image
175 | run: |
176 | docker build . --file Dockerfile --tag hackthenumber
177 | ```
178 |
179 | - Notice 📝 the uses part specifies `actions/checkout@v3`. This action checks if our repository is present and if we have access to it.
180 | - Command 💻 `docker build . --file Dockerfile --tag hackthenumber` builds ⚙ an image named hackthenumber it is currently stored at the local system at which the job is running.
181 |
182 | 7. Login 🔐 to dockerhub 🐳
183 |
184 | To make push the image to the docker hub 🐳 we need to login to the docker hub 🐳. Docker recommends creating access tokens for logins 🔐 instead of using password 🔑.
185 | - Creating dockerhub 🐳 Access token 🗝
186 |
187 | - To create an access token login 🔐 to docker hub 🐳. Goto access `Account Setting > Security > New Access token`.
188 |
189 | 
190 |
191 | 
192 |
193 |
194 |
195 | - Enter description for the token and click generate ⚙.
196 | - Select `Copy and Close`.
197 |
198 | - Adding passwords 🔑 directly to workflow files 📄 can be a potential threat. To make this secure GitHub provides secrets to store passwords 🔑 etc. To add the secrets to GitHub repo do the following.
199 |
200 | - Goto your repo.
201 | - Open Settings 🔧.
202 | - Select `Secret > Actions > New Repository Secret`
203 | - Add DOCKERHUB as name and your docker hub username as secret.
204 | - Add another secret for TOKEN as the name and paste the access token you generated ⚙ in the previous step.
205 |
206 | - Login 🔐 to Dockerhub 🐳
207 |
208 | - Add the following lines to run part to login 🔐
209 |
210 | ```yaml
211 | docker login -u ${{secrets.USERNAME}} -p ${{secrets.TOKEN}}
212 | ```
213 |
214 | 8. Tag image to refer to Dockerhub 🐳 repo
215 |
216 | - To tag image add the following command 💻 by replacing `` with the image name you have choosen for your image
217 |
218 | ```yaml
219 | docker tag ${{secrets.USERNAME}}/
220 | ```
221 |
222 | - With our choosen name it will look 👀 like something this
223 |
224 | ```yaml
225 | docker tag hackthenumber ${{secrets.USERNAME}}/hackthenumber
226 | ```
227 |
228 | 9. Add the following line to push image to dockerhub 🐳
229 |
230 | ```yaml
231 | docker push ${{secrets.USERNAME}}/hackthenumber
232 | ```
233 |
234 | Now our file 📄 will look 👀 like something this
235 |
236 | ```yaml
237 | name: Docker image CI
238 | on:
239 | push:
240 | branches: [ "main" ]
241 | jobs:
242 | docker-build:
243 | runs-on: ubuntu-latest
244 | steps:
245 | - uses: actions/checkout@v3
246 | - name: Build the Docker image
247 | run: |
248 | docker build . --file Dockerfile --tag hackthenumber
249 | docker login -u ${{secrets.USERNAME}} -p ${{secrets.TOKEN}}
250 | docker tag hackthenumber ${{secrets.USERNAME}}/hackthenumber
251 | docker push ${{secrets.USERNAME}}/hackthenumber
252 | ```
253 |
254 | Similarly, you can add code to test if everything is working fine in the same script. After adding the testing code, our final code will look like this.
255 | ```yaml
256 | name: Docker image CI
257 | on:
258 | push:
259 | branches: [ "main" ]
260 | jobs:
261 | docker-build:
262 | runs-on: ubuntu-latest
263 | steps:
264 | - uses: actions/checkout@v3
265 | - name: Build the Docker image
266 | run: |
267 | docker build . --file Dockerfile --tag hackthenumber
268 | docker login -u ${{secrets.USERNAME}} -p ${{secrets.TOKEN}}
269 | docker tag hackthenumber ${{secrets.USERNAME}}/hackthenumber
270 |
271 | docker-test:
272 | runs-on: ubuntu-latest
273 | needs: docker-build
274 | steps:
275 | - uses: actions/checkout@v3
276 | - name: Test image presence
277 | run: |
278 | docker image inspect ${{secrets.USERNAME}}/hackthenumber
279 | if [[ $? -eq 1 ]]; then
280 | echo "❌ Image not found!"
281 | exit 1 # This will cause the job to fail
282 | else
283 | echo "✅ Image Build Successfully!"
284 | fi
285 | - name: Test image response
286 | run: |
287 | docker run -itdp 8000:80 --rm ${{secrets.USERNAME}}/hackthenumber
288 | response=$(curl -s -o /dev/null -w "%{http_code}" http://localhost:8000)
289 | if [[ $response -ne 200 ]]; then
290 | echo "❌ Image response is not 200!"
291 | exit 1
292 | else
293 | echo "✅ Image response is 200!"
294 | fi
295 | docker-deploy:
296 | runs-on: ubuntu-latest
297 | needs: docker-test
298 | steps:
299 | - uses: actions/checkout@v3
300 | - name: Deploy to docker hub
301 | run: |
302 | docker push ${{secrets.USERNAME}}/hackthenumber && echo "✅ Deployed to Docker Hub" || echo "❌ Deployment to Docker Hub failed"
303 | ```
304 |
305 | ## Quick Test deployed image
306 |
307 | - Go to https://labs.play-with-docker.com and login 🔐 with dockerhub 🐳 credentials.
308 | - Click start and then Add New Instance.
309 |
310 | 
311 |
312 | 
313 |
314 | - Run ⚙ the command 💻 `docker run -dp 8080:80 /` by replacing `` with the dockerhub username and `` with the image name used in the GitHub action. For example
315 |
316 | ```bash
317 | docker run -dp 8080:80 sandeepsource/hackthenumber
318 | ```
319 |
320 | - Click the port number `8080` on the right side of the open port button. If the button for port `8080` not appeared then click the `open port` button and enter 8080 and click ok.
321 |
322 | 
323 |
324 |
325 | - Now if everything is gone well 🙌 you will able to see following output.
326 |
327 | 
328 |
329 |
330 |
331 |
332 |
333 |
334 |
335 |
336 |
337 |
338 |
339 |
340 |
341 |
342 |
343 |
344 |
345 |
346 |
--------------------------------------------------------------------------------
/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 |
635 | Copyright (C)
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 | Copyright (C)
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 |
--------------------------------------------------------------------------------