├── .gitignore ├── BUILD_README.md ├── LICENSE ├── README.md ├── docker-compose.yml ├── grails-java7 └── Dockerfile ├── openboxes-config.properties ├── openboxes-mysql.cnf ├── openboxes-run.sh └── openboxes-setenv.sh /.gitignore: -------------------------------------------------------------------------------- 1 | *.iml 2 | 3 | -------------------------------------------------------------------------------- /BUILD_README.md: -------------------------------------------------------------------------------- 1 | # Manual Build Process 2 | 3 | ``` 4 | docker container run -it \ 5 | --platform linux/amd64 \ 6 | -e SDKMAN_DIR=/root/.sdkman \ 7 | -e GRAILS_VERSION=1.3.9 \ 8 | -p 8080:8080 \ 9 | -v ./openboxes-config.properties:/root/.grails/openboxes-config.properties \ 10 | -v ./openboxes-setenv.sh:/usr/share/tomcat7/bin/setenv.sh \ 11 | -v ./openboxes-run.sh:/root/openboxes-run.sh \ 12 | -v ./openboxes:/app \ 13 | azul/zulu-openjdk:7u352-7.56.0.11 14 | ``` 15 | 16 | ``` 17 | docker run -d --name mysql-openboxes \ 18 | --platform linux/amd64 \ 19 | -e MYSQL_ROOT_PASSWORD=openboxes \ 20 | -p 3306:3306 \ 21 | mysql:5.7.44 22 | ``` -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # openboxes-docker 2 | 3 | This project contains the relevant files to run OpenBoxes using Docker. It utilizes docker-compose, which enables connecting several independent 4 | dockerized services together (in this case MySQL and Grails), and maintaining configuration for these within a docker-compose.yml file. 5 | 6 | If you haven't already done do, you will need to [Install Docker](https://docs.docker.com/) and [Install Docker Compose](https://docs.docker.com/compose/) 7 | 8 | ### Pre-requisite: 9 | 10 | ``` 11 | git clone https://github.com/openboxes/openboxes.git ## switch to whatever version you're using 12 | git clone https://github.com/openboxes/openboxes-docker.git 13 | ``` 14 | 15 | ### Step 1: Adjust the include configuration files as needed 16 | 17 | Although this docker-compose project should work without modification, there may be occasions when you would like more control over the 18 | way it operates, given your particular machine configuration. Most of the included files should be considered defaults that can be changed. Some common examples: 19 | 20 | **The location of openboxes code** - This is assumed to be locally cloned as "openboxes" in a directory at the same level as this docker project. 21 | You can see this in the docker-compose file, which attempts to mount a volume from "../openboxes" on your host into the grails-java-7 container at "/app", which is 22 | where the container assumes that the Grails project is located. 23 | 24 | **The Tomcat port** - Default is 8080. Changing this requires editing the "grails" service settings in docker-compose.yml 25 | and the grails.serverUrl in openboxes-config.properties 26 | 27 | **The Tomcat memory and environment** - Edit the included openboxes-setenv.sh file 28 | 29 | **The MySQL database name, port, username, or password** - Changing these requires editing the "db" service settings in docker-compose.yml 30 | and the dataSource.url, dataSource.username, and/or dataSource.password in openboxes-config.properties 31 | 32 | **The MySQL root password** - Edit the "db" service settings in docker-compose.yml 33 | 34 | **The MySQL configuration** - Edit the included openboxes-mysql.conf file 35 | 36 | ### Step 2: Build the necessary Docker images and attempt initial run 37 | 38 | From the base directory (the one that contains your docker-compose.yml file) run: 39 | 40 | `docker-compose up --build` 41 | 42 | This will build the grails-java-7 image that is included and referenced as a relative image within the docker-compose.yml file. It will then try to 43 | fire up the application the first time. 44 | 45 | *NOTE*: This will likely fail the first time when Grails attempts to run. We generally see the following error on first run: 46 | 47 | ``` 48 | groovy.lang.MissingPropertyException: No such property: mergedConfig for class: org.codehaus.groovy.grails.commons.DefaultGrailsApplication 49 | ``` 50 | 51 | ### Step 3: Attempt to start up the service 52 | 53 | After step 1 above, Ctrl-C out of it, and attempt to run again, this time omitting the build flag: 54 | 55 | `docker-compose up` 56 | 57 | This should successfully start up the application. If any errors occur, these will generally be configuration related. Fix and repeat this step 58 | 59 | Ctrl-C from the window in which you brought the containers up is sufficient to later stop those services. You can also stop them explicitly from another 60 | terminal window, by running: 61 | 62 | `docker-compose down` 63 | 64 | ### Working with the running containers 65 | 66 | Some useful commands that are helpful to work with these containers while they are running: 67 | 68 | **Open up a bash shell for working within a container** 69 | 70 | `docker exec -it /bin/bash` 71 | 72 | For example, let's say you want to use the mysql client within the mysql container to look around the database a bit: 73 | 74 | 1. `docker ps` - will show you the names of which containers are running. Typically mysql will be in **openboxesdocker_db_1** if build like described above 75 | 2. `docker exec -it openboxesdocker_db_1 /bin/bash` - this will put you into a bash shell __inside__ the container. It will look something like `root@d7e7bd809849:/#` 76 | 3. `mysql -u openboxes -p openboxes` - Now that you are inside the container, you can run the normal slew of mysql commands as if it is local 77 | 78 | **Open up a bash shell for working within a container with docker-compose**: 79 | 80 | `docker-compose exec bash` 81 | 82 | This will put you in a bash shell __inside__ the container with the service name defined in the docker-compose.yml file, in this case **db** or **grails**. 83 | 84 | **Tail the log file of a particular container** 85 | 86 | `docker logs -f ` (see https://docs.docker.com/engine/reference/commandline/logs/) 87 | 88 | For example, let's say you want to tail the Tomcat/Grails logs": 89 | 90 | 1. `docker ps` - will show you the names of which containers are running. Typically grails will be in **openboxesdocker_grails_1** if build like described above 91 | 2. `docker logs -f openboxesdocker_grails_1` - will tail the log file. Hit Ctrl-C to exit. 92 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: "3" 2 | services: 3 | db: 4 | image: mysql:5.7.44 5 | platform: linux/amd64 6 | environment: 7 | MYSQL_ROOT_PASSWORD: root 8 | MYSQL_DATABASE: openboxes 9 | MYSQL_USER: openboxes 10 | MYSQL_PASSWORD: openboxes 11 | volumes: 12 | - ./openboxes-mysql.cnf:/etc/mysql/conf.d/openboxes-mysql.cnf 13 | ports: 14 | - "3306:3306" 15 | 16 | grails: 17 | build: ./grails-java7 18 | command: sh /root/openboxes-run.sh 19 | platform: linux/amd64 20 | ports: 21 | - "8080:8080" 22 | volumes: 23 | - ./openboxes-config.properties:/root/.grails/openboxes-config.properties 24 | - ./openboxes-setenv.sh:/usr/share/tomcat7/bin/setenv.sh 25 | - ./openboxes-run.sh:/root/openboxes-run.sh 26 | - ../openboxes:/app 27 | depends_on: 28 | - db 29 | -------------------------------------------------------------------------------- /grails-java7/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM azul/zulu-openjdk:7u352-7.56.0.11 2 | 3 | LABEL maintainer="Michael Seaton mseaton@pih.org" 4 | 5 | # Environment variables 6 | 7 | ENV SDKMAN_DIR /root/.sdkman 8 | ENV GRAILS_VERSION 1.3.9 9 | ENV NODE_VERSION=14.21.3 10 | 11 | 12 | # Install Base Packages required 13 | RUN apt-get update && apt-get install -y curl zip python2 g++ make gcc build-essential git 14 | 15 | # Download node + extract 16 | RUN curl -LO https://nodejs.org/dist/v${NODE_VERSION}/node-v${NODE_VERSION}-linux-x64.tar.xz &&\ 17 | tar -xvf node-v${NODE_VERSION}-linux-x64.tar.xz 18 | 19 | # Update our PATH to include the node binary 20 | ENV PATH=${PATH}:/node-v${NODE_VERSION}-linux-x64/bin 21 | 22 | # Install Grails and Set Path 23 | RUN rm /bin/sh && ln -s /bin/bash /bin/sh 24 | RUN curl -s "https://get.sdkman.io" | bash 25 | RUN chmod a+x "$SDKMAN_DIR/bin/sdkman-init.sh" 26 | 27 | # change timeout and max time based on your liking and internet speed 28 | RUN set -x \ 29 | && echo "sdkman_auto_answer=true" > $SDKMAN_DIR/etc/config \ 30 | && echo "sdkman_auto_selfupdate=false" >> $SDKMAN_DIR/etc/config \ 31 | && echo "sdkman_curl_connect_timeout=20" >> $SDKMAN_DIR/etc/config \ 32 | && echo "sdkman_curl_max_time=0" >> $SDKMAN_DIR/etc/config \ 33 | && echo "sdkman_insecure_ssl=false" >> $SDKMAN_DIR/etc/config 34 | 35 | WORKDIR $SDKMAN_DIR 36 | RUN [[ -s "$SDKMAN_DIR/bin/sdkman-init.sh" ]] && source "$SDKMAN_DIR/bin/sdkman-init.sh" && exec "$@" 37 | 38 | RUN source /root/.bashrc 39 | 40 | # install and set grails version 41 | RUN bash -c "source $SDKMAN_DIR/bin/sdkman-init.sh && sdk install grails $GRAILS_VERSION" 42 | RUN bash -c "source $SDKMAN_DIR/bin/sdkman-init.sh && sdk default grails $GRAILS_VERSION" 43 | 44 | # set envs 45 | ENV JAVA_HOME /usr/lib/jvm/zulu7-ca-amd64 46 | ENV GRAILS_HOME /root/.sdkman/candidates/grails/current 47 | ENV PATH $GRAILS_HOME/bin:$PATH 48 | # Memory settings were required or else things would fail with OOM errors or stall forever 49 | ENV GRAILS_OPTS -XX:MaxPermSize=8192m -Xmx8192M -XX:-UseSplitVerifier -Xverify:none 50 | 51 | # Set the directory that an existing Grails app should be mounted into with a volume 52 | RUN mkdir /app 53 | WORKDIR /app 54 | 55 | EXPOSE 8080 56 | 57 | CMD ["grails"] -------------------------------------------------------------------------------- /openboxes-config.properties: -------------------------------------------------------------------------------- 1 | 2 | # Database connection settings 3 | dataSource.url=jdbc:mysql://db:3306/openboxes?autoReconnect=true&zeroDateTimeBehavior=convertToNull&verifyServerCertificate=false 4 | dataSource.username=openboxes 5 | dataSource.password=openboxes 6 | 7 | # OpenBoxes mail settings - disabled by default 8 | grails.mail.enabled=false 9 | 10 | # if test fail this must be enabled 11 | openboxes.fixtures.enabled=false 12 | 13 | # enable custom locale 14 | openboxes.locale.custom.enabled = true 15 | 16 | # in beta 17 | # openboxes.scannerDetection.enabled = true 18 | 19 | # Default server URL 20 | grails.serverURL=http://localhost:8080 21 | -------------------------------------------------------------------------------- /openboxes-mysql.cnf: -------------------------------------------------------------------------------- 1 | [mysqld] 2 | character-set-server = utf8 3 | collation-server = utf8_general_ci 4 | max_allowed_packet=256M -------------------------------------------------------------------------------- /openboxes-run.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # grails doesn't run without it for some reason 4 | export GRAILS_OPTS="-XX:MaxPermSize=8192m -Xmx8192M -XX:-UseSplitVerifier -Xverify:none" 5 | 6 | if [ ! -f /app/web-app/WEB-INF/applicationContext.xml ]; then 7 | echo "Forcing grails upgrade" 8 | grails upgrade --force --stacktrace 9 | fi 10 | 11 | 12 | npm cache clean --force 13 | npm cache verify 14 | npm i -g npm@6.14.6 15 | npm config set engine-strict true 16 | # npm update 17 | 18 | # some dependencies don't get resolved on thier own 19 | npm i --no-package-lock --legacy-peer-deps --force --verbose --stacktrace --unsafe-perm 20 | grails run-app --stacktrace 21 | 22 | # if you want to compile enable this and stop grails run-app 23 | # grails -Dgrails.env=staging war -------------------------------------------------------------------------------- /openboxes-setenv.sh: -------------------------------------------------------------------------------- 1 | export CATALINA_OPTS="$CATALINA_OPTS -server -Xms1024m -Xmx2048m -XX:MaxPermSize=256m -Djava.security.egd=file:/dev/./urandom" 2 | --------------------------------------------------------------------------------