{"id":19880698,"url":"https://github.com/jojomatik/blockcluster","last_synced_at":"2026-02-13T00:37:29.952Z","repository":{"id":37884253,"uuid":"334421810","full_name":"jojomatik/blockcluster","owner":"jojomatik","description":"An in-browser manager for your minecraft servers.","archived":false,"fork":false,"pushed_at":"2024-10-15T20:33:31.000Z","size":16720,"stargazers_count":2,"open_issues_count":48,"forks_count":1,"subscribers_count":1,"default_branch":"beta","last_synced_at":"2025-09-10T23:42:00.457Z","etag":null,"topics":["alpine","docker","material-design","minecraft","minecraft-server","node","nodejs","server","typescript","vue","vuetify"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jojomatik.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-01-30T13:41:37.000Z","updated_at":"2024-10-15T20:25:36.000Z","dependencies_parsed_at":"2024-10-17T01:42:34.107Z","dependency_job_id":null,"html_url":"https://github.com/jojomatik/blockcluster","commit_stats":null,"previous_names":[],"tags_count":156,"template":false,"template_full_name":null,"purl":"pkg:github/jojomatik/blockcluster","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jojomatik%2Fblockcluster","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jojomatik%2Fblockcluster/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jojomatik%2Fblockcluster/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jojomatik%2Fblockcluster/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jojomatik","download_url":"https://codeload.github.com/jojomatik/blockcluster/tar.gz/refs/heads/beta","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jojomatik%2Fblockcluster/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29389255,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-13T00:02:39.825Z","status":"ssl_error","status_checked_at":"2026-02-13T00:00:20.807Z","response_time":55,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alpine","docker","material-design","minecraft","minecraft-server","node","nodejs","server","typescript","vue","vuetify"],"created_at":"2024-11-12T17:12:16.727Z","updated_at":"2026-02-13T00:37:29.938Z","avatar_url":"https://github.com/jojomatik.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# blockcluster \n[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/jojomatik/blockcluster?sort=semver)](https://github.com/jojomatik/blockcluster/releases) [![GitHub](https://img.shields.io/github/license/jojomatik/blockcluster)](LICENSE) [![Build and publish Docker image](https://github.com/jojomatik/blockcluster/actions/workflows/publish.yml/badge.svg)](https://github.com/jojomatik/blockcluster/actions/workflows/publish.yml) [![Docker Image Version (latest semver)](https://img.shields.io/docker/v/jojomatik/blockcluster?label=Docker%20Hub%20image\u0026sort=semver)](https://hub.docker.com/r/jojomatik/blockcluster) [![Docker Pulls](https://img.shields.io/docker/pulls/jojomatik/blockcluster)](https://hub.docker.com/r/jojomatik/blockcluster)\n\nAn in-browser manager for your minecraft servers.\n\n![Screenshot of Blockcluster](docs/screenshot.png)\n\n## Features\n- Start and stop servers\n- Automatically pause empty servers and unpause as soon as a client connects\n- View current status and online players\n- Show resource usage\n- View console log and send commands\n- Select different java runtimes (See also: [\"Adding custom java runtimes\"](#adding-custom-java-runtimes))\n- Change start flags\n- Start servers with backend\n- Show server favicon to differentiate servers easier\n\n## Roadmap for future releases\n- Authentication\n- Create servers and download server jars\n\n## Setup \n### Setup with docker (recommended)\nPrerequisites:\n- Docker\n\nCustomize `/path/to/servers/on/host/machine` and the port directives `-p port:port` to your liking and run:\n```sh\ndocker run -d -v /path/to/servers/on/host/machine:/usr/games/blockcluster/servers -p 8081:8081 25565-25569:25565-25569 jojomatik/blockcluster:latest\n```\nOpen `http://[your ip]:8081` in your browser.\n\n### Setup with `docker-compose` (also recommended)\nPrerequisites:\n- Docker\n- Docker Compose\n\nDownload [`docker-compose.yml`](docker-compose.yml) and customize it to your liking and add a volume mount to your servers on the host machine. E.g.:\n```\nversion: \"3.9\"\nservices:\n  manager:\n    ports:\n      - 8081:8081\n      - 25565:25565\n    image: jojomatik/blockcluster\n    volumes:\n      - /path/to/servers/on/host/machine:/usr/games/blockcluster/servers\n```\n\nThen run the following command:\n```sh\ndocker-compose up\n```\nOpen `http://[your ip]:8081` in your browser.\n\n### Manual setup \nPrerequisites:\n- Git\n- Node.js (v16+) and npm (v8+)\n- Java (to run the minecraft servers)\n\n1. First build the app using the instructions from [\"Building manually\"](#building-manually).\n2. Either\n   - create the `servers/` subdirectory and move your servers into it or\n   - set the environment variable `SERVER_PATH` to the relative or absolute path of your servers.\n3. Run `npm run start` and open `http://[your ip]:8081` in your browser.\n\n### Adding custom java runtimes\nBy default, the docker image based on [`docker-compose.yml`](docker-compose.yml) and the [`Dockerfile`](Dockerfile) includes java 11, java 17 and java 21. Those are the most relevant LTS java version for running minecraft servers (see [#150](https://github.com/jojomatik/blockcluster/issues/150) for more details).\n\n#### Windows\nAll java runtimes in the `PATH` environment variable will be discovered and presented as an option in the frontend.\n\n#### Docker\nMount additional java runtimes in the `/opt/java-xx` directory.\n\nWith the `docker run` command:\n```sh\ndocker run -d -v /path/to/servers/on/host/machine:/usr/games/blockcluster/servers -v /path/to/java-xx/on/host/machine:/opt/java-xx -p 8081:8081 25565-25569:25565-25569 jojomatik/blockcluster:latest\n```\nor with `docker-compose`\n```\nversion: \"3.9\"\nservices:\n  manager:\n    ports:\n      - 8081:8081\n      - 25565:25565\n    image: jojomatik/blockcluster\n    volumes:\n      - /path/to/servers/on/host/machine:/usr/games/blockcluster/servers\n      - /path/to/java-xx/on/host/machine:/opt/java-xx\n```\n```sh\ndocker-compose up\n```\n\n## Building\n### Building with `docker-compose` (recommended)\nPrerequisites:\n- Git\n- Docker\n- Docker Compose\n\nRun the following commands:\n```sh\ngit clone https://github.com/jojomatik/blockcluster\ncd blockcluster\n```\n\n**To build for production**, run the following command:\n```sh\ndocker-compose up\n```\nOpen `http://[your ip]:8081` in your browser.\n\n**To enable hot reloads**, configure a file watcher for the TypeScript files in the `backend/src` directory to run `npm run build` in the `backend` directory and run the following command:\n```sh\ndocker-compose -f docker-compose.yml -f docker-compose.dev.yml up\n```\nOpen `http://[your ip]:8081` in your browser.\n\nTo make sure that the container is recreated and the image rebuilt, use either command with additional options, e.g.:\n```sh\ndocker-compose up --force-recreate --build\n```\n\n### Building manually\nPrerequisites:\n- Git\n- Node.js (v16+) and npm (v8+)\n- Java (only to run the minecraft servers)\n\nRun the following commands:\n```sh\ngit clone https://github.com/jojomatik/blockcluster\ncd blockcluster\nnpm install\ncd backend \u0026\u0026 npm install\n```\n\n**To build for production**, run the following commands:\n```sh\nnpm run build_all\nnpm run start\n```\nOpen `http://[your ip]:8081` in your browser.\n\n\n**To enable hot reloads**, configure a file watcher for the TypeScript files in the `backend/src` directory to run `npm run build` in the `backend` directory and run the following command:\n```sh\nnpm run serve\n```\nOpen `http://[your ip]:8081` in your browser.\n\n## Licensing\nThis project is licensed under the GNU Affero General Public License v3.0 (AGPL 3.0) or later. See also [`LICENSE`](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjojomatik%2Fblockcluster","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjojomatik%2Fblockcluster","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjojomatik%2Fblockcluster/lists"}