fix: update readme
This commit is contained in:
51
README.md
51
README.md
@@ -14,6 +14,57 @@ This repository uses the Go standard layout described at https://github.com/gola
|
||||
|
||||
https://github.com/gorcon/rcon is used to connect to the RCON. The system expects the user provide a RCON_ADDRESS, and RCON_PASSWORD environment flag.
|
||||
|
||||
## Usage
|
||||
|
||||
### Environment Variables
|
||||
|
||||
The mcgod application requires the following environment variables to be set:
|
||||
|
||||
- `RCON_ADDRESS` - The address of the Minecraft server's RCON (e.g., "localhost:25575")
|
||||
- `RCON_PASSWORD` - The password for RCON access
|
||||
- `RCON_DEPLOYMENT` - Kubernetes deployment name for log monitoring (optional)
|
||||
- `RCON_NAMESPACE` - Kubernetes namespace for log monitoring (optional)
|
||||
- `RCON_POD` - Kubernetes pod name for log monitoring (optional)
|
||||
- `RCON_CONTAINER` - Kubernetes container name for log monitoring (optional)
|
||||
|
||||
### Running Locally
|
||||
|
||||
To build and run locally:
|
||||
```bash
|
||||
make build
|
||||
RCON_ADDRESS="localhost:25575" RCON_PASSWORD="your_rcon_password" ./mcgod
|
||||
```
|
||||
|
||||
### Running with Docker
|
||||
|
||||
To build and run with Docker:
|
||||
```bash
|
||||
make build-docker-local
|
||||
docker run --rm -it \
|
||||
-e RCON_ADDRESS="localhost:25575" \
|
||||
-e RCON_PASSWORD="your_rcon_password" \
|
||||
docker.tipsy.codes/mcgod:latest
|
||||
```
|
||||
|
||||
## Building
|
||||
|
||||
### Local Build
|
||||
```bash
|
||||
make build
|
||||
```
|
||||
|
||||
### Cross-platform Build
|
||||
```bash
|
||||
make build-amd64 # Build for AMD64
|
||||
make build-arm64 # Build for ARM64
|
||||
```
|
||||
|
||||
### Docker Build
|
||||
```bash
|
||||
make build-docker # Build multi-architecture Docker image
|
||||
make build-docker-local # Build Docker image for current architecture
|
||||
```
|
||||
|
||||
# Handling updates
|
||||
|
||||
Use `go mod tidy` to update go.mod; do not directly modify it.
|
||||
|
||||
Reference in New Issue
Block a user