mineos-node

(β˜… 365)

node.js implementation of mineos minecraft management

  • .dockerignore
  • .gitattributes
  • .gitignore
  • auth.js
  • docker-compose.yml
  • Dockerfile
  • Dockerfile.dev
  • entrypoint.sh
  • generate-sslcert.sh
  • install_rootless.sh
  • java.js
  • LICENSE.md
  • Makefile
  • mineos-games.service
  • mineos.conf
  • mineos.js
  • mineos_console.js
  • mineos_shutdown.js
  • package-lock.json
  • package.json
  • profiles.js
  • README.md
  • reset_webui.sh
  • server.js
  • service.js
  • update_webui.sh
  • webui.js

# Installation Guide

1. Get the code
git clone https://github.com/hexparrot/mineos-node

Downloads the entire project code from GitHub to your computer.

cd mineos-node

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • APT (Debian/Ubuntu 계열) Built into Debian/Ubuntu-based Linux distributions.
apt-get install -y nodejs git rdiff-backup screen build-essential openjdk-8-jre-headless

Installs directly from the APT package repository (Debian/Ubuntu-based).

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up -d --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

echo "CXX=c++ npm install" | sh

Downloads and installs the libraries listed in package.json.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

5. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation