Initial LICENSE and README
Overall project description and instructions
on how to use Gerrit on Docker.
Change-Id: Ic8e68feb7433353991d5a90a3be04ca54937b46b
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..8dada3e
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "{}"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright {yyyy} {name of copyright owner}
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5874c95
--- /dev/null
+++ b/README.md
@@ -0,0 +1,251 @@
+# Gerrit Code Review docker image
+
+The official Gerrit Code Review image with an out-of-the-box setup
+with H2 and DEVELOPMENT account setup.
+
+This image is intended to be used AS-IS for training or staging environments.
+It can be used for production as base image and requires customizations to its gerrit.config
+and definition of persistent external modules.
+
+## Quickstart
+
+Start Gerrit Code Review in its demo/staging out-of-the-box setup:
+
+```
+docker run -ti -p 8080:8080 -p 29418:29418 gerritcodereview/gerrit
+```
+
+Wait a few minutes until the ```Gerrit Code Review 2.14.2 ready``` message appears and then
+open your browser to http://localhost:8080 and you will be in Gerrit Code Review.
+
+*NOTE*: If your docker server is running on a remote host, change 'localhost' to the hostname
+or IP address of your remote docker server.
+
+Starting from Ver. 2.14, a new introduction screen guides you through the basics of Gerrit
+and allows installing additional plugins downloaded from [Gerrit CI](https://gerrit-ci.gerritforge.com).
+
+## Using persistent volumes
+
+Use docker persistent volumes to keep Gerrit data across restarts.
+See below a sample docker-compose.yaml for persisting the H2 Database, Lucene indexes, Caches and
+Git repositories.
+
+Example of /docker-compose.yaml
+
+```yaml
+version: '3'
+
+services:
+ gerrit:
+ image: gerritcodereview/gerrit
+ volumes:
+ - git-volume:/var/gerrit/git
+ - db-volume:/var/gerrit/db
+ - index-volume:/var/gerrit/index
+ - cache-volume:/var/gerrit/cache
+ ports:
+ - "29418:29418"
+ - "8080:8080"
+
+volumes:
+ git-volume:
+ db-volume:
+ index-volume:
+ cache-volume:
+```
+
+
+Run ```docker-compose up``` to trigger the build and execution of your custom Gerrit docker setup.
+
+## Using Gerrit in production
+
+When running Gerrit on Docker in production, it is a good idea to rely on a physical external
+with much better performance and reliability of the Docker's internal AUFS, and an external
+configuration directory for better change management traceability.
+
+Additionally, you may want to replace H2 with a more robust DBMS like PostgreSQL and an external
+authentication system such as LDAP.
+
+See below a more advanced example of docker-compose.yaml with PostgreSQL and OpenLDAP (from Osixia's DockerHub).
+
+Example of /docker-compose.yaml assuming you have an external directory available as /external/gerrit
+
+```yaml
+version: '3'
+
+services:
+ gerrit:
+ image: gerritcodereview/gerrit
+ ports:
+ - "29418:29418"
+ - "80:8080"
+ links:
+ - postgres
+ depends_on:
+ - postgres
+ - ldap
+ volumes:
+ - /external/gerrit/etc:/var/gerrit/etc
+ - /external/gerrit/git:/var/gerrit/git
+ - /external/gerrit/index:/var/gerrit/index
+ - /external/gerrit/cache:/var/gerrit/cache
+# entrypoint: java -jar /var/gerrit/bin/gerrit.war init -d /var/gerrit
+
+ postgres:
+ image: postgres:9.6
+ environment:
+ - POSTGRES_USER=gerrit
+ - POSTGRES_PASSWORD=secret
+ - POSTGRES_DB=reviewdb
+ volumes:
+ - /external/gerrit/postgres:/var/lib/postgresql/data
+
+ ldap:
+ image: osixia/openldap
+ ports:
+ - "389:389"
+ - "636:636"
+ environment:
+ - LDAP_ADMIN_PASSWORD=secret
+ volumes:
+ - /external/gerrit/ldap/var:/var/lib/ldap
+ - /external/gerrit/ldap/etc:/etc/ldap/slapd.d
+
+ ldap-admin:
+ image: osixia/phpldapadmin
+ ports:
+ - "6443:443"
+ environment:
+ - PHPLDAPADMIN_LDAP_HOSTS=ldap
+```
+
+Example of /external/gerrit/etc/gerrit.config
+
+```
+[gerrit]
+ basePath = git
+ canonicalWebUrl = http://localhost
+
+[database]
+ type = postgresql
+ hostname = postgres
+ database = reviewdb
+ username = gerrit
+
+[index]
+ type = LUCENE
+
+[auth]
+ type = ldap
+ gitBasicAuth = true
+
+[ldap]
+ server = ldap://ldap
+ username=cn=admin,dc=example,dc=org
+ accountBase = dc=example,dc=org
+ accountPattern = (&(objectClass=person)(uid=${username}))
+ accountFullName = displayName
+ accountEmailAddress = mail
+
+[sendemail]
+ smtpServer = localhost
+
+[sshd]
+ listenAddress = *:29418
+
+[httpd]
+ listenUrl = http://*:8080/
+
+[cache]
+ directory = cache
+
+[container]
+ user = root
+```
+
+Example of /external/gerrit/etc/secure.config
+```
+[database]
+ password = secret
+
+[ldap]
+ password = secret
+```
+
+### Initialize Gerrit DB and Git repositories with Docker
+
+The external filesystem needs to be initialized with gerrit.war beforehand:
+- ReviewDB created and populated with the initial DDL
+- All-Projects, All-Groups and All-Users Git repositories created in Gerrit
+- System Group UUIDs created in Git repositories and initialized in ReviewDB
+
+The initialization can be done as a one-off operation before starting all containers.
+
+#### Step-1: Create the PostgreSQL ReviewDB
+
+Start the postgres image standalone using docker compose:
+
+```
+docker-compose up -d postgres
+docker-compose logs -f postgres
+```
+
+Wait until you see in the output a message like: "database system is ready to accept connections"
+
+#### Step-2: Run Gerrit docker init setup from docker
+
+Uncomment in docker-compose.yaml the Gerrit init step entrypoint and run Gerrit with docker-compose
+in foreground.
+
+```
+docker-compose up gerrit
+```
+
+Wait until you see in the output the message ```Initialized /var/gerrit``` and then the container
+will exit.
+
+#### Step-3: Comment out the gerrit init entrypoint in docker-compose.yaml and start all the docker-compose nodes:
+
+```
+docker-compose up -d
+```
+
+### Registering users in OpenLDAP with PhpLdapAdmin
+
+The sample docker compose project includes a node with PhpLdapAdmin connected to OpenLDAP
+and exposed via Web UX at https://localhost:6443.
+
+The first user that logs in Gerrit is considered the initial administrator, it is important
+that you configure it on LDAP to login and having the ability to administer your Gerrit setup.
+
+#### Define the Gerrit administrator in OpenLDAP
+
+Login to PhpLdapAdmin using ```cn=admin,dc=example,dc=org``` as username and ```secret``` as password
+and then create a new child node of type "Courier Mail Account" for the Gerrit Administrator
+
+Example:
+
+- Given Name: Gerrit
+- Last Name: Admin
+- Common Name: Gerrit Admin
+- User ID: gerritadmin
+- Email: gerritadmin@localdomain
+- Password: secret
+
+Verify that your data and then commit the changes to LDAP.
+
+#### Login to Gerrit as Administrator
+
+Login to Gerrit on http://localhost using the new Gerrit Admin credentials created on LDAP.
+
+Example:
+
+- Login: gerritadmin
+- Password: secret
+
+## More information about Gerrit Code Review
+
+Refer to Gerrit Documentation at http://localhost/Documentation/index.html for more information on
+how to configure, administer and use Gerrit Code Review.
+
+For a full list of Gerrit Code Review resources, refer to the [Gerrit Code Review home page](https://www.gerritcodereview.com)
\ No newline at end of file
