{"id":13596319,"url":"https://github.com/hexparrot/mineos-node","last_synced_at":"2025-04-09T16:32:17.098Z","repository":{"id":19825248,"uuid":"23086258","full_name":"hexparrot/mineos-node","owner":"hexparrot","description":"node.js implementation of mineos minecraft management","archived":false,"fork":false,"pushed_at":"2024-03-31T14:52:06.000Z","size":5420,"stargazers_count":318,"open_issues_count":115,"forks_count":157,"subscribers_count":29,"default_branch":"master","last_synced_at":"2024-04-14T20:05:46.313Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hexparrot.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"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":"2014-08-18T20:58:04.000Z","updated_at":"2024-06-27T06:51:58.574Z","dependencies_parsed_at":"2023-02-15T18:46:24.310Z","dependency_job_id":"ced30a67-449b-4916-882a-dd27d50f3f86","html_url":"https://github.com/hexparrot/mineos-node","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hexparrot%2Fmineos-node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hexparrot%2Fmineos-node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hexparrot%2Fmineos-node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hexparrot%2Fmineos-node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hexparrot","download_url":"https://codeload.github.com/hexparrot/mineos-node/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248067873,"owners_count":21042366,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-08-01T16:02:18.072Z","updated_at":"2025-04-09T16:32:12.090Z","avatar_url":"https://github.com/hexparrot.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","Application Recommendation"],"sub_categories":["🎮 Game Servers"],"readme":"Node.JS MineOS\n======\n\nMineOS is a server front-end to ease managing Minecraft administrative tasks.\nThis iteration using Node.js aims to enhance previous MineOS scripts (Python-based),\nby leveraging the event-triggering, asyncronous model of Node.JS and websockets.\n\nThis allows the front-end to provide system health, disk and memory usage, and logging in real-time.\n\nThis has been tested on Debian, Ubuntu, ArchLinux, and FreeBSD and should work on all variants, Linux or BSD.\n\nInstallation\n------------\n\nMineOS is distributed through github and downloads its dependencies with npm.\n\nMineOS requires root-privileges, as the authentication relies on the underlying system's /etc/shadow.\n\nDo not install this atop an existing MineOS system (using the Python-based webui), since the installation location is the same /usr/games/minecraft. Following are steps for installing MineOS on an apt-get based distribution, such as Debian or Ubuntu.  These instructions are detailed further (as well as for additional distributions) on the [MineOS wiki](https://minecraft.codeemo.com/mineoswiki/index.php?title=Installing_MineOS).\n\nUsing an apt-get based Linux distribution:\n\n    curl -sL https://deb.nodesource.com/setup_8.x | bash -\n    apt-get update\n    apt-get install -y nodejs git rdiff-backup screen build-essential openjdk-8-jre-headless\n    mkdir -p /usr/games\n    cd /usr/games\n    git clone https://github.com/hexparrot/mineos-node.git minecraft\n    cd minecraft\n    chmod +x generate-sslcert.sh\n    ./generate-sslcert.sh\n    cp mineos.conf /etc/mineos.conf\n    npm install\n    \nFor hosts using 'upstart':\n\n    cp /usr/games/minecraft/init/upstart_conf /etc/init/mineos.conf\n    start mineos\n\nFor hosts using 'supervisor':\n\n    cp /usr/games/minecraft/init/supervisor_conf /etc/supervisor/conf.d/mineos.conf\n    supervisorctl reread\n    supervisorctl update\n    supervisorctl start mineos\n\nFor hosts using 'systemd':\n\n    cp /usr/games/minecraft/init/systemd_conf /etc/systemd/system/mineos.service\n    systemctl enable mineos\n    systemctl start mineos\n\nTo use the webui as a background daemon:\n\n    node service.js [start|stop|restart|status]\n\nTo start the webui in the foreground:\n\n    node webui.js\n\nThings to watch out for\n------\n\nOn FreeBSD, you will need to mount a Linux-compatible /proc filesystem, i.e., linprocfs,\nat /usr/compat/linux/proc in order for the web-ui to work. In addition, where CLANG is\ndefault for your system, you'll need to build the NPM modules differently:\n\n    echo \"CXX=c++ npm install\" | sh\n\nMineos-node requires rsync 3.1.x or later, 3.0.x does not have the ability to chown\non copy, which is essential for profiles. Depending on your distribution, you may need\nto build it from source.\n\nDeveloping and Contributing\n------\n\nI'd love to get contributions from you! Whether you are most comfortable writing\nHTML, CSS, or Javascript (either Nodejs or Angular), feel free to reach out to me about\nsome of my design goals and we'll see where your efforts can best be used.\n\n\nLicense\n-------\n\nSee [LICENSE.md](LICENSE.md) file.\n\nSupport\n-------\n\nCreate an issue in github or start a post on the [MineOS support forums](http://discourse.codeemo.com).\n\nCURRENTLY WORKING\n-------\n\nThe Angular.JS-based web user interface capable of:\n\n* creating and deleting servers, \n* starting, restarting, killing and stopping servers \n* backup, archive, wait-for-stop-and-backup\n* reading ingame console in real-time and submitting commands\n* create cronjobs for the most common tasks\n* adding and modifying server.properties\n* delete previous archives and restore poitns to free up space\n* restore server from previous restore point\n* see filesystem usage of live server files, archives, and restore points\n* authentication via shadow passwords (/etc/shadow) of underlying Linux system\n* logs all user actions to file\n* cronjobs saved to portable format cron.config\n* server can be daemonized to background\n* upstart/supervisord restart process on unhandled exceptions\n* easy selection of server packs from FTB or Mojang official jars\n* PHAR support for Pocketmine servers\n* Support for BungeeCord servers\n* command-line interface for scripting\n\nTODO\n-------\n\n* macro often-repeated tasks from web-ui\n* more fully document functions\n\nEVENTUALLY\n-------\n\n* implement previous_versions: functionality to roll back or view particular files' previous state\n* identify java versions in web-ui, allow choice of utilized jvm\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhexparrot%2Fmineos-node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhexparrot%2Fmineos-node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhexparrot%2Fmineos-node/lists"}