├── .gitattributes ├── .gitignore ├── Dockerfile ├── LICENSE ├── README.md ├── experimental ├── setup_multi.bat └── setup_standalone.bat ├── mcdata └── .gitignore ├── resource ├── installbedrockserver.sh ├── runbedrockserver.sh └── updatebedrockserver.sh ├── setup_multi.sh ├── setup_standalone.sh └── templates ├── .env ├── docker-compose.yml └── mcdata ├── world.permissions.json ├── world.server.properties ├── world.whitelist.json └── worlds └── world └── COPY_WORLD_DATA_HERE /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto 2 | *.sh text eol=lf 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /.env 2 | /docker-compose.yml 3 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM ubuntu:22.04 2 | 3 | # install dependencies 4 | RUN apt update && \ 5 | apt install -y curl unzip && \ 6 | apt clean && \ 7 | apt clean autoclean && \ 8 | rm -rf /var/lib/apt/lists/* 9 | 10 | # build arguments 11 | ARG MCPORT 12 | ARG INSTALLERBASE 13 | ARG INSTALLERURL 14 | ARG MCUSER 15 | ARG MCGROUP 16 | ARG VERSION 17 | ARG AUTOUPDATE 18 | ENV MCUSER=${MCUSER:-1132} 19 | ENV MCGROUP=${MCGROUP:-1132} 20 | ENV MCPORT=${MCPORT:-19132} 21 | ENV VERSION=${VERSION:-"1.20.0.01"} 22 | ENV INSTALLERBASE=${INSTALLERBASE:-"https://minecraft.azureedge.net/bin-linux/bedrock-server-"} 23 | ENV AUTOUPDATE=${AUTOUPDATE:-1} 24 | 25 | # setup environment 26 | ENV container=docker 27 | ENV WORLD='world' 28 | ENV MCSERVERFOLDER="/srv/bedrockserver" 29 | ENV MCVOLUME=/mcdata 30 | ENV PATH $PATH:${MCSERVERFOLDER} 31 | 32 | # open the server port 33 | EXPOSE $MCPORT 34 | 35 | # make dirs 36 | RUN mkdir -p $MCSERVERFOLDER/default $MCVOLUME 37 | 38 | # copy resource files over 39 | COPY resource/* $MCSERVERFOLDER/ 40 | 41 | # fix permissions 42 | RUN chown -Rf $MCUSER:$MCGROUP $MCSERVERFOLDER $MCVOLUME && \ 43 | chmod -Rf g=u $MCSERVERFOLDER $MCVOLUME && \ 44 | chmod +x $MCSERVERFOLDER/*.sh 45 | 46 | # set default user to minecraft user 47 | USER $MCUSER:$MCGROUP 48 | 49 | # create volume for minecraft resources 50 | VOLUME $MCVOLUME 51 | 52 | # install bedrock server 53 | RUN if [ $AUTOUPDATE = 1 ]; then touch $MCSERVERFOLDER/.AUTOUPDATE; fi && \ 54 | $MCSERVERFOLDER/installbedrockserver.sh $VERSION 55 | 56 | 57 | CMD ["runbedrockserver.sh"] 58 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Minecraft Server (Bedrock) for Docker 2 | 3 | A Docker image and docker-compose file to run one or more instances of a native Minecraft Bedrock server in a minimal Ubuntu environment. 4 | 5 | ## Introduction 6 | 7 | This repository includes a DockerFile to build a Ubuntu-based Docker image configured to launch a Minecraft Bedrock Dedicated Server. In most cases, when run using the host network driver, as shown in the instructions, any Minecraft Bedrock client (e.g. XBox One, Windows 10, Android, etc.) on your local area network *should* be able to see the server under the list of "Friends." 8 | 9 | This repository further includes an example docker-compose.yml file for Docker Compose to run multiple such containers on a macvlan network. When setup properly through the script and/or manual instructions below, it will concurrently run multiple servers that are each accessible to the local area network. For instance, I have used it to run different survival and creative worlds for each of my children at the same time, each of which is always accessible on our home network, no matter what device the kids are using. 10 | 11 | The Minecraft data may further be exposed to your host, so that you can easily back up your worlds and configuration. 12 | 13 | ## Version History 14 | 15 | - 1.14 (Dec 2019): Added automatic updating of minecraft server on image restart 16 | - 1.13.1 (Nov 2019): Major revisions to architecture, including running under a different user and expanded custom resource file/directory support 17 | - 0.1.12 (10 Jul 2019): Custom permission file support 18 | - 0.1.8.2 (16 Dec 2018): Bump Minecraft version number 19 | - Initial release (17 Oct 2018) 20 | 21 | *For updating from pre-1.13.1 versions, see [Updating from Pre-1.13.1 Versions](#updating-from-pre-1131-versions).* 22 | 23 | ## Prerequisites 24 | 25 | - Docker 26 | - Docker Compose (if you want to use the instructions for multiple servers) 27 | - git (if you need to build your own image or use docker-compose) 28 | 29 | 30 | ## Quick Start (Single Server) 31 | 32 | *To build/run a single server with a new world on the host:* 33 | 34 | ``` 35 | docker run -dit --name="minecraft" --network="host" karlrees/docker_bedrockserver 36 | ``` 37 | 38 | It's probable that, relying on the above command, *you will lose your world* if you ever have to update the docker image (e.g. for a new server version). One way to get around this, is to make the mcdata folder a Docker volume as follows: 39 | 40 | ``` 41 | docker run -dit --name="minecraft" --network="host" -v mcdata:/mcdata karlrees/docker_bedrockserver 42 | ``` 43 | 44 | *However, it's nonetheless possible that Docker (or more likely you) could eventually inadvertantly remove the volume somehow. A more fool-proof solution is to actually mount the volume to the host, as shown in the next section.* 45 | 46 | 47 | ## Advanced Instructions 48 | 49 | ### Single-server with externally mounted data 50 | 51 | *To build/run a single server with a world whose data is stored in an externally accessible folder:* 52 | 53 | Aside from giving you better peace of mind that you won't lose your data, this has the added benefit of giving you easy access to the mcdata folder so that you can create backups and/or manipulate your data. 54 | 55 | #### Option A (Single-world Setup Script) 56 | 57 | If you have git installed, you can pull the repository and take advantage of the setup script: 58 | 59 | 1. Download the source code from git. 60 | 61 | ``` 62 | git clone https://github.com/karlrees/docker_bedrockserver 63 | ``` 64 | 65 | 2. Run the setup script. 66 | 67 | ``` 68 | cd docker_bedrockserver 69 | ./setup_standalone.sh 70 | ``` 71 | 72 | The container/server should now be running, and your world data can be found in the `docker_bedrockserver/mcdata` folder. 73 | 74 | #### Option B (Single-world Manual Setup) 75 | 76 | If you don't have git installed, and/or you want more control over the container configuration: 77 | 78 | 1. Create (or locate) a parent folder to store (or that already stores) your Minecraft data. We'll refer this folder subsequently as the `mcdata` folder. You may use the supplied `mcdata` folder from the repository, or any other suitable location. For instance: 79 | 80 | ``` 81 | mkdir /path/to/mcdata 82 | ``` 83 | 84 | 2. Give this new folder permissions whereby it is accessible to the user under which the server will run in the docker container. 85 | 86 | In Linux, there are a number of ways to do this. The easiest and most nuclear option would be: 87 | 88 | ``` 89 | sudo chmod -R 777 /path/to/mcdata 90 | ``` 91 | 92 | A more restrictive option would be to have the same user id as that under which the server runs take ownership of the `mcdata` folder. By default, this user id is 1132, so you would use the following command: 93 | 94 | ``` 95 | sudo chown -R 1132:1132 /path/to/mcdata 96 | ``` 97 | 98 | Other options would include adding the user 1132 to a group that has access to the `mcdata` folder, or changing the user id and/or group id under which the server runs to something that already has access to the `mcdata` folder. Changing the user id and/or group id under which the server runs is explained later in the document. 99 | 100 | 3. Run the docker container 101 | 102 | ``` 103 | docker run -dit --name="minecraft" --network="host" -v /path/to/mcdata:/mcdata karlrees/docker_bedrockserver 104 | ``` 105 | 106 | ### Single-server / Existing world 107 | 108 | *To build/run a single server using a pre-existing Bedrock world folder:* 109 | 110 | 1. Follow [Option A](#option-a-single-world-setup-script) or [Option B](#option-b-single-world-manual-setup) from above. 111 | 2. Locate the `world` folder that stores the existing Minecraft world data for the world you wish to serve. This may or may not be named `world`, but we'll refer to it subsequently as the `world` folder. 112 | 113 | *You'll know this folder from the fact that it includes a file named "level.dat" and a subfolder named "db". For instance, if you wanted to import a world from the Windows 10 Minecraft app, this would be a folder such as `C:\Users\username\AppData\Local\Packages\Microsoft.MinecraftUWP_8wekyb3d8bbwe\LocalState\games\com.mojang\minecraftWorlds\xxx`, where `username` is the name of your user account and xxx is typically a random set of characters.* 114 | 115 | 3. Replace the contents of the `/mcdata/worlds/world` folder with the contents of the `world` folder you located. 116 | 4. Reset permissions on the `mcdata` folder, if needed. *See* Step 3 of [Option B](#option-b-single-world-manual-setup). 117 | 5. Restart the server 118 | 119 | ``` 120 | docker stop minecraft 121 | docker start minecraft 122 | ``` 123 | 124 | ### Multiple worlds with docker-compose 125 | 126 | *To run multiple servers using multiple Bedrock worlds, each running at a separate IP address on your LAN:* 127 | 128 | #### Option C (Multi-world Setup Script) 129 | 130 | The setup script can try to setup your environment for you. Be sure to install docker-compose. 131 | 132 | 1. Download the source code from git. 133 | 134 | ``` 135 | git clone https://github.com/karlrees/docker_bedrockserver 136 | ``` 137 | 138 | 2. Run the `setup_multi.sh` script. 139 | 140 | ``` 141 | cd docker_bedrockserver 142 | ./setup_multi.sh 143 | ``` 144 | 145 | This copies the example `.env` file, `docker-compose.yml` file, and `mcdata` folder to their expected locations, and populates the environment variables with some naive assumptions about your network and mcdata storage location. 146 | 147 | 3. If you want more than just the two example servers, edit the `docker-compose.yml` file to include a separate section for each server. Be sure to change the name for each server--change both the `container_name` property and the `WORLD` environment variable. Be sure to use a different IP address for each server as well. 148 | 149 | 4. Run `docker-compose` 150 | 151 | ``` 152 | docker-compose up -d 153 | ``` 154 | 155 | If this doesn't work for you, you can try the manual setup below. 156 | 157 | #### Option D (Multi-world Manual Setup) 158 | 159 | 1. Download the source code from git and change to the docker_bedrockserver directory 160 | 161 | ``` 162 | git clone https://github.com/karlrees/docker_bedrockserver 163 | ``` 164 | 165 | 2. Setup a `mcdata` folder. *See* Steps 2-3 of [Option B](#option-b-single-world-manual-setup). 166 | 167 | 3. Copy the example `.env` file and `docker-compose.yml` from the `templates` folder to parent directory. 168 | 169 | ``` 170 | cd docker_bedrockserver 171 | cp templates/.env .env 172 | cp templates/docker-compose.yml docker-compose.yml 173 | ``` 174 | 175 | 4. Edit the `.env` file as needed. You will probably need to at least: 176 | 177 | - change the IP Prefix to match your subnet 178 | - change `eth0` to match your network interface 179 | - change the `MCVOLUME` to point to the absolute path of your `mcdata` folder from step 2 180 | 181 | 5. Edit the `docker-compose.yml` file to include a separate section for each server, copying or editing the example servers already at the bottom of the file. Be sure to change the name for each server--change both the `container_name` property and the `WORLD` environment variable. Be sure to use a different IP address for each server as well. 182 | 183 | 6. Run `docker-compose` 184 | 185 | ``` 186 | docker-compose up -d 187 | ``` 188 | 189 | ### Multiple existing worlds 190 | 191 | *To run multiple servers using multiple pre-existing Bedrock worlds, each running at a separate IP address:* 192 | 193 | 1. Follow [Option C](#option-c-multi-world-setup-script) or [Option D](#option-d-multi-world-manual-setup) from above. 194 | 2. Locate the `world` folder that stores the existing Minecraft world data for each world you wish to serve. This may or may not be named `world`, but we'll refer to it subsequently as the `world` folder. 195 | 3. For each world, copy the contents of the `world` folder to the `/mcdata/worlds/` folder, using a different name for each. 196 | 197 | So you might have, for instance, a `/mcdata/worlds/world1` folder, a `/mcdata/worlds/world2` folder, and so forth. 198 | 199 | 4. Reset permissions on the `mcdata` folder, if needed. *See* Step 3 of [Option B](#option-b-single-world-manual-setup). 200 | 201 | 5. Edit `docker-compose.yml` to include a separate section for each server/world, copying or editing the example servers already at the bottom of the file. Be sure to change the name for each server/world to match what you used in step 3. 202 | 203 | 6. Restart the docker-compose services. 204 | 205 | ``` 206 | docker-compose down 207 | docker-compose up -d 208 | ``` 209 | 210 | ## Changing server properties 211 | 212 | Server properties may be changed using either a custom `server.properties` file for your world, or `MCPROP_` environment variables. Any time you change properties, you will need to restart the container for the changes to take effect. 213 | 214 | ### server.properties 215 | 216 | The container will look for a custom `server-properties` file for its world/server in each of the following locations: `/mcdata/world.server.properties`, `/mcdata/worlds/world.server.properties`, and `/mcdata/worlds/world/server.properties` (where `world` is the name of the world/server). It will then link the `server.properties` file for the server to the custom `server.properties` it locates. 217 | 218 | If no custom `server.properties` file is found, a default `server.properties` file will be created, optionally using any supplied environment variables (see below). 219 | 220 | ### MCPROP_ Environment variables 221 | 222 | Environment variables may be passed through the command line or set in the `docker-compose.yml` file. For instance, to change the gamemode to 1 over the CLI, one would set the `MCPROP_GAMEMODE` environment variable to `1`. 223 | 224 | ``` 225 | docker run -e MCPROP_GAMEMODE=1 -e WORLD=world -v /path/to/mcdata:/mcdata -dit --name="minecraft" --network="host" karlrees/docker_bedrockserver 226 | ``` 227 | 228 | The `docker-compose.yml` gives some examples of passing `MCPROP_` environment variables through it. 229 | 230 | Note that `level-name` is a special property that is set by the `WORLD` environment variable, as opposed to `MCPROP_LEVEL-NAME`. 231 | 232 | ## Custom permissions / whitelist / resource files and folders 233 | 234 | You can change your `permissions.json` file, `whitelist.json` file, `resource` directories, and so forth, by mounting the `/mcdata` folder to an external folder and making changes from there. These are all linked to the appropriate locations on the server when the container is started. 235 | 236 | ### Multiple Servers 237 | 238 | If you are running multiple servers, by default they will all share the same files in the `/mcdata` folder. You may or may not want to change this. You can create separate permissions, whitelists, etc., for a server by either saving the appropriate file or folder in your custom world folder, or prefacing the appropriate file(s) and/or directories in the `mcdata` folder with `world.`, where `world` is the name of your world/server. 239 | 240 | For instance, to create a separate permissions file for your world, you could create a file named `/mcdata/world.permissions.json` (where `world` is the name of your world). Or, you could save `permissions.json` to `/mcdata/worlds/world/permissions.json`. In either case, the container will link this file, if it exists, into the world container as the `permissions.json` file for the server. 241 | 242 | Similarly, the container would copy the `world.whitelist.json` file, if it exists (where `world` is the name of your world), into the container as the `whitelist.json` file for the server. 243 | 244 | Or, for a custom `resource_packs` directory, rename it `world.resource_packs` or save it to `/mcdata/worlds/world/resource_packs`. 245 | 246 | You will need to restart the container for any changes to take effect. 247 | 248 | ## Accessing the server console 249 | 250 | To access the server console, if you're using the single-server instructions above: 251 | 252 | ``` 253 | docker attach minecraft 254 | ``` 255 | 256 | If you changed the container name in the run command, change `minecraft` to the container name you used. If you're using docker-compose instructions, replace `minecraft` with the container name you specified in the `docker-compose.yml` file (e.g. `minecraft1`, `minecraft2`, etc.). 257 | 258 | You can then issue server commands, like `stop`, `permission list`, etc. 259 | 260 | To exit, enter `Ctrl-P` followed by `Ctrl-Q`. 261 | 262 | ## Restarting a server 263 | 264 | You can stop a server in the console, or by issuing the following command (where `minecraft` is the container name): 265 | 266 | ``` 267 | docker stop minecraft 268 | ``` 269 | 270 | You can restart it with the following command. 271 | 272 | ``` 273 | docker start minecraft 274 | ``` 275 | 276 | If using docker-compose, you can restart all servers at once using: 277 | 278 | ``` 279 | docker-compose down 280 | docker-compose up 281 | ``` 282 | 283 | ## Minecraft Server updates 284 | 285 | By default, the image will check for an updated version of the Minecraft server on restart. So all you need to do is restart your image(s). So for a single-server install, assuming your image name is minecraft: 286 | 287 | ``` 288 | docker restart minecraft 289 | ``` 290 | 291 | For multiple servers using docker-compose: 292 | 293 | ``` 294 | docker-compose restart 295 | ``` 296 | 297 | ### Disabling automatic updates 298 | 299 | Automatic updates may be disabled in one of two ways. First, you can delete the `$MCSERVERFOLDER/.AUTOUPDATE` file. For instance, if your image name is minecraft: 300 | 301 | ``` 302 | docker exec minecraft rm "/srv/bedrockserver/.AUTOUPDATE" 303 | ``` 304 | 305 | Second, you could disable auto-updates by setting the `AUTOUPDATE` build argument to `0` when building the docker image (which keeps the .AUTOUPDATE file from being created). For instance: 306 | 307 | ``` 308 | docker build --build-arg AUTOUPDATE=0 -t karlrees/docker_bedrockserver:beta . 309 | ``` 310 | 311 | ### Forcing updates 312 | 313 | If auto-updates are disabled, you can still force a minecraft server update using the `updatebedrockserver.sh` script. For instance, if your image name is minecraft: 314 | 315 | ``` 316 | docker exec minecraft /srv/bedrockserver/updatebedrockserver.sh 317 | docker restart minecraft 318 | ``` 319 | 320 | ### Forcing updates to a specific version 321 | 322 | You can force an update to a specific version by adding the version number to the end of the update script. E.g.: 323 | 324 | ``` 325 | docker exec minecraft /srv/bedrockserver/updatebedrockserver.sh 1.14.0.9 326 | docker restart minecraft 327 | ``` 328 | 329 | Alternatively, you can use the `VERSION` build argument when building the image. 330 | 331 | 332 | ## Updating the Docker Image 333 | 334 | To keep up to date with the latest features, you may need to update the docker image from time to time. To update the image, first remove the existing containers. Then pull the update, and run the container again. To do this: 335 | 336 | ### If you are pulling the docker image directly (basic single-server installs) 337 | 338 | Use the following commands, where `minecraft` is the container name: 339 | 340 | ``` 341 | docker stop minecraft 342 | docker rm minecraft 343 | docker pull karlrees/docker_bedrockserver 344 | ``` 345 | 346 | Then use whatever docker run command you used to run the container. 347 | 348 | ### If you are building the docker image yourself (e.g. multiple world, pulling the source from GitHub) 349 | 350 | #### Standalone server 351 | 352 | If you used the `setup_standalone` script, just re-run it (ignoring any errors about directories that already exist). 353 | 354 | Otherise, use the following commands, where `~/docker_bedrockserver` is the location where you downloaded the source files: 355 | 356 | ``` 357 | cd ~/docker_bedrockserver 358 | docker stop minecraft 359 | docker rm minecraft 360 | git pull 361 | docker build -t karlrees/docker_bedrockserver . 362 | docker run -dit --name="minecraft" --network="host" -v /path/to/mcdata:/mcdata karlrees/docker_bedrockserver 363 | ``` 364 | 365 | #### Multi-world with docker-compose 366 | 367 | Use the following commands, where `~/docker_bedrockserver` is the location where you downloaded the source files: 368 | 369 | ``` 370 | cd ~/docker_bedrockserver 371 | docker-compose down 372 | git pull 373 | docker-compose build 374 | docker-compose up -d 375 | ``` 376 | 377 | ## Changing the user the server runs under 378 | 379 | By default, the server runs within the container under user 1132 and group 1132. You can change these by setting the `MCUSER` and `MCGROUP` environment build arguments. (Depending on what you choose, you may need to reset the permissions on your `mcdata` folder to match -- *see* Step 3 of [Option B](#option-b-single-world-manual-setup)). 380 | 381 | If you are using the docker-compose approach, all you need to do is change these values in the `.env` file. 382 | 383 | Otherwise, you will need to download and build the docker image yourself. You would do this *instead* of pulling the docker image. For instance, to build under user id 1000 and group id 1000: 384 | 385 | ``` 386 | git clone https://github.com/karlrees/docker_bedrockserver 387 | cd docker_bedrockserver 388 | docker build --build-arg MCUSER=1000 --build-arg MCGROUP=1000 -t karlrees/docker_bedrockserver . 389 | ``` 390 | 391 | *Be sure to use a numeric id, not a display name like root or user.* 392 | 393 | ## Using a MacOS host 394 | 395 | *Thanks to @Shawnfreebern for these instructions.* 396 | 397 | According to docker docs: 398 | 399 | > The host networking driver only works on Linux hosts, and is not supported on Docker Desktop for Mac ... 400 | 401 | The result is that you have to specify which ports to publish on MacOS. For a remote server you can (possibly) get away with publishing only your chosen server port (19132) but for LAN games minecraft opens a second randomly chosen port which you need to publish, but can't because you don't know the number when you start the container. 402 | 403 | Docker has a `--publish-all` function but it doesn't seem to work: 404 | 405 | it appears to only publish ports opened early in the container start process, and the LAN port is opened a bit later both TCP and UDP are required and it looks like `--publish-all` doesn't get that done it assigns known ports to randomly selected higher ports, which further complicates remote server access My solution at present is to artificially limit which random ports are available, and then specifically publish all port options for both TCP and UDP: 406 | 407 | ``` 408 | docker run --sysctl net.ipv4.ip_local_port_range="39132 39133" -p 19132:19132 -p 19132:19132/udp -p 39132:39132 -p 39132:39132/udp -p 39133:39133 -p 39133:39133/udp --name="minecraft" etc 409 | ``` 410 | Someone will hopefully find a better way to do this (I am not a docker, minecraft, or mac networking expert) but until that's discovered this might be helpful to other mac users. 411 | 412 | ## Using a Windows host 413 | 414 | The above instructions assume you are running on a Linux-based host. You can also run the containers on a Windows-based host. However, because of differences in how Windows-based hosts handle networking, you won't by default have access to the servers on your LAN. 415 | 416 | You *may* be able to get access to the servers on your LAN, if you bridge the Windows docker network with your LAN and/or set up port forwarding. These are not tasks for the faint-hearted, and I make no attempt to describe them here. 417 | 418 | ## Troubleshooting 419 | 420 | ### The server says that it cannot open the port. 421 | 422 | This could be one of two things. First, the obvious issue could be that you are running two servers over the same network interface. If this is your problem, use the docker-compose solution, and give each server a separate IP address. 423 | 424 | Second, I've seen this error when there is a permission problem with some or all of the resource files when you are mounting an external volume to the `mcdata` folder. The solution is to make sure that the user id (the specific number--e.g. 1132) of all of your files is the same as being used in the container. See above. 425 | 426 | ## Updating from pre-1.13.1 versions 427 | 428 | If you have problems after updating to a 1.13.1 image or higher, it is most likely related to permissions. A quick and dirty solution may be to go into your worlds volume and run either `chmod -R 777 *`, or `chown -R 1132:1132 *`. An even more quick and dirty solution would be to run the legacy branch instead. For instance: 429 | 430 | ``` 431 | docker pull karlrees/docker_bedrockserver:legacy 432 | docker run -dit --name="minecraft" --network="host" karlrees/docker_bedrockserver:legacy 433 | ``` 434 | 435 | Of course, the most preferred solution (and most likely to be supported going forward) would be to start mounting the mcdata volume instead of the worlds folder, as described elsewehere herein. 436 | 437 | A few changes in the update that you may or may not need to be aware of: 438 | 439 | ### Changed mount point 440 | 441 | Prior to version 1.13.1, the recommended installation procedure was to mount directly to the `srv/bedrockserver/worlds` folder. We now recommend mounting to the `/mcdata` folder, which should be up one level from your `worlds` folder. See the instructions above and the new DockerFile. 442 | 443 | ### Changed user id 444 | 445 | We were previously running the server within the container as root. We have changed to user id to 1132. You may need to change the permissions on your shared `mcdata/worlds` folder to access them, and/or change the user id under which the container is running (see above). 446 | 447 | ### Docker-compose.yml changes 448 | 449 | If you were using the `docker-compose.yml` file before, we have changed the `docker-compose.yml` file somewhat. You should probably save your previous version as a reference, download the new version, and readjust the new version to match the changes you made to your previous version. 450 | 451 | Note that `docker-compose.yml` no longer exists in the repository. The expectation is that users will copy the `/templates/docker-compose.yml` to `docker-compose.yml`, either manually or via the `setup_multi.sh` script. 452 | 453 | ### Changed .env file usage 454 | 455 | Before, certain environment varaibles such as the installer URL were always being set from the `.env` file, which made the defaults in `docker-compose.yml` and the `DockerFile` kind of pointless. I have commented out these values in the new `.env` file. Going forward, I suggest you use the `.env` file only if you want to override the default `docker-compose.yml` or `DockerFile` value. 456 | 457 | Also, git is now configured to ignore the `.env` file (and `docker-compose.yml`), so that you can update the project in the future without losing your settings. 458 | 459 | ## Contributors 460 | 461 | - @karlrees - original author and maintainer 462 | - @ParFlesh - the guy who actually knows his way around Linux 463 | - @eithe - Got the ball rolling on auto-updates 464 | 465 | Additional contributions from: @Shawnfreebern, @rsnodgrass, @RemcoHulshof, @tsingletonacic, and probably others I lost track of. Thanks! 466 | -------------------------------------------------------------------------------- /experimental/setup_multi.bat: -------------------------------------------------------------------------------- 1 | echo off 2 | 3 | REM ########################################### 4 | REM # 5 | REM # Setup script for docker bedrock_server 6 | REM # Multiple server / Docker-Compose version 7 | REM # 8 | REM # May need to run under Administrator 9 | REM # Also, be sure to install docker and docker-compose 10 | REM # 11 | REM ########################################### 12 | 13 | cd .. 14 | 15 | echo. 16 | echo ----------------------------------------------------------------- 17 | echo Docker Bedrock Server Multi-Server Setup script 18 | echo ----------------------------------------------------------------- 19 | echo This script copies the example files to the appropriate locations to start running multiple bedrock server containers using docker-compose with externally mounted data. 20 | echo. 21 | 22 | 23 | REM Copy ENV file 24 | if not exist .env ( 25 | copy /Y templates\.env .env 26 | call :FindReplace "# MCVOLUME" "MCVOLUME" .env 27 | call :FindReplace "/opt/minecraft/server/mcdata" "%CD%\mcdata" .env 28 | ) else ( 29 | echo ------------------------------------------------------------------ 30 | echo WARNING: The .env file already exists. To avoid inadvertently losing your changes, this script will not overwrite it. Please edit .env manually, or delete .env and run this script again. 31 | echo ------------------------------------------------------------------ 32 | ) 33 | 34 | REM Copy Docker Compose file 35 | if not exist docker-compose.yml ( 36 | copy /Y templates\docker-compose.yml docker-compose.yml 37 | ) else ( 38 | echo ------------------------------------------------------------------ 39 | echo WARNING: The docker-compose.yml file already exists. To avoid inadvertently losing your changes, this script will not overwrite it. Please edit docker-compose.yml manually, or delete docker-compose.yml and run this script again. 40 | echo ------------------------------------------------------------------ 41 | ) 42 | 43 | REM Copy MCDATA example world and set permissions 44 | if not exist mcdata/world.server.properties ( 45 | xcopy /Y /E templates\mcdata\* mcdata\ 46 | ) else ( 47 | echo ------------------------------------------------------------------ 48 | echo WARNING: The example server properties in mcdata is already found. To avoid inadvertently losing your data, this script will not overwrite it. Please delete it if you want to overwrite it. 49 | echo ------------------------------------------------------------------ 50 | ) 51 | 52 | echo. 53 | echo Everything is now in place to run the docker bedrock servers 54 | echo ------------------------------------------------------------------ 55 | echo. 56 | echo To start the servers: 57 | echo cd %CD% 58 | echo docker-compose up 59 | echo. 60 | echo To stop the servers: 61 | echo cd %CD% 62 | echo docker-compose down 63 | echo. 64 | echo !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! 65 | echo IMPORTANT: Although you can use docker-compose to run multiple Bedrock containers/servers on a Windows host, the default macvlan network driver it uses does not work in the same way it works on a Linux-based host. Thus you will not by default have access to the servers on your LAN. You will need to figure out how to bridge the network yourself, or switch to a Linux-based host for multiple servers. 66 | echo !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! 67 | echo. 68 | echo To configure your own servers, edit the docker-compose.yml file. See the README file for more information.See the README file for advanced configuration information. 69 | 70 | exit /b 71 | 72 | 73 | :FindReplace 74 | set tmp="%temp%\tmp.txt" 75 | If not exist %temp%\_.vbs call :MakeReplace 76 | for /f "tokens=*" %%a in ('dir "%3" /b /a-d /on') do ( 77 | for /f "usebackq" %%b in (`Findstr /mic:"%~1" "%%a"`) do ( 78 | echo(&Echo Replacing "%~1" with "%~2" in file %%~nxa 79 | <%%a cscript //nologo %temp%\_.vbs "%~1" "%~2">%tmp% 80 | if exist %tmp% move /Y %tmp% "%%~dpnxa">nul 81 | ) 82 | ) 83 | del %temp%\_.vbs 84 | exit /b 85 | 86 | :MakeReplace 87 | >%temp%\_.vbs echo with Wscript 88 | >>%temp%\_.vbs echo set args=.arguments 89 | >>%temp%\_.vbs echo .StdOut.Write _ 90 | >>%temp%\_.vbs echo Replace(.StdIn.ReadAll,args(0),args(1),1,-1,1) 91 | >>%temp%\_.vbs echo end with -------------------------------------------------------------------------------- /experimental/setup_standalone.bat: -------------------------------------------------------------------------------- 1 | echo off 2 | 3 | REM ########################################### 4 | REM # 5 | REM # Setup script for docker bedrock_server 6 | REM # Single server version 7 | REM # 8 | REM # May need to run under Administrator 9 | REM # Also, be sure to install docker 10 | REM # 11 | REM ########################################### 12 | 13 | 14 | cd .. 15 | 16 | echo. 17 | echo ----------------------------------------------------------------- 18 | echo Docker Bedrock Server Single-Server Setup script 19 | echo ----------------------------------------------------------------- 20 | echo This script copies the example files to the appropriate locations to start running the bedrock server container with an externally mounted mcdata folder. 21 | echo. 22 | 23 | 24 | REM Copy MCDATA example world and set permissions 25 | if not exist mcdata/world.server.properties ( 26 | xcopy /Y /E templates\mcdata\* mcdata\ 27 | ) else ( 28 | echo ------------------------------------------------------------------ 29 | echo WARNING: The example server properties in mcdata is already found. To avoid inadvertently losing your data, this script will not overwrite it. Please delete it if you want to overwrite it. 30 | echo ------------------------------------------------------------------ 31 | ) 32 | 33 | 34 | REM Stop/delete container 35 | echo. 36 | echo Stopping and removing container, if it already exists ... 37 | docker stop minecraft 1>NUL 2>NUL 38 | docker rm minecraft 1>NUL 2>NUL 39 | 40 | REM Building image 41 | echo. 42 | echo Building image ... 43 | docker build -t karlrees/docker_bedrockserver . 44 | 45 | 46 | REM Starting container 47 | echo . 48 | echo Starting container ... 49 | docker run -dit --name="minecraft" --network="host" -v %CD%\mcdata:/mcdata karlrees/docker_bedrockserver 50 | 51 | 52 | echo The Docker Bedrock Server shoud be set up and running. 53 | echo ------------------------------------------------------------------ 54 | echo. 55 | echo To stop the server: 56 | echo docker stop minecraft 57 | echo. 58 | echo To start the server: 59 | echo docker start minecraft 60 | echo . 61 | echo !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! 62 | echo IMPORTANT: Although you can use this DockerFile to run a Bedrock server on a Windows host, the default host network driver it uses does not work the same way as it would on a Linux-based host. Thus you will not by default have access to the Bedrock server on your LAN. You will need to figure out how to bridge the Docker host network yourself, or switch to a Linux host. 63 | echo !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! 64 | echo. 65 | echo The mcdata/world.server.properties file may be used to configure the server. See the README file for advanced configuration information. 66 | -------------------------------------------------------------------------------- /mcdata/.gitignore: -------------------------------------------------------------------------------- 1 | * 2 | !.gitignore 3 | -------------------------------------------------------------------------------- /resource/installbedrockserver.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | ########################################### 4 | # 5 | # Install script for bedrock_server 6 | # 7 | # This script is intended to be copied to and run 8 | # from within the docker container only 9 | # 10 | ########################################### 11 | 12 | if [ -n "$1" ] 13 | then 14 | curl $INSTALLERBASE$1.zip --output $MCSERVERFOLDER/mc.zip && \ 15 | unzip -o $MCSERVERFOLDER/mc.zip -d $MCSERVERFOLDER && \ 16 | rm $MCSERVERFOLDER/mc.zip && \ 17 | echo $1 > $MCSERVERFOLDER/.CURRENTVERSION && \ 18 | rm -rf $MCSERVERFOLDER/default/* && \ 19 | rm $MCSERVERFOLDER/server.properties && \ 20 | for i in permissions.json allowlist.json behavior_packs definitions resource_packs;do mv $MCSERVERFOLDER/$i $MCSERVERFOLDER/default/$i;done 21 | else 22 | echo -e "No version specified. Please specify version. E.g.\n\n\tinstallbedrockserver.sh 1.14.0.9" 23 | fi 24 | 25 | 26 | -------------------------------------------------------------------------------- /resource/runbedrockserver.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | ########################################### 4 | # 5 | # Startup script for bedrock_server 6 | # 7 | # This script is intended to be copied to and run 8 | # from within the docker container only 9 | # 10 | ########################################### 11 | 12 | file_lookup () { 13 | LOOKUP_FILE=$1 14 | if [ -e "${MCSERVERFOLDER}/worlds/${WORLD}/${LOOKUP_FILE}" ] 15 | then 16 | echo "${MCSERVERFOLDER}/worlds/${WORLD}/${LOOKUP_FILE}" 17 | elif [ -e "${MCSERVERFOLDER}/worlds/${WORLD}.properties" ] && [ ${LOOKUP_FILE} = "server.properties" ] 18 | then 19 | echo "${MCSERVERFOLDER}/worlds/${WORLD}.properties" 20 | elif [ -e "${MCVOLUME}/worlds/${WORLD}/${LOOKUP_FILE}" ] 21 | then 22 | echo "${MCVOLUME}/worlds/${WORLD}/${LOOKUP_FILE}" 23 | elif [ -e "${MCVOLUME}/${WORLD}.${LOOKUP_FILE}" ] 24 | then 25 | echo "${MCVOLUME}/${WORLD}.${LOOKUP_FILE}" 26 | elif [ -e "${MCVOLUME}/worlds/${WORLD}.${LOOKUP_FILE}" ] 27 | then 28 | echo "${MCVOLUME}/worlds/${WORLD}.${LOOKUP_FILE}" 29 | elif [ -e "${MCVOLUME}/worlds/${WORLD}.properties" ] && [ ${LOOKUP_FILE} = "server.properties" ] 30 | then 31 | echo "${MCVOLUME}/worlds/${WORLD}.properties" 32 | else 33 | echo "${MCVOLUME}/${LOOKUP_FILE}" 34 | fi 35 | } 36 | 37 | echo -e "Minecraft Bedrock Server startup script" 38 | echo -e "---------------------------------------\n\n" 39 | 40 | #update check 41 | if [ -e ${MCSERVERFOLDER}/.AUTOUPDATE ] 42 | then 43 | ${MCSERVERFOLDER}/updatebedrockserver.sh 44 | else 45 | echo -e "Automatic updates are disabled." 46 | fi 47 | 48 | 49 | #previous version check 50 | if [[ -d "${MCSERVERFOLDER}/worlds" && ! -L "${MCSERVERFOLDER}/worlds" ]] 51 | then 52 | echo -e "WARNING: This image may not work correctly, since an existing worlds folder was detected in ${MCSERVERFOLDER}. This may be because you have upgraded from a pre-1.13.1 version of the docker image. If you have problems, you can try: a) mounting the parent directory in which your worlds data is stored to /mcdata (preferred going forward, see README); b) 'chmod -R 777 *' in your worlds volume, or 'chown -R ${MCUSER}:${MCGROUP} *'; and/or c) running the karlrees/docker_bedrockserver:legacy image." 53 | if [[ "${WORLD}" == "world" && -e "${MCSERVERFOLDER}/worlds/default" && ! -e "${MCSERVERFOLDER}/worlds/world" ]] 54 | then 55 | export WORLD="default" 56 | fi 57 | fi 58 | 59 | 60 | echo "LINKING MINECRAFT DATA ..." 61 | 62 | # remove any existing server.properties file or link from MCSERVERFOLDER 63 | if [ -f ${MCSERVERFOLDER}/server.properties ] || [ -L ${MCSERVERFOLDER}/server.properties ] 64 | then 65 | rm -f -- ${MCSERVERFOLDER}/server.properties 66 | fi 67 | # If file lookup finds existing server.properties file, link to that 68 | SERVER_FILE=`file_lookup "server.properties"` 69 | if [ -f ${SERVER_FILE} ] 70 | then 71 | ln -s ${SERVER_FILE} ${MCSERVERFOLDER}/server.properties 72 | echo "Using server config from: ${SERVER_FILE}" 73 | else 74 | echo "Generating server configuration:" 75 | # create base for server.properties 76 | echo -e "server-port=${MCPORT}\nlevel-name=${WORLD}" > ${MCSERVERFOLDER}/server.properties 77 | echo -e "\tserver-port=${MCPORT}\n\tlevel-name=${WORLD}" 78 | # Parse all environment variables beginning with MCPROP to generate server.properties 79 | # For each matching line 80 | # - Get property name from beggining to first = sign 81 | # - Remove MCPROP_ from beginning 82 | # - Switch to lowercase 83 | # - Convert _ to - 84 | # - Get property value from everything after first = sign 85 | # Examples 86 | # - MCPROP_ALLOW_CHEATS=true 87 | # allow-cheats=true 88 | SAVEIFS="$IFS" 89 | IFS=$'\n' 90 | for P in `printenv | grep '^MCPROP_'` 91 | do 92 | PROP_NAME=${P%%=*} 93 | PROP_VALUE=${P##${PROP_NAME}=} 94 | PROP_NAME=${PROP_NAME#*_} 95 | PROP_NAME=`echo ${PROP_NAME} | tr '[:upper:]' '[:lower:]'` 96 | PROP_NAME=`echo ${PROP_NAME} | tr "_" "-"` 97 | echo -e "\t${PROP_NAME}=${PROP_VALUE}" 98 | echo "${PROP_NAME}=${PROP_VALUE}" >> ${MCSERVERFOLDER}/server.properties 99 | done 100 | IFS="$SAVEIFS" 101 | fi 102 | 103 | # Link/create files 104 | for f in permissions.json allowlist.json Debug_Log.txt valid_known_packs.json 105 | do 106 | LOOKUP_FILE=`file_lookup "${f}"` 107 | # If file doesn't exist create from minecraft default 108 | if ! [ -f "${LOOKUP_FILE}" ] 109 | then 110 | if [ -f ${MCSERVERFOLDER}/default/${f} ] 111 | then 112 | cp ${MCSERVERFOLDER}/default/${f} ${LOOKUP_FILE} 113 | else 114 | # if default file doesn't exist create empty 115 | touch ${LOOKUP_FILE} 116 | fi 117 | fi 118 | # (re)link file 119 | if [ -L ${MCSERVERFOLDER}/${f} ] 120 | then 121 | rm -f -- ${MCSERVERFOLDER}/${f} 122 | fi 123 | if [ ! -f ${MCSERVERFOLDER}/${f} ] 124 | then 125 | ln -s ${LOOKUP_FILE} ${MCSERVERFOLDER}/${f} 126 | fi 127 | done 128 | 129 | # Link/create directories 130 | for f in behavior_packs definitions resource_packs structures worlds development_behavior_packs development_resource_packs premium_cache treatments world_templates 131 | do 132 | LOOKUP_FILE=`file_lookup "${f}"` 133 | # if directory doesn't exist create from minecraft default 134 | if ! [ -d "${LOOKUP_FILE}" ] 135 | then 136 | if [ -d ${MCSERVERFOLDER}/default/${f} ] 137 | then 138 | cp -a ${MCSERVERFOLDER}/default/${f} ${LOOKUP_FILE} 139 | else 140 | # if default directory doesn't exist create empty 141 | mkdir ${LOOKUP_FILE} 142 | chmod g=u ${LOOKUP_FILE} 143 | fi 144 | fi 145 | # (re)link directory 146 | if [ -L ${MCSERVERFOLDER}/${f} ] 147 | then 148 | rm -f -- ${MCSERVERFOLDER}/${f} 149 | fi 150 | if [ ! -d ${MCSERVERFOLDER}/${f} ] 151 | then 152 | ln -s ${LOOKUP_FILE} ${MCSERVERFOLDER}/${f} 153 | fi 154 | done 155 | 156 | # if world folder does not exist, create it 157 | if [ ! -d "${MCSERVERFOLDER}/worlds/${WORLD}" ] 158 | then 159 | mkdir -p -- "${MCSERVERFOLDER}/worlds/${WORLD}" 160 | fi 161 | 162 | 163 | echo "STARTING BEDROCKSERVER: ${WORLD} on ${HOSTNAME}:${MCPORT} ..." 164 | 165 | if ! [ -e "/tmp/mc-input" ] 166 | then 167 | mkfifo /tmp/mc-input 168 | fi 169 | 170 | MC_INPUT_PID=$! 171 | 172 | ########### SIG handler ############ 173 | function _int() { 174 | echo "Stopping container." 175 | echo "SIGINT received, shutting down server!" 176 | echo -e "stop\n" > /tmp/mc-input 177 | while grep ^bedrock_server /proc/*/cmdline > /dev/null 2>&1 178 | do 179 | sleep 1 180 | done 181 | exit 0 182 | } 183 | 184 | # Set SIGINT handler 185 | trap _int SIGINT 186 | 187 | # Set SIGTERM handler 188 | trap _int SIGTERM 189 | 190 | # Set SIGKILL handler 191 | trap _int SIGKILL 192 | 193 | # cd to bin folder and exec to bedrock_server 194 | cd /${MCSERVERFOLDER}/ 195 | chmod +x bedrock_server 196 | LD_LIBRARY_PATH=. tail -f /tmp/mc-input | bedrock_server & 197 | childPID=$! 198 | while read line 199 | do 200 | echo "$line" > /tmp/mc-input 201 | done < /dev/stdin & 202 | wait $childPID 203 | -------------------------------------------------------------------------------- /resource/updatebedrockserver.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | ########################################### 4 | # 5 | # Update script for bedrock_server 6 | # 7 | # This script is intended to be copied to and run 8 | # from within the docker container only 9 | # 10 | ########################################### 11 | 12 | USER_AGENT="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_5) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/85 Version/11.1.1 Safari/605.1.15" 13 | 14 | if [ -n "$1" ] 15 | then 16 | INSTALL_VERSION=$1 17 | else 18 | LATEST_VERSION=$( \ 19 | curl -A "$USER_AGENT" -v --silent https://www.minecraft.net/en-us/download/server/bedrock 2>&1 | \ 20 | grep -o 'https://minecraft.azureedge.net/bin-linux/[^"]*' | \ 21 | sed 's#.*/bedrock-server-##' | sed 's/.zip//') && \ 22 | echo "Latest VERSION is $LATEST_VERSION" && \ 23 | INSTALL_VERSION=$LATEST_VERSION 24 | fi 25 | 26 | CURRENT_VERSION=$(<$MCSERVERFOLDER/.CURRENTVERSION) 27 | echo "Currently installed server version is: $CURRENT_VERSION" 28 | 29 | if [ "$CURRENT_VERSION" != "$INSTALL_VERSION" ] 30 | then 31 | echo "Attempting to install VERSION $INSTALL_VERSION" && \ 32 | $MCSERVERFOLDER/installbedrockserver.sh $INSTALL_VERSION && \ 33 | echo -e "Server updated. If the server is already running, restart the container to apply the update." 34 | #echo "quit\n" > /tmp/mc-input 35 | else 36 | echo "Server is already $INSTALL_VERSION." 37 | fi 38 | 39 | 40 | -------------------------------------------------------------------------------- /setup_multi.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | ########################################### 4 | # 5 | # Setup script for docker bedrock_server 6 | # Multiple server / Docker-Compose version 7 | # 8 | # May need to run under sudo 9 | # Also, be sure to install docker and docker-compose 10 | # 11 | ########################################### 12 | 13 | 14 | echo -e "\n\n------------------------------------------------------------------\nDocker Bedrock Server Multi-Server Setup script\n------------------------------------------------------------------\n" 15 | echo -e "This script copies the example files to the appropriate locations to start running multiple bedrock server containers using docker-compose with externally mounted data.\n" 16 | 17 | R=`realpath .` 18 | 19 | # Copy ENV file 20 | if ! [ -f .env ] 21 | then 22 | cp templates/.env .env 23 | 24 | # Insert absolute path of MCDATA folder and default network interface info 25 | I=`ip route | grep default | sed -e "s/^.*dev.//" -e "s/.proto.*//"` 26 | sed -i -e "s|.*NETWORKINTERFACE\=.*|NETWORKINTERFACE\=${I}|g" .env 27 | I=`ip route | grep default | sed -e "s/^.*via.//" -e "s/\.[0-9][0-9]*.dev.*//"` 28 | sed -i -e "s|.*IPPREFIX\=.*|IPPREFIX\=${I}|g" .env 29 | sed -i -e "s|.*MCVOLUME\=.*|MCVOLUME\=${R}/mcdata|g" .env 30 | else 31 | echo -e "------------------------------------------------------------------\nWARNING: The .env file already exists. To avoid inadvertently \nlosing your changes, this script will not overwrite \nit. Please edit it manually, or delete .env and run this script again.\n------------------------------------------------------------------\n" 32 | fi 33 | 34 | 35 | # Copy Docker Compose file 36 | if ! [ -f docker-compose.yml ] 37 | then 38 | cp templates/docker-compose.yml docker-compose.yml 39 | else 40 | echo -e "------------------------------------------------------------------\nWARNING: The docker-compose.yml file already exists. To avoid \ninadvertently losing your changes, this script will not overwrite it.\nPlease edit docker-compose.yml manually, or delete docker-compose.yml and run this script again.\n------------------------------------------------------------------\n" 41 | fi 42 | 43 | 44 | # Copy MCDATA example world and set permissions 45 | if ! [ -f mcdata/world.server.properties ] 46 | then 47 | cp -R templates/mcdata/* mcdata/ 48 | chmod -R 777 mcdata 49 | else 50 | echo -e "------------------------------------------------------------------\nWARNING: The example server properties in mcdata is already found.\nTo avoid inadvertently losing your data, this script will not \noverwrite it. Please delete it if you want to overwrite it.\n------------------------------------------------------------------\n" 51 | fi 52 | 53 | 54 | 55 | echo -e "\nEverything is now in place to run the docker bedrock servers.\n------------------------------------------------------------------\n" 56 | echo -e "To start the servers:\n\n cd ${R}\n docker-compose up -d\n\n\nTo stop the servers:\n\n cd ${R}\n docker-compose down\n\n\nTo configure your own servers, edit the docker-compose.yml file. See the README file for more information.\n\n" 57 | -------------------------------------------------------------------------------- /setup_standalone.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | ########################################### 4 | # 5 | # Setup script for docker bedrock_server 6 | # Single server version 7 | # 8 | # May need to run under sudo 9 | # Also, be sure to install docker 10 | # 11 | ########################################### 12 | 13 | 14 | echo -e "\n\n-----------------------------------------------------------------\nDocker Bedrock Server Single-Server Setup script\n-----------------------------------------------------------------" 15 | echo -e "\nThis script copies the example files to the appropriate locations to start running the\ 16 | bedrock server container with an externally mounted mcdata folder.\n" 17 | 18 | 19 | # Copy MCDATA example world and set permissions 20 | if ! [ -f mcdata/world.server.properties ] 21 | then 22 | cp -R templates/mcdata/* mcdata/ 23 | chmod -R 777 mcdata 24 | else 25 | echo -e "------------------------------------------------------------------\nWARNING: The example server properties in mcdata is already found.\nTo avoid inadvertently losing your data, this script will not\noverwrite it. Please delete it if you want to overwrite it.\n------------------------------------------------------------------\n" 26 | fi 27 | 28 | # Stopping and removing container 29 | echo "Stopping and removing container, if it already exists ..." 30 | docker stop minecraft >/dev/null 2>&1 31 | docker rm minecraft >/dev/null 2>&1 32 | 33 | # Building image 34 | echo -e "Building image ..." 35 | docker build -t karlrees/docker_bedrockserver . 36 | 37 | # Starting container 38 | echo -e "Starting container ..." 39 | I=`realpath mcdata` 40 | docker run -dit --name='minecraft' --network='host' -v ${I}:/mcdata karlrees/docker_bedrockserver 41 | 42 | 43 | echo -e "\nThe Docker Bedrock Server shoud be set up and running.\n------------------------------------------------------------------\n" 44 | echo -e "To stop the server:\n\n docker stop minecraft\n\n\nTo start the server:\n\n docker start minecraft\n\n\nThe mcdata/world.server.properties file may be used to configure the server. See the README file for advanced configuration information.\n\n" 45 | 46 | exit 1 47 | -------------------------------------------------------------------------------- /templates/.env: -------------------------------------------------------------------------------- 1 | ################################################### 2 | # 3 | # Docker Bedrock Server 4 | # Environment overrides 5 | # 6 | # Uncomment the appropriate line below to override the default values in docker-compose 7 | # 8 | ################################################### 9 | 10 | 11 | #-------------------------------------------------- 12 | # Docker image name 13 | #-------------------------------------------------- 14 | 15 | # DOCKERIMAGENAME=karlrees/docker_bedrockserver 16 | 17 | 18 | #-------------------------------------------------- 19 | # installer URL 20 | #-------------------------------------------------- 21 | 22 | # INSTALLERBASE=https://minecraft.azureedge.net/bin-linux/bedrock-server- 23 | # VERSION=1.17.10.04 24 | 25 | 26 | #-------------------------------------------------- 27 | # Container user and group to run minecraft server 28 | # Needs to be a number, not an account name! 29 | #-------------------------------------------------- 30 | 31 | # MCUSER=1132 32 | # MCGROUP=1132 33 | 34 | 35 | #-------------------------------------------------- 36 | # Host folder where minecraft data is found (e.g. worlds folder, etc) 37 | #-------------------------------------------------- 38 | 39 | # MCVOLUME=/opt/minecraft/server/mcdata 40 | 41 | 42 | #-------------------------------------------------- 43 | # network interface 44 | #-------------------------------------------------- 45 | 46 | # NETWORKINTERFACE=eth0 47 | 48 | 49 | #-------------------------------------------------- 50 | # First 24 bits of subnet 51 | #-------------------------------------------------- 52 | 53 | # IPPREFIX=192.168.0 54 | 55 | 56 | #-------------------------------------------------- 57 | # Uncomment to Disable Auto-Updates 58 | #-------------------------------------------------- 59 | # AUTOUPDATE=0 60 | 61 | 62 | 63 | -------------------------------------------------------------------------------- /templates/docker-compose.yml: -------------------------------------------------------------------------------- 1 | ################################################################# 2 | # Docker Compose file for MineCraft Bedrock Server 3 | # 4 | # The top section is common to all servers 5 | # Continue to the services section to define your own servers 6 | ################################################################# 7 | 8 | version: '3.4' 9 | 10 | x-mcserver-common: 11 | &default-mcserver 12 | build: 13 | context: . 14 | args: 15 | INSTALLERBASE: ${INSTALLERBASE:-} 16 | VERSION: ${VERSION:-} 17 | MCUSER: ${MCUSER:-} 18 | MCGROUP: ${MCGROUP:-} 19 | MCPORT: ${MCPORT:-} 20 | AUTOUPDATE: ${AUTOUPDATE:-} 21 | volumes: 22 | - ${MCVOLUME:-./mcdata}:/mcdata 23 | restart: unless-stopped 24 | stdin_open: true 25 | tty: true 26 | 27 | networks: 28 | default: 29 | driver: macvlan 30 | driver_opts: 31 | parent: ${NETWORKINTERFACE:-eth0} 32 | ipam: 33 | config: 34 | - subnet: ${IPPREFIX:-192.168.0}.0/24 35 | 36 | 37 | 38 | ################################################################# 39 | # Define your MineCraft servers here 40 | # 41 | # For each server, copy and paste one of the example servers. 42 | ################################################################# 43 | 44 | services: 45 | 46 | #---------------------------------------- 47 | # First Server 48 | #---------------------------------------- 49 | 50 | minecraft1: 51 | << : *default-mcserver 52 | environment: 53 | # Be sure to use a unique name for the world 54 | WORLD: minecraft1 55 | # Example server properties that are available for configuration. 56 | # These should all be prepended with "MCPROP_". 57 | #MCPROP_SERVER-NAME: "First Minecraft Server" 58 | #MCPROP_GAMEMODE: 1 # 0 is survival, 1 is creative, 2 is adventure 59 | #MCPROP_DIFFICULTY: 1 # 0 is peaceful, 1 is easy, 2 is normal, 3 is hard 60 | #MCPROP_ALLOW-CHEATS: "false" 61 | #MCPROP_LEVEL-SEED: "myseed1" # only used if world does not yet exist 62 | container_name: minecraft1 63 | networks: 64 | default: 65 | # Be sure the last three digits of IP address is unique 66 | ipv4_address: ${IPPREFIX:-192.168.0}.201 67 | 68 | 69 | #---------------------------------------- 70 | # Second Server 71 | #---------------------------------------- 72 | 73 | minecraft2: 74 | << : *default-mcserver 75 | environment: 76 | # Be sure to use a unique name for the world 77 | WORLD: minecraft2 78 | # Example server properties that are available for configuration. 79 | # These should all be prepended with "MCPROP_". 80 | #MCPROP_SERVER-NAME: "Second Minecraft Server" 81 | #MCPROP_GAMEMODE: 0 # 0 is survival, 1 is creative, 2 is adventure 82 | #MCPROP_DIFFICULTY: 1 # 0 is peaceful, 1 is easy, 2 is normal, 3 is hard 83 | #MCPROP_ALLOW-CHEATS: "false" 84 | #MCPROP_LEVEL-SEED: "myseed2" # only used if world does not yet exist 85 | container_name: minecraft2 86 | networks: 87 | default: 88 | # Be sure the last three digits of IP address is unique 89 | ipv4_address: ${IPPREFIX:-192.168.0}.202 90 | 91 | 92 | -------------------------------------------------------------------------------- /templates/mcdata/world.permissions.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "permission": "operator", 4 | "xuid": "" 5 | } 6 | ] 7 | -------------------------------------------------------------------------------- /templates/mcdata/world.server.properties: -------------------------------------------------------------------------------- 1 | server-name=My Server 2 | gamemode=survival 3 | difficulty=easy 4 | allow-cheats=false 5 | max-players=20 6 | online-mode=true 7 | white-list=false 8 | server-port=19132 9 | server-portv6=19133 10 | view-distance=22 11 | tick-distance=4 12 | player-idle-timeout=30 13 | max-threads=8 14 | level-name=world 15 | -------------------------------------------------------------------------------- /templates/mcdata/world.whitelist.json: -------------------------------------------------------------------------------- 1 | [] 2 | -------------------------------------------------------------------------------- /templates/mcdata/worlds/world/COPY_WORLD_DATA_HERE: -------------------------------------------------------------------------------- 1 | 2 | --------------------------------------------------------------------------------