├── .gitignore ├── README.md ├── MavenCheatSheet.md ├── DockerCheatSheet.md └── LICENSE.txt /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Deutsche Cheat Sheets zu Maven und Docker 2 | 3 | 4 | Dieses Repository enthält Cheat Sheets (Kurzübersichten) zu Docker und 5 | Maven. 6 | 7 | * [Docker Cheat Sheet](DockerCheatSheet.md) 8 | * [Maven Cheat Sheet](MavenCheatSheet.md) 9 | 10 | Lizenz ist Creative Commons [CC 11 | BY-SA](https://creativecommons.org/licenses/by-sa/4.0/legalcode.de) 12 | (Namensnennung - Weitergabe unter gleichen Bedingungen). Ersteller im 13 | Sinne der Lizenz ist Eberhard Wolff. 14 | -------------------------------------------------------------------------------- /MavenCheatSheet.md: -------------------------------------------------------------------------------- 1 | # Maven Cheat Sheet 2 | 3 | Maven ist ein Build-Werkzeug. Die Konfiguration für ein Projekt ist in einer 4 | `pom.xml`-Datei abgelegt. 5 | 6 | Maven kann mehrere Projekte zu einem 7 | [Multi-Modul-Projekt](https://maven.apache.org/guides/mini/guide-multiple-modules.html) 8 | zusammenfassen. Dazu werden Unterhalb eines Projektes Sub-Module angelegt und in 9 | der `pom.xml` referenziert. Jedes Sub-Modul existiert in einem eigenen 10 | Unterverzeichnis und hat eine eigene `pom.xml` die nur für dieses Modul gilt. 11 | 12 | Entweder kann man Maven in dem Verzeichnis mit der `pom.xml` für das 13 | Gesamtprojekt starten. Dann baut Maven das gesamte Projekt mit allen Modulen. 14 | Startet man Maven im Verzeichnis eines spezifischen Moduls, dann beziehen sich 15 | die Maven-Kommandos nur auf dieses Modul. 16 | 17 | Sollen Maven Module Definitionen, wie z.B. die Java-Version, von anderen Modulen 18 | übernehmen wird Vererbung eingesetzt. Jede `pom.xml` kann dabei nur von genau 19 | einem anderen Modul erben. Bei einem Multi-Modul-Projekt erben häufig alle 20 | Sub-Module von der `pom.xml` welche die Sub-Module referenziert. 21 | 22 | #### Maven Wrapper 23 | 24 | Normalerweise muss man Maven auf jedem Entwicklungsrechner 25 | installieren. Der 26 | [Maven-Wrapper](https://github.com/takari/maven-wrapper) ermöglicht 27 | die Nutzung von Maven ohne Installation. Dazu wird in dem jeweiligen 28 | Projekt ein Skript namens `mvnw` (Linux, macOS) oder `mvnw.cmd` 29 | (Windows) bereit gestellt, dass Maven installiert und die Umgebung 30 | einrichtet. 31 | 32 | Der Maven-Wrapper ist einfacher zu nutzen und sollte daher einer 33 | lokalen Maven-Installation vorgezogen werden. 34 | 35 | #### Verzeichnisse 36 | 37 | Ein Maven-Modul hat eine feste Dateistruktur: 38 | 39 | * Im Verzeichnis `src/main` sind alle Dateien des Moduls enthalten. 40 | 41 | * Das Verzeichnis `src/test` enthält Dateien, die nur für Tests benötigt werden. 42 | 43 | Unterhalb dieser Verzeichnisse liegt ebenfalls eine standardisierte 44 | Verzeichnis-Struktur: 45 | 46 | * `java` enthält den Java-Code. 47 | 48 | * `resources` enthält Ressourcen, wie Property-, Bilder- oder HTML-Dateien. 49 | 50 | #### Kommandos 51 | 52 | Bei einer Maven-Installation auf dem lokalen Rechner wird das Kommando 53 | `mvn` genutzt. Ohne lokale Maven-Installation muss `./mvnw` (Linux, 54 | macOS) bzw. `mvnw.cmd` (Windows) genutzt werden. 55 | 56 | Die wichtigsten Kommandos für Maven sind: 57 | 58 | * `mvn package` (bzw. `./mvnw package` oder `mvnw.cmd package` bei 59 | Nutzung des Maven Wrappers) lädt alle Abhängigkeiten aus dem 60 | Internet herunter, kompiliert 61 | den Code, führt die Tests aus und verpackt den kompilierten Code 62 | eine JAR-Datei. Das Ergebnis steht 63 | im Unterverzeichnis `target` des jeweiligen Moduls bereit. `mvn package 64 | -DskipTests` führt die Tests nicht aus. `mvn package -DdownloadSources=true 65 | -DdownloadJavadocs=true` lädt den Source Code und das JavaDoc der abhängigen 66 | Bibliotheken aus dem Internet. Das JavaDoc enthält eine Beschreibung der API. 67 | Entwicklungsumgebungen können JavaDoc und Source Code der Bibliotheken dem 68 | Benutzer darstellen. 69 | 70 | * `mvn test` kompiliert und testet den Code, erstellt aber keine JAR-Datei. 71 | 72 | * `mvn install` fügt `mvn package` noch einen Schritt hinzu, indem es die 73 | JAR-Dateien in das lokale Repository (`.m2`-Verzeichnis im Heimatverzeichnis 74 | des Benutzers) kopiert. So können andere Projekte und Module das Modul als 75 | Abhängigkeit in der `pom.xml` deklarieren. 76 | 77 | * `mvn clean` löscht alle Ergebnisse der vorherigen Builds. 78 | 79 | * Maven-Kommandos können kombiniert werden. `mvn clean package` kompiliert also 80 | alles komplett neu, weil die Ergebnisse der alten Builds vor dem Build 81 | gelöscht werden. 82 | 83 | #### Troubleshooting 84 | 85 | Wenn `mvn package` nicht funktioniert: 86 | 87 | * `mvn clean package` ausprobieren, um alte Build-Ergebnisse vor dem Build zu 88 | löschen. 89 | 90 | * `mvn clean package -DskipTests` nutzen, um die Tests nicht auszuführen. 91 | 92 | * `mvn clean package -Dmaven.test.skip=true` führt die Tests nicht aus und 93 | kompiliert die Tests auch nicht. 94 | 95 | #### Spring Boot 96 | 97 | bietet eine einfache Möglichkeit, um neue 98 | Spring-Boot-Projekte mit passender `pom.xml`-Datei zu erzeugen. Dazu muss der 99 | Nutzer auf der Website nur einige Einstellungen übergeben. Die Website erstellt 100 | dann das passende Projekt mit einer `pom.xml`. 101 | 102 | Das Ergebnis des Maven-Builds bei einem Spring-Boot-Projekt ist ein JAR (Java 103 | Archive). In diesem sind alle Bestandteile der Anwendung einschließlich aller 104 | Bibliotheken enthalten. Java unterstützt dieses Dateiformat direkt. Also kann 105 | ein Microservice mit `java -jar target/microservice-order-0.0.1-SNAPSHOT.jar` 106 | gestartet werden. 107 | -------------------------------------------------------------------------------- /DockerCheatSheet.md: -------------------------------------------------------------------------------- 1 | # Docker und Docker Compose Cheat Sheet 2 | 3 | Docker Compose dient zur Koordination von mehreren Docker Containern. 4 | Microservice-Systeme bestehen meistens aus vielen Docker Containern. 5 | Daher ist es sinnvoll, die Container mit Docker Compose zu 6 | starten und zu stoppen. 7 | 8 | #### Docker Compose 9 | 10 | Docker Compose nutzt die Datei `docker-compose.yml`, um 11 | Informationen zu den Container auszulesen. Die 12 | [Docker Dokumentation](https://docs.docker.com/compose/compose-file/) 13 | erläutert den Aufbau dieser Datei. 14 | 15 | Beim Starten gibt `docker-compose` alle möglichen Kommandos aus. Die 16 | wichtigsten Kommandos für Docker Compose: 17 | 18 | * `docker-compose build` erstellt die Docker Images für die Container 19 | mithilfe der `Dockerfiles`. 20 | 21 | * `docker-compose pull` lädt die Docker Images vom Docker Hub 22 | herunter. 23 | 24 | * `docker-compose up -d` startet die Docker Container im Hintergrund. 25 | Ohne `-d` starten die Container im Vordergrund, sodass die Ausgabe aller Docker 26 | Container auf der Konsole ausgegeben werden. Dsa ist nicht besonders 27 | übersichtlich. Die Option `--scale` 28 | kann mehrere Instanzen eines Service starten z.B. 29 | `docker-compose up -d --scale order=2` startet zwei Instanzen des 30 | Order-Service. Vorgabewert ist eine Instanz. 31 | 32 | * `docker-compose down` stoppt die Container und löscht sie. Außerdem 33 | wird das Netzwerk gelöscht und die Docker-Dateisysteme gelöscht. 34 | 35 | * `docker-compose stop` stoppt die Container. Netzwerk, 36 | Dateisysteme und Container werden nicht gelöscht. 37 | 38 | #### Docker 39 | 40 | `docker` gibt beim Start ohne Parameter alle gültigen Kommandos aus. 41 | 42 | Tipp: Tab-Drücken vervollständig Namen und IDs von Containern und 43 | Images. 44 | 45 | Hier die wichtigsten Kommandos im Überblick. Als Beispiel dient 46 | der Container `ms_catalog_1`: 47 | 48 | #### Status eines Containers 49 | 50 | * `docker ps` zeigt alle laufenden Docker Container. `docker ps -a` 51 | zeigt auch die gestoppten Docker Container. Die Container haben wie 52 | die Images eine hexadezimale ID und einen Namen. 53 | `docker ps` gibt alle diese Informationen aus. 54 | Für andere Befehle 55 | können Container mit Name oder hexadezimaler ID identifiziert 56 | werden. Meistens 57 | haben die Container Namen wie `ms_catalog_1`. Dieser Name besteht aus 58 | einem Präfix `ms` für das Projekt, den Namen des Service `catalog` und 59 | der laufenden Nummer `1`. 60 | Oft wird der Name des 61 | Containers mit dem Namen des Images (z.B. `ms_catalog`) verwechselt. 62 | 63 | * `docker logs ms_catalog_1` zeigt die bisherigen Ausgaben des 64 | Containers `ms_catalog_1`. `docker logs -f ms_catalog_1` zeigt 65 | auch alle weiteren Ausgaben an, die der Container noch ausgibt. 66 | 67 | #### Lebenszyklus eines Containers 68 | 69 | * `docker run ms_catalog --name="container_name"` startet ein neuen 70 | Container mit dem Image `ms_catalog`, der den 71 | Namen `container_name` erhält. Der Parameter `--name` ist 72 | optional. Der Container 73 | führt dann das Kommando aus, dass im `CMD`-Eintrag des `Dockerfiles` 74 | hinterlegt ist. Man kann aber mit `docker run ` 75 | ein Kommando in einem Container ausführen lassen. `docker run 76 | ewolff/docker-java /bin/ls` führt das Kommando `ls` in einem Container 77 | mit dem Docker Image `ewolff/docker-java` aus. Also zeigt das Kommando 78 | die 79 | Dateien im Wurzelverzeichnis des Containers an. Falls das Image lokal 80 | noch nicht vorhanden ist, wird es automatisch vom Docker Hub im 81 | Internet heruntergeladen. Wenn das Kommando ausgeführt worden ist, 82 | beendet der Container sich. 83 | 84 | * `docker exec ms_catalog_1 /bin/ls` führt `/bin/ls` im laufenden Container 85 | `ms_catalog_1` aus. Mit diesen Befehlen kann man also in einem 86 | bereits laufenden Container 87 | Werkzeuge starten. `docker exec -it ms_catalog_1 /bin/sh` startet 88 | eine Shell und leitet Ein- und Ausgabe auf das aktuelle Terminal 89 | um. So hat man also eine Shell in dem Docker Container zur 90 | Verfügung und kann interaktiv mit dem Container arbeiten. 91 | 92 | * `docker stop ms_catalog_1` hält den Container an. Es 93 | schickt zuerst einen SIGTERM, damit der Container sauber 94 | herunterfahren kann, und dann einen SIGKILL. 95 | 96 | * `docker kill ms_catalog_1` beendet die Ausführung des 97 | Containers mit einem SIGKILL. Der Container ist aber immer noch vorhanden. 98 | 99 | * `docker rm ms_catalog_1` löscht den Container dauerhaft. 100 | 101 | * `docker start ms_catalog_1` startet den übergebenen Container wieder. 102 | 103 | * `docker restart ms_catalog_1` startet den übergebenen Container neu. 104 | 105 | #### Docker Images 106 | 107 | * `docker images` zeigt alle Docker Images an. Die Images haben eine 108 | hexadezimale ID und ein Namen. Für andere Befehle können Images mit 109 | beiden Mechanismen identifiziert werden. 110 | 111 | * `docker build –t= build ` erzeugt ein Image mit dem Namen 112 | `name`. Das `Dockerfile` muss im Verzeichnis `path` liegen. Wenn keine 113 | Version angegeben wird, bekommt das Image die Version `latest`. Als 114 | Alternative kann auch die Version im Format `-t=` 115 | angegeben werden. Abschnitt~\ref{section-docker-dockerfiles} 116 | beschreibt das Format der `Dockerfiles`. 117 | 118 | * `docker history ` zeigt die Schichten eines Images an. Für jede 119 | Schicht wird die ID, der ausgeführte Befehl und die Größe der Schicht 120 | ausgegeben. Das anzuzeigende Image kann mit dem Namen 121 | identifiziert werden, wenn es nur eine Version des Images mit diesem 122 | Namen gibt. Sonst kann Name und Version über `name:version` angegeben 123 | werden. Natürlich ist es auch möglich, die hexadezimale ID des Images 124 | anzugeben. 125 | 126 | * `docker rmi ` löscht ein Image. So lange noch 127 | ein Container das Image nutzt, kann es nicht gelöscht 128 | werden. 129 | 130 | * `docker push` und `docker pull` legen Docker Images in einer Registry 131 | ab oder laden sie aus einer Registry. Wenn keine andere Registry 132 | konfiguriert ist, wird der öffentliche Docker Hub genutzt. 133 | 134 | #### Aufräumen 135 | 136 | Um die Docker-Umgebung aufzuräumen, gibt es mehrere Kommandos: 137 | 138 | * `docker container prune` löscht alle gestoppten Container. 139 | 140 | * `docker image prune` löscht alle Images, die keinen Namen haben. 141 | 142 | * `docker network prune` löscht alle unbenutzten Docker-Netzwerke. 143 | 144 | * `docker volume prune` löscht alle Docker Volumes, die von keinem 145 | Docker Container genutzt werden. 146 | 147 | * `docker system prune -a` löscht alle gestoppten Container, alle 148 | unbenutzten Netzwerke und alle Images, die nicht von mindestens 149 | einem Container genutzt werden. Es bleibt also nur übrig, was die 150 | aktuell laufenden Container benötigen. 151 | 152 | #### Troubleshooting 153 | 154 | Wenn ein Beispiel nicht funktioniert: 155 | 156 | * Laufen alle Container? `docker ps` zeigt die laufenden Container 157 | an. `docker ps -a` auch die terminierten. 158 | 159 | * Logs mit `docker logs` anschauen. Das funktioniert auch für beendete 160 | Conainer. `Killed` in den Logs bedeutet, dass zu wenig Speicher zur 161 | Verfügung steht. Unter Windows und macOS findet sich die Einstellung 162 | dafür in der Docker-Anwendung unter Preferences/ Advanced. Docker 163 | sollten ca. 4 GB zugewiesen sein. 164 | 165 | * Bei komplexeren Problemen mit `docker exec -it ms_catalog_1 /bin/sh` 166 | einem Shell im Container verbinden. 167 | 168 | 169 | 170 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | Attribution-ShareAlike 4.0 International 2 | 3 | ======================================================================= 4 | 5 | Creative Commons Corporation ("Creative Commons") is not a law firm and 6 | does not provide legal services or legal advice. Distribution of 7 | Creative Commons public licenses does not create a lawyer-client or 8 | other relationship. Creative Commons makes its licenses and related 9 | information available on an "as-is" basis. Creative Commons gives no 10 | warranties regarding its licenses, any material licensed under their 11 | terms and conditions, or any related information. Creative Commons 12 | disclaims all liability for damages resulting from their use to the 13 | fullest extent possible. 14 | 15 | Using Creative Commons Public Licenses 16 | 17 | Creative Commons public licenses provide a standard set of terms and 18 | conditions that creators and other rights holders may use to share 19 | original works of authorship and other material subject to copyright 20 | and certain other rights specified in the public license below. The 21 | following considerations are for informational purposes only, are not 22 | exhaustive, and do not form part of our licenses. 23 | 24 | Considerations for licensors: Our public licenses are 25 | intended for use by those authorized to give the public 26 | permission to use material in ways otherwise restricted by 27 | copyright and certain other rights. Our licenses are 28 | irrevocable. Licensors should read and understand the terms 29 | and conditions of the license they choose before applying it. 30 | Licensors should also secure all rights necessary before 31 | applying our licenses so that the public can reuse the 32 | material as expected. Licensors should clearly mark any 33 | material not subject to the license. This includes other CC- 34 | licensed material, or material used under an exception or 35 | limitation to copyright. More considerations for licensors: 36 | wiki.creativecommons.org/Considerations_for_licensors 37 | 38 | Considerations for the public: By using one of our public 39 | licenses, a licensor grants the public permission to use the 40 | licensed material under specified terms and conditions. If 41 | the licensor's permission is not necessary for any reason--for 42 | example, because of any applicable exception or limitation to 43 | copyright--then that use is not regulated by the license. Our 44 | licenses grant only permissions under copyright and certain 45 | other rights that a licensor has authority to grant. Use of 46 | the licensed material may still be restricted for other 47 | reasons, including because others have copyright or other 48 | rights in the material. A licensor may make special requests, 49 | such as asking that all changes be marked or described. 50 | Although not required by our licenses, you are encouraged to 51 | respect those requests where reasonable. More_considerations 52 | for the public: 53 | wiki.creativecommons.org/Considerations_for_licensees 54 | 55 | ======================================================================= 56 | 57 | Creative Commons Attribution-ShareAlike 4.0 International Public 58 | License 59 | 60 | By exercising the Licensed Rights (defined below), You accept and agree 61 | to be bound by the terms and conditions of this Creative Commons 62 | Attribution-ShareAlike 4.0 International Public License ("Public 63 | License"). To the extent this Public License may be interpreted as a 64 | contract, You are granted the Licensed Rights in consideration of Your 65 | acceptance of these terms and conditions, and the Licensor grants You 66 | such rights in consideration of benefits the Licensor receives from 67 | making the Licensed Material available under these terms and 68 | conditions. 69 | 70 | 71 | Section 1 -- Definitions. 72 | 73 | a. Adapted Material means material subject to Copyright and Similar 74 | Rights that is derived from or based upon the Licensed Material 75 | and in which the Licensed Material is translated, altered, 76 | arranged, transformed, or otherwise modified in a manner requiring 77 | permission under the Copyright and Similar Rights held by the 78 | Licensor. For purposes of this Public License, where the Licensed 79 | Material is a musical work, performance, or sound recording, 80 | Adapted Material is always produced where the Licensed Material is 81 | synched in timed relation with a moving image. 82 | 83 | b. Adapter's License means the license You apply to Your Copyright 84 | and Similar Rights in Your contributions to Adapted Material in 85 | accordance with the terms and conditions of this Public License. 86 | 87 | c. BY-SA Compatible License means a license listed at 88 | creativecommons.org/compatiblelicenses, approved by Creative 89 | Commons as essentially the equivalent of this Public License. 90 | 91 | d. Copyright and Similar Rights means copyright and/or similar rights 92 | closely related to copyright including, without limitation, 93 | performance, broadcast, sound recording, and Sui Generis Database 94 | Rights, without regard to how the rights are labeled or 95 | categorized. For purposes of this Public License, the rights 96 | specified in Section 2(b)(1)-(2) are not Copyright and Similar 97 | Rights. 98 | 99 | e. Effective Technological Measures means those measures that, in the 100 | absence of proper authority, may not be circumvented under laws 101 | fulfilling obligations under Article 11 of the WIPO Copyright 102 | Treaty adopted on December 20, 1996, and/or similar international 103 | agreements. 104 | 105 | f. Exceptions and Limitations means fair use, fair dealing, and/or 106 | any other exception or limitation to Copyright and Similar Rights 107 | that applies to Your use of the Licensed Material. 108 | 109 | g. License Elements means the license attributes listed in the name 110 | of a Creative Commons Public License. The License Elements of this 111 | Public License are Attribution and ShareAlike. 112 | 113 | h. Licensed Material means the artistic or literary work, database, 114 | or other material to which the Licensor applied this Public 115 | License. 116 | 117 | i. Licensed Rights means the rights granted to You subject to the 118 | terms and conditions of this Public License, which are limited to 119 | all Copyright and Similar Rights that apply to Your use of the 120 | Licensed Material and that the Licensor has authority to license. 121 | 122 | j. Licensor means the individual(s) or entity(ies) granting rights 123 | under this Public License. 124 | 125 | k. Share means to provide material to the public by any means or 126 | process that requires permission under the Licensed Rights, such 127 | as reproduction, public display, public performance, distribution, 128 | dissemination, communication, or importation, and to make material 129 | available to the public including in ways that members of the 130 | public may access the material from a place and at a time 131 | individually chosen by them. 132 | 133 | l. Sui Generis Database Rights means rights other than copyright 134 | resulting from Directive 96/9/EC of the European Parliament and of 135 | the Council of 11 March 1996 on the legal protection of databases, 136 | as amended and/or succeeded, as well as other essentially 137 | equivalent rights anywhere in the world. 138 | 139 | m. You means the individual or entity exercising the Licensed Rights 140 | under this Public License. Your has a corresponding meaning. 141 | 142 | 143 | Section 2 -- Scope. 144 | 145 | a. License grant. 146 | 147 | 1. Subject to the terms and conditions of this Public License, 148 | the Licensor hereby grants You a worldwide, royalty-free, 149 | non-sublicensable, non-exclusive, irrevocable license to 150 | exercise the Licensed Rights in the Licensed Material to: 151 | 152 | a. reproduce and Share the Licensed Material, in whole or 153 | in part; and 154 | 155 | b. produce, reproduce, and Share Adapted Material. 156 | 157 | 2. Exceptions and Limitations. For the avoidance of doubt, where 158 | Exceptions and Limitations apply to Your use, this Public 159 | License does not apply, and You do not need to comply with 160 | its terms and conditions. 161 | 162 | 3. Term. The term of this Public License is specified in Section 163 | 6(a). 164 | 165 | 4. Media and formats; technical modifications allowed. The 166 | Licensor authorizes You to exercise the Licensed Rights in 167 | all media and formats whether now known or hereafter created, 168 | and to make technical modifications necessary to do so. The 169 | Licensor waives and/or agrees not to assert any right or 170 | authority to forbid You from making technical modifications 171 | necessary to exercise the Licensed Rights, including 172 | technical modifications necessary to circumvent Effective 173 | Technological Measures. For purposes of this Public License, 174 | simply making modifications authorized by this Section 2(a) 175 | (4) never produces Adapted Material. 176 | 177 | 5. Downstream recipients. 178 | 179 | a. Offer from the Licensor -- Licensed Material. Every 180 | recipient of the Licensed Material automatically 181 | receives an offer from the Licensor to exercise the 182 | Licensed Rights under the terms and conditions of this 183 | Public License. 184 | 185 | b. Additional offer from the Licensor -- Adapted Material. 186 | Every recipient of Adapted Material from You 187 | automatically receives an offer from the Licensor to 188 | exercise the Licensed Rights in the Adapted Material 189 | under the conditions of the Adapter's License You apply. 190 | 191 | c. No downstream restrictions. You may not offer or impose 192 | any additional or different terms or conditions on, or 193 | apply any Effective Technological Measures to, the 194 | Licensed Material if doing so restricts exercise of the 195 | Licensed Rights by any recipient of the Licensed 196 | Material. 197 | 198 | 6. No endorsement. Nothing in this Public License constitutes or 199 | may be construed as permission to assert or imply that You 200 | are, or that Your use of the Licensed Material is, connected 201 | with, or sponsored, endorsed, or granted official status by, 202 | the Licensor or others designated to receive attribution as 203 | provided in Section 3(a)(1)(A)(i). 204 | 205 | b. Other rights. 206 | 207 | 1. Moral rights, such as the right of integrity, are not 208 | licensed under this Public License, nor are publicity, 209 | privacy, and/or other similar personality rights; however, to 210 | the extent possible, the Licensor waives and/or agrees not to 211 | assert any such rights held by the Licensor to the limited 212 | extent necessary to allow You to exercise the Licensed 213 | Rights, but not otherwise. 214 | 215 | 2. Patent and trademark rights are not licensed under this 216 | Public License. 217 | 218 | 3. To the extent possible, the Licensor waives any right to 219 | collect royalties from You for the exercise of the Licensed 220 | Rights, whether directly or through a collecting society 221 | under any voluntary or waivable statutory or compulsory 222 | licensing scheme. In all other cases the Licensor expressly 223 | reserves any right to collect such royalties. 224 | 225 | 226 | Section 3 -- License Conditions. 227 | 228 | Your exercise of the Licensed Rights is expressly made subject to the 229 | following conditions. 230 | 231 | a. Attribution. 232 | 233 | 1. If You Share the Licensed Material (including in modified 234 | form), You must: 235 | 236 | a. retain the following if it is supplied by the Licensor 237 | with the Licensed Material: 238 | 239 | i. identification of the creator(s) of the Licensed 240 | Material and any others designated to receive 241 | attribution, in any reasonable manner requested by 242 | the Licensor (including by pseudonym if 243 | designated); 244 | 245 | ii. a copyright notice; 246 | 247 | iii. a notice that refers to this Public License; 248 | 249 | iv. a notice that refers to the disclaimer of 250 | warranties; 251 | 252 | v. a URI or hyperlink to the Licensed Material to the 253 | extent reasonably practicable; 254 | 255 | b. indicate if You modified the Licensed Material and 256 | retain an indication of any previous modifications; and 257 | 258 | c. indicate the Licensed Material is licensed under this 259 | Public License, and include the text of, or the URI or 260 | hyperlink to, this Public License. 261 | 262 | 2. You may satisfy the conditions in Section 3(a)(1) in any 263 | reasonable manner based on the medium, means, and context in 264 | which You Share the Licensed Material. For example, it may be 265 | reasonable to satisfy the conditions by providing a URI or 266 | hyperlink to a resource that includes the required 267 | information. 268 | 269 | 3. If requested by the Licensor, You must remove any of the 270 | information required by Section 3(a)(1)(A) to the extent 271 | reasonably practicable. 272 | 273 | b. ShareAlike. 274 | 275 | In addition to the conditions in Section 3(a), if You Share 276 | Adapted Material You produce, the following conditions also apply. 277 | 278 | 1. The Adapter's License You apply must be a Creative Commons 279 | license with the same License Elements, this version or 280 | later, or a BY-SA Compatible License. 281 | 282 | 2. You must include the text of, or the URI or hyperlink to, the 283 | Adapter's License You apply. You may satisfy this condition 284 | in any reasonable manner based on the medium, means, and 285 | context in which You Share Adapted Material. 286 | 287 | 3. You may not offer or impose any additional or different terms 288 | or conditions on, or apply any Effective Technological 289 | Measures to, Adapted Material that restrict exercise of the 290 | rights granted under the Adapter's License You apply. 291 | 292 | 293 | Section 4 -- Sui Generis Database Rights. 294 | 295 | Where the Licensed Rights include Sui Generis Database Rights that 296 | apply to Your use of the Licensed Material: 297 | 298 | a. for the avoidance of doubt, Section 2(a)(1) grants You the right 299 | to extract, reuse, reproduce, and Share all or a substantial 300 | portion of the contents of the database; 301 | 302 | b. if You include all or a substantial portion of the database 303 | contents in a database in which You have Sui Generis Database 304 | Rights, then the database in which You have Sui Generis Database 305 | Rights (but not its individual contents) is Adapted Material, 306 | 307 | including for purposes of Section 3(b); and 308 | c. You must comply with the conditions in Section 3(a) if You Share 309 | all or a substantial portion of the contents of the database. 310 | 311 | For the avoidance of doubt, this Section 4 supplements and does not 312 | replace Your obligations under this Public License where the Licensed 313 | Rights include other Copyright and Similar Rights. 314 | 315 | 316 | Section 5 -- Disclaimer of Warranties and Limitation of Liability. 317 | 318 | a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE 319 | EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS 320 | AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF 321 | ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, 322 | IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, 323 | WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR 324 | PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, 325 | ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT 326 | KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT 327 | ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. 328 | 329 | b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE 330 | TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, 331 | NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, 332 | INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, 333 | COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR 334 | USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN 335 | ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR 336 | DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR 337 | IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. 338 | 339 | c. The disclaimer of warranties and limitation of liability provided 340 | above shall be interpreted in a manner that, to the extent 341 | possible, most closely approximates an absolute disclaimer and 342 | waiver of all liability. 343 | 344 | 345 | Section 6 -- Term and Termination. 346 | 347 | a. This Public License applies for the term of the Copyright and 348 | Similar Rights licensed here. However, if You fail to comply with 349 | this Public License, then Your rights under this Public License 350 | terminate automatically. 351 | 352 | b. Where Your right to use the Licensed Material has terminated under 353 | Section 6(a), it reinstates: 354 | 355 | 1. automatically as of the date the violation is cured, provided 356 | it is cured within 30 days of Your discovery of the 357 | violation; or 358 | 359 | 2. upon express reinstatement by the Licensor. 360 | 361 | For the avoidance of doubt, this Section 6(b) does not affect any 362 | right the Licensor may have to seek remedies for Your violations 363 | of this Public License. 364 | 365 | c. For the avoidance of doubt, the Licensor may also offer the 366 | Licensed Material under separate terms or conditions or stop 367 | distributing the Licensed Material at any time; however, doing so 368 | will not terminate this Public License. 369 | 370 | d. Sections 1, 5, 6, 7, and 8 survive termination of this Public 371 | License. 372 | 373 | 374 | Section 7 -- Other Terms and Conditions. 375 | 376 | a. The Licensor shall not be bound by any additional or different 377 | terms or conditions communicated by You unless expressly agreed. 378 | 379 | b. Any arrangements, understandings, or agreements regarding the 380 | Licensed Material not stated herein are separate from and 381 | independent of the terms and conditions of this Public License. 382 | 383 | 384 | Section 8 -- Interpretation. 385 | 386 | a. For the avoidance of doubt, this Public License does not, and 387 | shall not be interpreted to, reduce, limit, restrict, or impose 388 | conditions on any use of the Licensed Material that could lawfully 389 | be made without permission under this Public License. 390 | 391 | b. To the extent possible, if any provision of this Public License is 392 | deemed unenforceable, it shall be automatically reformed to the 393 | minimum extent necessary to make it enforceable. If the provision 394 | cannot be reformed, it shall be severed from this Public License 395 | without affecting the enforceability of the remaining terms and 396 | conditions. 397 | 398 | c. No term or condition of this Public License will be waived and no 399 | failure to comply consented to unless expressly agreed to by the 400 | Licensor. 401 | 402 | d. Nothing in this Public License constitutes or may be interpreted 403 | as a limitation upon, or waiver of, any privileges and immunities 404 | that apply to the Licensor or You, including from the legal 405 | processes of any jurisdiction or authority. 406 | 407 | 408 | ======================================================================= 409 | 410 | Creative Commons is not a party to its public 411 | licenses. Notwithstanding, Creative Commons may elect to apply one of 412 | its public licenses to material it publishes and in those instances 413 | will be considered the “Licensor.” The text of the Creative Commons 414 | public licenses is dedicated to the public domain under the CC0 Public 415 | Domain Dedication. Except for the limited purpose of indicating that 416 | material is shared under a Creative Commons public license or as 417 | otherwise permitted by the Creative Commons policies published at 418 | creativecommons.org/policies, Creative Commons does not authorize the 419 | use of the trademark "Creative Commons" or any other trademark or logo 420 | of Creative Commons without its prior written consent including, 421 | without limitation, in connection with any unauthorized modifications 422 | to any of its public licenses or any other arrangements, 423 | understandings, or agreements concerning use of licensed material. For 424 | the avoidance of doubt, this paragraph does not form part of the 425 | public licenses. 426 | 427 | Creative Commons may be contacted at creativecommons.org. 428 | --------------------------------------------------------------------------------