mcserver/README.md
JaniSoto f441c6b13c docs: overhaul repository documentation architecture and operational runbooks
- Add active server instance matrix and quick navigation to root README
- Add player quick join guide and release download steps to instance README
- Update data preservation matrix in operations manual for tracked mod configs
- Document interactive admin console script (runtime/console)
- Fix host file ownership recovery runbooks across documentation
2026-08-15 19:18:47 +00:00

35 lines
1.8 KiB
Markdown

# Minecraft Server Infrastructure Repository
Mono-repo containing infrastructure baselines, operational runbooks, and instance profile specifications for containerized Minecraft servers.
## Active Server Instances
| Instance ID | Engine / Version | Status | Documentation & Player Guide |
| :--- | :--- | :--- | :--- |
| `forge-1.20.1-survival` | Forge 1.20.1 | Active | [Instance & Player Guide](instances/forge-1.20.1-survival/README.md) |
## Repository Architecture
```text
.
├── .gitignore
├── README.md
├── docs/
│ ├── infrastructure-base.md # Cloud VM, host OS, network, and storage baseline
│ └── operations-manual.md # Administration, RCON commands, log filtering, and state runbooks
└── instances/
└── forge-1.20.1-survival/ # Forge 1.20.1 survival instance profile
├── README.md # Player joining guide, instance specs, and admin runbooks
├── mod-configs.md # Mod configuration matrix and validated schemas
├── patches/
│ └── lts-auth/ # Custom authentication mod source and build scripts
└── runtime/ # Active Docker deployment directory
├── console # Interactive admin console script
├── docker-compose.yml # Production Compose stack
└── data/ # Server data volume
```
## Quick Navigation
* **Host Provisioning & Security**: See [Infrastructure Baseline](docs/infrastructure-base.md) for OCI configuration, UFW rules, and kernel network tuning.
* **Server Administration**: See [Operations Manual](docs/operations-manual.md) for maintenance workflows, backup management, and troubleshooting.