Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nownabe/mclauncher
Web UI to manage Minecraft server on Google Compute Engine
https://github.com/nownabe/mclauncher
fastapi firebase firestore google-cloud minecraft python
Last synced: about 2 months ago
JSON representation
Web UI to manage Minecraft server on Google Compute Engine
- Host: GitHub
- URL: https://github.com/nownabe/mclauncher
- Owner: nownabe
- License: apache-2.0
- Created: 2021-12-19T12:07:46.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-14T21:54:08.000Z (2 months ago)
- Last Synced: 2024-11-14T22:31:34.664Z (2 months ago)
- Topics: fastapi, firebase, firestore, google-cloud, minecraft, python
- Language: Python
- Homepage:
- Size: 323 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# mclauncher
## Getting started
### Use Docker image
You can quickly start with pre-built docker image.
```bash
docker pull ghcr.io/nownabe/mclauncher:latest
```
### Run on Google Cloud
You can run mclauncher on [Cloud Run](https://cloud.google.com/run) by clicking this button.
[](https://deploy.cloud.run)
* 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.
* Firestore and Firebase Authentication must be initialized. For now, mclauncher supports only Google provider for Firebase Authentication.
### Configurations
Environment variables:
* `PORT` (required)
* `INSTANCE_ZONE` (required)
* `INSTANCE_NAME` (required)
* `SHUTTER_AUTHORIZED_EMAIL` (required) - email of service account which calls `/shutter`.
* `FIREBASE_CREDENTIALS_JSON` (required) - used for Firebase Authentication and Firestore.
* `FIREBASE_CONFIG_JSON` (required)
* `TITLE` (optional) - default is `mclauncher`.
* `WEB_CONCURRENCY` (optional) - default is `4`.
* `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.
## Development on Codespaces
Install dependencies with [poetry](https://python-poetry.org/).
```bash
poetry install
```
Run Firestore emulator.
```bash
firebase emulators:start
```
Set environment variables.
```bash
export FIREBASE_CONFIG_JSON='{"apiKey":"...", ...}'
export FIREBASE_CREDENTIALS_JSON="$(cat firebase.credentials.json)"
export FIRESTORE_EMULATOR_HOST="localhost:8080"
export GOOGLE_APPLICATION_CREDENTIALS="$(pwd)/gcpproject.credentials.json"
export INSTANCE_ZONE="asia-northeast1-a"
export INSTANCE_NAME="minecraft-instance"
export SHUTTER_AUTHORIZED_EMAIL="[email protected]"
```
If you haven't added your email as an authorized user, run `tools/add_authorized_users.py`.
```bash
poetry run python tools/add_authorized_users.py [email protected]
```
Run the development server.
```bash
poetry run uvicorn main:app --reload
```
Or you can run and debug with `Ctrl + Shift + D`.
You 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).
Test.
```bash
poetry run pytest
```