This commit is contained in:
2023-06-29 20:45:54 +02:00
parent d170f585a5
commit 61103a1caf
2 changed files with 79 additions and 0 deletions

29
LICENSE Normal file
View File

@@ -0,0 +1,29 @@
BSD 3-Clause License
Copyright (c) 2023, Matthias Berner <mattes.b@gmx.net
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

50
README.md Normal file
View File

@@ -0,0 +1,50 @@
## Status
[![pipeline status](https://gitlab.com/bastillebsd-templates/minecraft-server/badges/master/pipeline.svg)](https://gitlab.com/bastillebsd-templates/minecraft-server/commits/master)
## minecraft-server
Bastille template for a minecraft server.
Note: by installing this template you agree to the terms of the [Minecraft EULA](https://aka.ms/MinecraftEULA).
This template includes the `eula=true` acceptance and `LICENSES_ACCEPTED+= minecraft`
settings. If you cannot abide the terms of the Minecraft EULA *do not* apply this template.
### requirements
Due to license restrictions (see above Minecraft EULA), redistribution of
Minecraft server is prohibited. This means you must build the package manually
from the FreeBSD ports tree.
This template will automate all the build steps but depends on `/usr/ports`
existing on the host system.
To install (or update) `/usr/ports` on the host system use `portsnap` as seen here:
```shell
ishmael ~ # portsnap fetch auto
```
Note: the ports tree is mounted read-only within the container.
## Bootstrap template
```shell
ishmael ~ # bastille bootstrap https://gitlab.com/bastillebsd-templates/minecraft-server
```
## Apply template
```shell
ishmael ~ # bastille template TARGET bastillebsd-templates/minecraft-server
```
## Access server console
The minecraft server will run in `STANDALONE` mode meaning the service execution
will happen within a `tmux` session. To access this session use this command:
```shell
ishmael ~ # bastille service TARGET minecraft console
```
Tip: `tmux` session management is handled using `ctrl-b` prefix. To exit the
session press `ctrl-b d`.