{"id":16540609,"url":"https://github.com/itzg/mc-server-runner","last_synced_at":"2026-04-02T16:44:11.375Z","repository":{"id":39647437,"uuid":"133754986","full_name":"itzg/mc-server-runner","owner":"itzg","description":"A container entry point to manage graceful shutdown of a Minecraft server","archived":false,"fork":false,"pushed_at":"2026-03-28T13:18:06.000Z","size":430,"stargazers_count":40,"open_issues_count":11,"forks_count":19,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-03-28T16:31:00.825Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/itzg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"itzg","custom":["https://www.buymeacoffee.com/itzg","https://paypal.me/itzg"]}},"created_at":"2018-05-17T03:42:11.000Z","updated_at":"2026-03-28T13:17:28.000Z","dependencies_parsed_at":"2026-01-16T17:03:16.704Z","dependency_job_id":null,"html_url":"https://github.com/itzg/mc-server-runner","commit_stats":null,"previous_names":[],"tags_count":46,"template":false,"template_full_name":null,"purl":"pkg:github/itzg/mc-server-runner","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itzg%2Fmc-server-runner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itzg%2Fmc-server-runner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itzg%2Fmc-server-runner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itzg%2Fmc-server-runner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/itzg","download_url":"https://codeload.github.com/itzg/mc-server-runner/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itzg%2Fmc-server-runner/sbom","scorecard":{"id":409383,"data":{"date":"2025-08-11","repo":{"name":"github.com/itzg/mc-server-runner","commit":"57d463c5dee53936ad8a5a5329953ae19afe3d7b"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.1,"checks":[{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":2,"reason":"Found 2/8 approved changesets -- score normalized to 2","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":5,"reason":"6 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 5","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/release.yml:1","Warn: no topLevel permission defined: .github/workflows/test.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/itzg/mc-server-runner/release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/itzg/mc-server-runner/test.yml/master?enable=pin","Warn: containerImage not pinned by hash: .devcontainer/Dockerfile:5","Info:   0 out of   2 third-party GitHubAction dependencies pinned","Info:   0 out of   1 containerImage dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact 1.13.2 not signed: https://api.github.com/repos/itzg/mc-server-runner/releases/232704189","Warn: release artifact 1.13.1 not signed: https://api.github.com/repos/itzg/mc-server-runner/releases/225839950","Warn: release artifact 1.13.0 not signed: https://api.github.com/repos/itzg/mc-server-runner/releases/207306827","Warn: release artifact 1.12.6 not signed: https://api.github.com/repos/itzg/mc-server-runner/releases/199610349","Warn: release artifact 1.12.5 not signed: https://api.github.com/repos/itzg/mc-server-runner/releases/197980942","Warn: release artifact 1.13.2 does not have provenance: https://api.github.com/repos/itzg/mc-server-runner/releases/232704189","Warn: release artifact 1.13.1 does not have provenance: https://api.github.com/repos/itzg/mc-server-runner/releases/225839950","Warn: release artifact 1.13.0 does not have provenance: https://api.github.com/repos/itzg/mc-server-runner/releases/207306827","Warn: release artifact 1.12.6 does not have provenance: https://api.github.com/repos/itzg/mc-server-runner/releases/199610349","Warn: release artifact 1.12.5 does not have provenance: https://api.github.com/repos/itzg/mc-server-runner/releases/197980942"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-18T22:14:26.258Z","repository_id":39647437,"created_at":"2025-08-18T22:14:26.258Z","updated_at":"2025-08-18T22:14:26.258Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31310451,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-02T12:59:32.332Z","status":"ssl_error","status_checked_at":"2026-04-02T12:54:48.875Z","response_time":89,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5: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":[],"created_at":"2024-10-11T18:52:53.882Z","updated_at":"2026-04-02T16:44:11.364Z","avatar_url":"https://github.com/itzg.png","language":"Go","funding_links":["https://github.com/sponsors/itzg","https://www.buymeacoffee.com/itzg","https://paypal.me/itzg"],"categories":[],"sub_categories":[],"readme":"[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/itzg/mc-server-runner)](https://github.com/itzg/mc-server-runner/releases/latest)\n[![Test](https://github.com/itzg/mc-server-runner/actions/workflows/test.yml/badge.svg)](https://github.com/itzg/mc-server-runner/actions/workflows/test.yml)\n\n\nThis is a process wrapper used by \n[the itzg/minecraft-server Docker image](https://hub.docker.com/r/itzg/minecraft-server/)\nto ensure the Minecraft server is stopped gracefully when the container is sent the `TERM` signal.\n\n## Usage\n\n\u003e Available at any time using `-h`\n\n```\n  -bootstrap string\n        Specifies a file with commands to initially send to the server\n  -debug\n        Enable debug logging\n  -detach-stdin\n        Don't forward stdin and allow process to be put in background\n  -named-pipe string\n        Optional path to create and read a named pipe for console input\n  -remote-console\n        Allow remote shell connections over SSH to server console\n  -shell string\n        When set, pass the arguments to this shell\n  -stop-command string\n        Which command to send to the server to stop it (default \"stop\")\n  -stop-duration duration\n        Amount of time in Golang duration to wait after sending the 'stop' command.\n  -stop-server-announce-delay duration\n        Amount of time in Golang duration to wait after announcing server shutdown\n  -websocket-address string\n        Bind address for websocket server (env WEBSOCKET_ADDRESS) (default \"0.0.0.0:80\")\n  -websocket-allowed-origins value\n        Comma-separated list of trusted origins (env WEBSOCKET_ALLOWED_ORIGINS)\n  -websocket-console\n        Allow remote shell over websocket\n  -websocket-disable-authentication\n        Disable websocket authentication (env WEBSOCKET_DISABLE_AUTHENTICATION)\n  -websocket-disable-origin-check\n        Disable checking if origin is trusted (env WEBSOCKET_DISABLE_ORIGIN_CHECK)\n  -websocket-log-buffer-size int\n        Number of log lines to save and send to connecting clients (env WEBSOCKET_LOG_BUFFER_SIZE) (default 50)\n  -websocket-password string\n        Password will be the same as RCON_PASSWORD if unset (env WEBSOCKET_PASSWORD)\n```\n\nThe `-stop-server-announce-delay` can by bypassed by sending a `SIGUSR1` signal to the `mc-server-runner` process.  \nThis works in cases where a prior `SIGTERM` has already been sent **and** in cases where no prior signal has been sent.\n\n## Development Testing\n\nStart a golang container for building and execution:\n\u003e Port 2222 is used for remote ssh console  \nPort 80 is used for remote websocket console\n```bash\ndocker run -it --rm \\\n  -v ${PWD}:/build \\\n  -w /build \\\n  -p 2222:2222 \\\n  -p 80:80 \\\n  golang:1.19\n```\n\nWithin that container, build/test by running:\n\n```bash\ngo run . test/dump.sh\ngo run . test/bash-only.sh\n# Used to test remote console functionality\n# Connect to this using an ssh client from outside the container to ensure two-way communication works\ngo run . -remote-console /usr/bin/sh\n# The following should fail\ngo run . --shell sh test/bash-only.sh\n```\n\n### Using the devcontainer's Dockerfile\n\n#### With IntelliJ\n\nCreate a \"Go Build\" run configuration\n\n![](notes/dockerfile-run-config.png)\n\nwith a Dockerfile target\n\n![](notes/dockerfile-docker-target.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitzg%2Fmc-server-runner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fitzg%2Fmc-server-runner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitzg%2Fmc-server-runner/lists"}