{"id":22123912,"url":"https://github.com/nownabe/mclauncher","last_synced_at":"2025-07-25T15:31:36.615Z","repository":{"id":37894280,"uuid":"439853297","full_name":"nownabe/mclauncher","owner":"nownabe","description":"Web UI to manage Minecraft server on Google Compute Engine","archived":false,"fork":false,"pushed_at":"2024-11-14T21:54:08.000Z","size":331,"stargazers_count":2,"open_issues_count":11,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-11-14T22:31:34.664Z","etag":null,"topics":["fastapi","firebase","firestore","google-cloud","minecraft","python"],"latest_commit_sha":null,"homepage":"","language":"Python","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/nownabe.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-12-19T12:07:46.000Z","updated_at":"2024-11-14T21:52:47.000Z","dependencies_parsed_at":"2023-10-03T09:34:16.378Z","dependency_job_id":"99908e47-c7c4-4f29-b401-bc77434c7549","html_url":"https://github.com/nownabe/mclauncher","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nownabe%2Fmclauncher","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nownabe%2Fmclauncher/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nownabe%2Fmclauncher/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nownabe%2Fmclauncher/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nownabe","download_url":"https://codeload.github.com/nownabe/mclauncher/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227590148,"owners_count":17790446,"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":["fastapi","firebase","firestore","google-cloud","minecraft","python"],"created_at":"2024-12-01T15:45:23.914Z","updated_at":"2024-12-01T15:45:25.013Z","avatar_url":"https://github.com/nownabe.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mclauncher\n\n## Getting started\n\n### Use Docker image\n\nYou can quickly start with pre-built docker image.\n\n```bash\ndocker pull ghcr.io/nownabe/mclauncher:latest\n```\n\n### Run on Google Cloud\n\nYou can run mclauncher on [Cloud Run](https://cloud.google.com/run) by clicking this button.\n\n[![Run on Google Cloud](https://deploy.cloud.run/button.svg)](https://deploy.cloud.run)\n\n* You should add `roles/compute.instanceAdmin.v1` for your Minecraft server instance to the service account used for the Cloud Run service. If you want to minimize permissions, you can create your own custom role.\n* Firestore and Firebase Authentication must be initialized. For now, mclauncher supports only Google provider for Firebase Authentication.\n\n### Configurations\n\nEnvironment variables:\n\n* `PORT` (required)\n* `INSTANCE_ZONE` (required)\n* `INSTANCE_NAME` (required)\n* `SHUTTER_AUTHORIZED_EMAIL` (required) - email of service account which calls `/shutter`.\n* `FIREBASE_CREDENTIALS_JSON` (required) - used for Firebase Authentication and Firestore.\n* `FIREBASE_CONFIG_JSON` (required)\n* `TITLE` (optional) - default is `mclauncher`.\n* `WEB_CONCURRENCY` (optional) - default is `4`.\n* `SHUTTER_COUNT_TO_SHUTDOWN` (optional) - If the count of consecutive vacant of the server counted by `/shutter` exceeds this count, `/shutter` shuts down the instance.\n\n## Development on Codespaces\n\nInstall dependencies with [poetry](https://python-poetry.org/).\n\n```bash\npoetry install\n```\n\nRun Firestore emulator.\n\n```bash\nfirebase emulators:start\n```\n\nSet environment variables.\n\n```bash\nexport FIREBASE_CONFIG_JSON='{\"apiKey\":\"...\", ...}'\nexport FIREBASE_CREDENTIALS_JSON=\"$(cat firebase.credentials.json)\"\nexport FIRESTORE_EMULATOR_HOST=\"localhost:8080\"\nexport GOOGLE_APPLICATION_CREDENTIALS=\"$(pwd)/gcpproject.credentials.json\"\nexport INSTANCE_ZONE=\"asia-northeast1-a\"\nexport INSTANCE_NAME=\"minecraft-instance\"\nexport SHUTTER_AUTHORIZED_EMAIL=\"mclauncher@example.com\"\n```\n\nIf you haven't added your email as an authorized user, run `tools/add_authorized_users.py`.\n\n```bash\npoetry run python tools/add_authorized_users.py you@example.com\n```\n\nRun the development server.\n\n```bash\npoetry run uvicorn main:app --reload\n```\n\nOr you can run and debug with `Ctrl + Shift + D`.\n\nYou can forward ports. See the detail: [Forwarding ports in your codespace - GitHub Docs](https://docs.github.com/en/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace).\n\nTest.\n\n```bash\npoetry run pytest\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnownabe%2Fmclauncher","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnownabe%2Fmclauncher","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnownabe%2Fmclauncher/lists"}