Git Product home page Git Product logo

minecraft-server-ngrok's Introduction

Minecraft-Server-ngrok

This a simple docker-compose for quickly spinning up a Minecraft-Server(java-edition) without opening a port in your router through ngrok. Default version is 1.20.4

Instructions

This compose uses two containers. One provides ngrok tunneling to avoid port-forwarding, the other one is the Minecraft-server. As a best practive you should always read a Dockerfile before running it:

ngrok

You will need to set NGROK_AUTHTOKEN to your ngrok-auth-token. You can also specify it in your compose file. The IP of the server is going to be visible on http://localhost:4040; the ngrok status-page.

Minecraft

The newest version is currently 1.20.4. Here is the list of links to the official Minecraft server-jars (versions.csv)
Currently, the server.jar is downloaded during build. The version has to be specified in docker-compose as a the build-arg MINECRAFT_VERSION: 1.20.4
You can add links to your own server.jar's to versions.csv. The list can be updated with the getServerVersions.py script, the repo will try to update once a week with a github action.
Your Minecraft-Server will be accessible through ngrok, as well as on localhost:25566

You will need to accept the Minecraft eula:

  • set eula=true in the environment section of the compose

The command-line oft the Minecraft server is usually available through the following command, but be aware that ctrl+c kills the server. USE CTRL-P+CTRL+Q to exit instead

docker attach minecraft-server-ngrok_minecraft_1

You can put your very own Minecraft-server-folder in the minecraft-data directory, which is going to be created by docker.

TL;DR

  • Set NGROK_AUTHTOKEN
  • Edit eula from false to eula=true in docker-compose
  • Run docker-compose up -d --build
  • Open http://localhost:4040 and copy url without tcp://
  • Join the server
  • Run docker attach minecraft-server-ngrok_minecraft_1
  • Type op <your_username>

minecraft-server-ngrok's People

Contributors

mrsmoer avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Forkers

bepisie

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.