jojomatik/blockcluster repository overview

⁠blockcluster

An in-browser manager for your minecraft servers.

⁠Features

• Start and stop servers
• View current status
• Show resource usage
• View console log and send commands
• Change start flags
• Start servers with backend

⁠Roadmap for future releases

• Authentication
• Create servers and download server jars

⁠Setup

⁠Setup with docker (recommended)

Prerequisites:

• Docker

Customize /path/to/servers/on/host/machine and the port directives -p port:port to your liking and run:

docker run -d -v /path/to/servers/on/host/machine:/usr/games/blockcluster/servers -p 8081:8081 25565-25569:25565-25569 jojomatik/blockcluster:latest

Open http://[your ip]:8081 in your browser.

⁠Setup with docker-compose (also recommended)

Prerequisites:

• Docker
• Docker Compose

Download docker-compose.yml⁠ and customize it to your liking and add a volume mount to your servers on the host machine. E.g.:

version: "3.9"
services:
  manager:
    ports:
      - 8081:8081
      - 25565:25565
    image: jojomatik/blockcluster
    volumes:
      - /path/to/servers/on/host/machine:/usr/games/blockcluster/servers

Then run the following command:

docker-compose up

Open http://[your ip]:8081 in your browser.

⁠License

The blockcluster source code is licensed under the GNU Affero General Public License v3.0 (AGPL 3.0) or later. See also LICENSE⁠.

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

This project does include all packages from the base image alpine⁠. You can view the license information at the "License" section at the bottom of their README⁠.

The image does include additional third party software installed using the apk package manager (namely java-cacerts, nodejs, npm and curl). License information of software included in the base image and packages installed using apk are available at "Alpine Linux Packages (https://pkgs.alpinelinux.org/)⁠".

A complete view of all packages from the base image or installed with apk can be retrieved by running apk list -I in the container. Running apk info --license <package-name> will return the corresponding license. You can retrieve the source for any package by looking up the package at "Alpine Linux Packages (https://pkgs.alpinelinux.org/)⁠".

A custom java runtime image is created during the build process and included in this image (/opt/java). The license of each module can be found in /opt/java/legal/<module>/LICENSE.

Licenses and license texts of dependencies included in the webpack build of the frontend are available at /usr/games/blockcluster/dist/ThirdPartyNotices.txt. Dependencies of the backend and their corresponding licenses and license texts are avaible in /usr/games/blockcluster/backend/node_modules.

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.