{"id":26937982,"url":"https://github.com/holysoles/ginrcon","last_synced_at":"2025-08-19T05:11:30.951Z","repository":{"id":221283399,"uuid":"753454755","full_name":"holysoles/ginrcon","owner":"holysoles","description":"A simple HTTP REST API to proxy RCON commands to a game server","archived":false,"fork":false,"pushed_at":"2025-05-02T02:57:05.000Z","size":54,"stargazers_count":4,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-16T14:35:32.402Z","etag":null,"topics":["api","docker","gameserver","http","minecraft","minecraft-server","palworld","rcon","rest"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/holysoles.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2024-02-06T06:38:56.000Z","updated_at":"2025-05-02T00:26:42.000Z","dependencies_parsed_at":"2024-03-17T23:24:10.814Z","dependency_job_id":"14fb6ebe-e49d-43a1-9f65-48f422de76ad","html_url":"https://github.com/holysoles/ginrcon","commit_stats":null,"previous_names":["holysoles/ginrcon"],"tags_count":30,"template":false,"template_full_name":null,"purl":"pkg:github/holysoles/ginrcon","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/holysoles%2Fginrcon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/holysoles%2Fginrcon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/holysoles%2Fginrcon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/holysoles%2Fginrcon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/holysoles","download_url":"https://codeload.github.com/holysoles/ginrcon/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/holysoles%2Fginrcon/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271103202,"owners_count":24699646,"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","status":"online","status_checked_at":"2025-08-19T02:00:09.176Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["api","docker","gameserver","http","minecraft","minecraft-server","palworld","rcon","rest"],"created_at":"2025-04-02T13:16:38.217Z","updated_at":"2025-08-19T05:11:30.919Z","avatar_url":"https://github.com/holysoles.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GinRCON\nA lightweight, simple Go webserver build on Gin to provide a REST API frontend to sending RCON commands to a game server. Available in a Docker image, see [the packages page](https://github.com/holysoles/ginrcon/pkgs/container/ginrcon) for this repo.\n\n## API Call Examples\n### Send command to default RCON server\nAssuming you have a default RCON server specified (see environment variables)\n```bash\ncurl --location 'http://localhost:8080/command' \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"command\": \"Save\"\n}'\n```\n### POST command to specific RCON server\n```bash\ncurl --location 'http://localhost:8080/command' \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"server\": \"gameserver:25575\",\n    \"password\": \"1234\",\n    \"command\": \"Save\"\n}'\n```\n### Health check the status of the webserver\n```bash\ncurl --location 'http://localhost:8080/status'\n```\n## Docker\n### Image\nA docker image that runs this application is available under the repo packages, or at `ghcr.io/holysoles/ginrcon`.\n### Environment Variables\n- `PORT`: Optional, override the port (default 8080) of the webserver within the container\n- `TRUSTED_PROXIES`: Optional, set specified trusted proxy addresses\n- `RCON_SERVER`: Optional, configure a default RCON server's hostname\n- `RCON_PORT`: Optional, configure a default RCON server's port\n- `RCON_ADMIN_PASSWORD`: Optional, configure the password to a default RCON server\n### Compose\nAn example compose file can be found in the repo [here](https://github.com/holysoles/ginrcon/blob/master/compose.yaml)\n### Building\n`docker build --tag ghcr.io/holysoles/ginrcon:\u003ctag\u003e .`\n### Testing\n`docker run --rm -d -p 8080:8081 -e \"PORT=8081\" ghcr.io/holysoles/ginrcon:\u003ctag\u003e`\n### Upload\n`docker push ghcr.io/holysoles/ginrcon:\u003ctag\u003e`\n## Credits\nSpecial thanks to the following projects for providing essential libraries:\n- [gorcon/rcon](https://github.com/gorcon/rcon)\n- [gin-gonic/gin](https://github.com/gin-gonic/gin)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fholysoles%2Fginrcon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fholysoles%2Fginrcon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fholysoles%2Fginrcon/lists"}