Minecraft-bedrock/README.md

1.3 KiB

Project Title

Docker bedrock server

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

The things you need before installing the software.

  • A working docker host with git and docker-compose pre installed
  • port forwarding if your host is behind a router or firewall

Installation

A step by step guide that will tell you how to get the development environment up and running.

$ mkdir yourservername && cd yourservername 
$ git clone https://git.koke.estate/Docker/Minecraft-Bedrock.git
$ cp sample.env .env
$ nano .env

Usage

A few examples of useful commands and/or tasks.

$ docker-compose pull 
$ docker-compose up -d

Deployment

Additional notes on how to deploy this on a live or release system. Explaining the most important branches, what pipelines they trigger and how to update the database (if anything special).

Server

  • Live:
  • Release:
  • Development:

Branches

  • Master:
  • Feature:
  • Bugfix:
  • etc...

Additional Documentation and Acknowledgments

  • Project folder on server:
  • Confluence link:
  • Asana board:
  • etc...