├── .gitignore ├── darkstar-db ├── docker-entrypoint-initdb.d │ └── zoneip.sql.tpl ├── Dockerfile └── darkstar-db-entrypoint.sh ├── .env.example ├── darkstar-server ├── etc │ └── supervisord.conf ├── docker-entrypoint.sh └── Dockerfile ├── docker-compose.yml ├── readme.md └── license.md /.gitignore: -------------------------------------------------------------------------------- 1 | .env 2 | -------------------------------------------------------------------------------- /darkstar-db/docker-entrypoint-initdb.d/zoneip.sql.tpl: -------------------------------------------------------------------------------- 1 | USE dspdb; 2 | UPDATE zone_settings SET zoneip = '{{ZONE_IP}}'; -------------------------------------------------------------------------------- /.env.example: -------------------------------------------------------------------------------- 1 | MYSQL_PASSWORD=ChangeMe 2 | MYSQL_ROOT_PASSWORD=DefinitelyChangeMe 3 | MYSQL_DATABASE=dspdb 4 | MYSQL_LOGIN=darkstar 5 | SERVERNAME=DonkeyBalls -------------------------------------------------------------------------------- /darkstar-db/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM mysql:5.6 2 | 3 | COPY docker-entrypoint-initdb.d/ docker-entrypoint-initdb.d 4 | 5 | RUN apt-get update && apt-get install -y git && \ 6 | rm -rf /var/lib/apt/lists/* 7 | 8 | RUN git clone --depth=1 -b stable http://github.com/DarkstarProject/darkstar.git/ /darkstar && \ 9 | mkdir -p /docker-entrypoint-initdb.d/.seed && \ 10 | cp /darkstar/sql/* /docker-entrypoint-initdb.d/.seed/ && \ 11 | rm -rf /darkstar 12 | 13 | COPY darkstar-db-entrypoint.sh /usr/local/bin 14 | 15 | RUN chmod a+x /usr/local/bin/*.sh 16 | 17 | ENTRYPOINT ["darkstar-db-entrypoint.sh"] 18 | 19 | EXPOSE 3306 20 | CMD ["mysqld"] 21 | -------------------------------------------------------------------------------- /darkstar-server/etc/supervisord.conf: -------------------------------------------------------------------------------- 1 | [supervisord] 2 | nodaemon=true 3 | 4 | [program:connect] 5 | command=/bin/bash -c "exec /darkstar/dsconnect" 6 | stdout_events_enabled=true 7 | stderr_events_enabled=true 8 | 9 | [program:game] 10 | command=/bin/bash -c "exec /darkstar/dsgame" 11 | stdout_events_enabled=true 12 | stderr_events_enabled=true 13 | 14 | [program:search] 15 | command=/bin/bash -c "exec /darkstar/dssearch" 16 | stdout_events_enabled=true 17 | stderr_events_enabled=true 18 | 19 | [eventlistener:stdout] 20 | command = supervisor_stdout 21 | buffer_size = 5 22 | events = PROCESS_LOG 23 | result_handler = supervisor_stdout:event_handler -------------------------------------------------------------------------------- /darkstar-db/darkstar-db-entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | ZONE_IP=${ZONE_IP:-127.0.0.1} 4 | MYSQL_USER=${MYSQL_USER:-darkstar} 5 | MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD:-darkstar} 6 | MYSQL_PASSWORD=${MYSQL_PASSWORD:-darkstar} 7 | MYSQL_DATABASE=${MYSQL_DATABASE:-dspdb} 8 | 9 | if [[ -d /docker-entrypoint-initdb.d/.seed ]]; then 10 | cd /docker-entrypoint-initdb.d/.seed 11 | for f in *.sql 12 | do 13 | echo "USE ${MYSQL_DATABASE};" | cat - $f >> /docker-entrypoint-initdb.d/010-$f 14 | done 15 | fi 16 | 17 | if [[ -f /docker-entrypoint-initdb.d/zoneip.sql.tpl ]]; then 18 | sed -i "s/{{ZONE_IP}}/$ZONE_IP/" /docker-entrypoint-initdb.d/zoneip.sql.tpl && \ 19 | mv /docker-entrypoint-initdb.d/zoneip.sql.tpl /docker-entrypoint-initdb.d/999-zoneip.sql 20 | fi 21 | 22 | docker-entrypoint.sh "$@" -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '2' 2 | # Persistent volume for the db 3 | volumes: 4 | db_data: 5 | services: 6 | darkstart-server: 7 | container_name: darkstar-server 8 | build: darkstar-server 9 | links: 10 | - darkstar-db 11 | environment: 12 | MYSQL_HOST: darkstar-db 13 | MYSQL_LOGIN: ${MYSQL_LOGIN} 14 | MYSQL_DATABASE: ${MYSQL_DATABASE} 15 | MYSQL_PASSWORD: ${MYSQL_PASSWORD} 16 | SERVERNAME: ${SERVERNAME} 17 | ports: 18 | - "54230:54230" 19 | - "54230:54230/udp" 20 | - "54231:54231" 21 | - "54001:54001" 22 | - "54002:54002" 23 | darkstar-db: 24 | container_name: darkstar-db 25 | build: darkstar-db 26 | ports: 27 | - "23055:3306" 28 | volumes: 29 | - db_data:/var/lib/mysql 30 | environment: 31 | MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASSWORD} 32 | MYSQL_DATABASE: ${MYSQL_DATABASE} 33 | MYSQL_USER: ${MYSQL_LOGIN} 34 | MYSQL_PASSWORD: ${MYSQL_PASSWORD} 35 | -------------------------------------------------------------------------------- /darkstar-server/docker-entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | set -ex 4 | 5 | MYSQL_HOST=${MYSQL_HOST:-localhost} 6 | MYSQL_PORT=${MYSQL_PORT:-3306} 7 | MYSQL_LOGIN=${MYSQL_LOGIN:-darkstar} 8 | MYSQL_PASSWORD=${MYSQL_PASSWORD:-darkstar} 9 | MYSQL_DATABASE=${MYSQL_DATABASE:-dspdb} 10 | SERVERNAME=${SERVERNAME:-DarkStar} 11 | 12 | ## modify configuration 13 | function modConfig() { 14 | local db_files=(login_darkstar.conf map_darkstar.conf search_server.conf) 15 | 16 | for f in ${db_files[@]} 17 | do 18 | if [[ -f /darkstar/conf/$f ]]; then 19 | sed -i "s/^\(mysql_host:\s*\).*\$/\1$MYSQL_HOST/" /darkstar/conf/$f 20 | sed -i "s/^\(mysql_port:\s*\).*\$/\1$MYSQL_PORT/" /darkstar/conf/$f 21 | sed -i "s/^\(mysql_login:\s*\).*\$/\1$MYSQL_LOGIN/" /darkstar/conf/$f 22 | sed -i "s/^\(mysql_password:\s*\).*\$/\1$MYSQL_PASSWORD/" /darkstar/conf/$f 23 | sed -i "s/^\(mysql_database:\s*\).*\$/\1$MYSQL_DATABASE/" /darkstar/conf/$f 24 | fi 25 | done 26 | 27 | sed -i "s/^\(servername:\s*\).*\$/\1$SERVERNAME/" /darkstar/conf/login_darkstar.conf 28 | } 29 | 30 | modConfig 31 | 32 | exec /usr/local/bin/supervisord -------------------------------------------------------------------------------- /darkstar-server/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM ubuntu:trusty 2 | 3 | ENV DS_BRANCH=stable 4 | 5 | RUN apt-get update && \ 6 | apt-get install -y build-essential git libmysqlclient-dev libluajit-5.1-dev \ 7 | libzmq3-dev autoconf pkg-config software-properties-common python-pip && \ 8 | apt-add-repository -y ppa:ubuntu-toolchain-r/test && \ 9 | apt-get update && \ 10 | apt-get install -y g++-7 && \ 11 | update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-7 90 && \ 12 | apt-get install -y libx32gcc-7-dev && \ 13 | easy_install supervisor && \ 14 | pip install supervisor-stdout && \ 15 | git clone --depth=1 -b ${DS_BRANCH} http://github.com/DarkstarProject/darkstar.git/ /darkstar && \ 16 | cd /darkstar && \ 17 | sh autogen.sh && \ 18 | ./configure --enable-debug=gdb && \ 19 | make -j12 && \ 20 | apt-get autoremove -y build-essential git autoconf pkg-config software-properties-common && \ 21 | rm -rf /var/lib/apt/lists/* && \ 22 | rm -rf /darkstar/src && \ 23 | rm -rf /darkstar/sql 24 | 25 | COPY etc/ etc/ 26 | COPY docker-entrypoint.sh /usr/local/bin/ 27 | 28 | # add darkstar user and fix permissions 29 | RUN groupadd -r darkstar && \ 30 | useradd -g darkstar -ms /bin/bash darkstar && \ 31 | chown -R darkstar:darkstar /darkstar && \ 32 | chmod a+x /usr/local/bin/docker-entrypoint.sh 33 | 34 | USER darkstar 35 | EXPOSE 54230 54230/udp 54231 54001 54002 36 | WORKDIR /darkstar 37 | 38 | CMD ["docker-entrypoint.sh"] 39 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # ffxi-darkstar-docker 2 | 3 | dockerfied darkstar allows you to quickly setup and deploy a containerized ffxi server. 4 | 5 | two seperate services (server / db); utilizes docker volume to persist db data; supervisord for connect/game/search daemons; does not run as root. 6 | 7 | server is based off of ubuntu:trusty, db is based off mysql:5.5 (why 5.5? there are null constraint issues in 5.6). 8 | 9 | --- 10 | 11 | onbuild: 12 | - db container shallow clones darkstar (stable), copies SQL into seed directory; cleans up 13 | - server container installs dependencies; shallow clones darkstar (stable); compiles; cleans up 14 | 15 | onstart: 16 | - db container copies seed data to target; prepends a `use` statement; injects a zone_ip update script 17 | - db container will run seed data if db defined as `$MYSQL_DATABASE` does not exist 18 | - app server uses `sed` to inject environment configuration parameters 19 | 20 | --- 21 | 22 | recommendations: 23 | 24 | - use linux native or within a bridged linux VM. native osx/native windows or docker-machine may give you unexpected results 25 | - optional: copy `.env.example` -> `.env`; modify to your needs, if you don't you'll see WARNINGS (but server should still work) 26 | - optional: use an external volume mount for the database volume (nfs/filesystem) 27 | 28 | instructions: 29 | 30 | * install latest docker CE (https://store.docker.com/search?type=edition&offering=community) 31 | * install latest docker-compose `$ pip install docker-compose` 32 | * clone repo `git clone ` 33 | * cd into repo `cd ffxi-darkstar-docker` 34 | * start services `docker-compose up` 35 | 36 | --- 37 | 38 | admin: 39 | 40 | * `docker-compose build` will force images to rebuild. to force a pull from darkstar `stable`, issue the build command with a `--no-cache` argument. 41 | * `docker-compose restart` will ... restart 42 | * `docker-compose down -v` will nuke your database if you decide to forego the advice of using an external volume 43 | * connect to `0.0.0.0:23055` to with your (MySQL) database tool of choice. use the credentials defined in `.env`; or the default `darkstar:darkstar` 44 | 45 | --- 46 | 47 | usage: 48 | 49 | see darkstar doc/wiki for how to actually use the server: https://wiki.dspt.info/index.php/Main_Page 50 | 51 | services are exposed on the (typical) ports: 52 | 53 | - `0.0.0.0:54230` 54 | - `0.0.0.0:54230/udp` 55 | - `0.0.0.0:54231` 56 | - `0.0.0.0:54001` 57 | - `0.0.0.0:54002` 58 | - `0.0.0.0:23055` (MySQL DB) 59 | 60 | --- 61 | 62 | considerations: 63 | 64 | * moving login/map/search to separate containers. this all depends on the applications ability to resolve dns names. parameters like `login_data_ip` make me think otherwise. 65 | * integration / build testing 66 | * more runtime environment configuration 67 | * ??? submit a PR -------------------------------------------------------------------------------- /license.md: -------------------------------------------------------------------------------- 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 | --------------------------------------------------------------------------------