# Gate

## Docs

- [Architecture Overview](https://mintlify.wiki/minekube/gate/concepts/architecture.md): Deep dive into Gate's internal architecture, core components, and how they work together to provide a scalable Minecraft proxy.
- [Minecraft Editions](https://mintlify.wiki/minekube/gate/concepts/editions.md): Learn how Gate supports both Java and Bedrock editions, the differences between them, and how cross-play works.
- [How Gate Works](https://mintlify.wiki/minekube/gate/concepts/how-it-works.md): Understand Gate's connection flow, packet handling, and internal mechanics from client handshake to server switching.
- [Compression Configuration](https://mintlify.wiki/minekube/gate/configuration/compression.md): Configure packet compression settings to optimize bandwidth and performance between Gate proxy and Minecraft clients
- [Forced Hosts Configuration](https://mintlify.wiki/minekube/gate/configuration/forced-hosts.md): Route players to specific servers based on connection hostname using Gate's ForcedHosts feature
- [Player Info Forwarding Configuration](https://mintlify.wiki/minekube/gate/configuration/forwarding.md): Configure player information forwarding to pass real IPs and UUIDs to backend servers using legacy, velocity, or bungeeguard modes
- [Configuration Overview](https://mintlify.wiki/minekube/gate/configuration/overview.md): Complete guide to configuring Gate Minecraft proxy with YAML settings, file locations, and best practices
- [Server Configuration](https://mintlify.wiki/minekube/gate/configuration/servers.md): Configure backend Minecraft servers, connection order, and fallback behavior in Gate proxy
- [Status Ping Configuration](https://mintlify.wiki/minekube/gate/configuration/status-ping.md): Customize server list appearance with MOTD, favicon, player count, and ping response settings
- [Gate Connect for Public Access](https://mintlify.wiki/minekube/gate/deployment/advanced/connect.md): Deploy Gate with Connect integration for public server access without port forwarding, load balancing across multiple instances, and organic player traffic.
- [Failover and High Availability](https://mintlify.wiki/minekube/gate/deployment/advanced/failover.md): Configure automatic failover, redundancy, and high-availability setups for Gate Minecraft proxy to ensure zero-downtime deployments and resilient infrastructure.
- [Load Balancing Strategies](https://mintlify.wiki/minekube/gate/deployment/advanced/load-balancing.md): Configure advanced load balancing across multiple Gate instances and backend servers with strategies including round-robin, least-connections, and lowest-latency.
- [Docker Compose](https://mintlify.wiki/minekube/gate/deployment/docker/compose.md): Deploy Gate with backend servers using Docker Compose
- [Docker Configuration](https://mintlify.wiki/minekube/gate/deployment/docker/configuration.md): Advanced Docker configuration for Gate including volumes, networking, and environment variables
- [Getting Started with Docker](https://mintlify.wiki/minekube/gate/deployment/docker/getting-started.md): Deploy Gate using Docker with simple docker run commands
- [Kubernetes Manifests](https://mintlify.wiki/minekube/gate/deployment/kubernetes/manifests.md): Complete Kubernetes manifest examples for deploying Gate proxy
- [Scaling and Load Balancing](https://mintlify.wiki/minekube/gate/deployment/kubernetes/scaling.md): Configure horizontal pod autoscaling and load balancing for Gate on Kubernetes
- [Kubernetes Setup](https://mintlify.wiki/minekube/gate/deployment/kubernetes/setup.md): Deploy Gate on Kubernetes with proper configuration and prerequisites
- [Monitoring & Observability](https://mintlify.wiki/minekube/gate/deployment/monitoring.md): Configure health checks, metrics, logging, and alerting for Gate proxy
- [Logging Configuration](https://mintlify.wiki/minekube/gate/deployment/observability/logging.md): Configure structured logging in Gate proxy with Zap logger, log levels, and log aggregation
- [Metrics Collection](https://mintlify.wiki/minekube/gate/deployment/observability/metrics.md): Monitor Gate proxy performance with OpenTelemetry metrics, Prometheus integration, and custom dashboards
- [OpenTelemetry Integration](https://mintlify.wiki/minekube/gate/deployment/observability/opentelemetry.md): Configure OpenTelemetry observability in Gate Minecraft proxy for comprehensive monitoring with metrics, traces, and logs
- [Distributed Tracing](https://mintlify.wiki/minekube/gate/deployment/observability/tracing.md): Debug and monitor Gate proxy with distributed tracing using OpenTelemetry, Jaeger, and Tempo
- [Deployment Overview](https://mintlify.wiki/minekube/gate/deployment/overview.md): Learn about deployment options and architecture for Gate proxy
- [Production Checklist](https://mintlify.wiki/minekube/gate/deployment/production-checklist.md): Comprehensive checklist for deploying Gate proxy to production
- [Connection API](https://mintlify.wiki/minekube/gate/developers/api/connection.md): Managing player connections to backend servers
- [Player API](https://mintlify.wiki/minekube/gate/developers/api/player.md): Interface for interacting with connected Minecraft players
- [Proxy API](https://mintlify.wiki/minekube/gate/developers/api/proxy.md): Core proxy interface for Gate server management and player operations
- [Server API](https://mintlify.wiki/minekube/gate/developers/api/server.md): Interface for managing and interacting with backend servers
- [Brigadier Commands](https://mintlify.wiki/minekube/gate/developers/commands/brigadier.md): Master Brigadier's command parsing and node system for advanced command creation.
- [Commands Overview](https://mintlify.wiki/minekube/gate/developers/commands/overview.md): Learn about Gate's command system architecture and how to work with proxy commands.
- [Command Permissions](https://mintlify.wiki/minekube/gate/developers/commands/permissions.md): Implement permission checks for commands and control access to proxy features.
- [Command Registration](https://mintlify.wiki/minekube/gate/developers/commands/registration.md): Learn how to register and manage custom commands in Gate.
- [Lifecycle Events](https://mintlify.wiki/minekube/gate/developers/events/lifecycle.md): Handle proxy initialization and shutdown events in Gate
- [Events Overview](https://mintlify.wiki/minekube/gate/developers/events/overview.md): Learn about Gate's event-driven architecture and how to subscribe to events in your Minecraft proxy plugins
- [Player Events](https://mintlify.wiki/minekube/gate/developers/events/player-events.md): Handle player connections, authentication, chat, and other player-related events in Gate
- [Server Events](https://mintlify.wiki/minekube/gate/developers/events/server-events.md): Handle server connections, disconnections, and backend server management in Gate
- [Command Plugin Example](https://mintlify.wiki/minekube/gate/developers/examples/command-plugin.md): Learn how to create commands with arguments, suggestions, and permissions in Gate plugins.
- [Event Listener Example](https://mintlify.wiki/minekube/gate/developers/examples/event-listener.md): Complete guide to subscribing to and handling Gate proxy events with practical examples.
- [Simple Plugin Example](https://mintlify.wiki/minekube/gate/developers/examples/simple-plugin.md): A complete working example showing how to create a basic Gate plugin with event handling and commands.
- [Developer Introduction](https://mintlify.wiki/minekube/gate/developers/introduction.md): Get started with Gate's Go API for building Minecraft proxy extensions. Learn why Go and explore Gate's plugin architecture.
- [Plugin Template](https://mintlify.wiki/minekube/gate/developers/plugin-template.md): Get started quickly with Gate's plugin template. Fork the repository and start building your Minecraft proxy extension in minutes.
- [Project Setup](https://mintlify.wiki/minekube/gate/developers/project-setup.md): Learn how to create a new Go project from scratch that uses Gate. Step-by-step guide with code examples and best practices.
- [Packets - Protocol Data Types](https://mintlify.wiki/minekube/gate/developers/protocol/packets.md): Learn about Gate packet types, encoding/decoding mechanisms, and how to work with Minecraft protocol packets.
- [Plugin Channels - Custom Protocol Communication](https://mintlify.wiki/minekube/gate/developers/protocol/plugin-channels.md): Learn about Minecraft plugin messaging channels and how Gate handles MC|Brand, REGISTER, and custom communication.
- [Sound System - Packet-Level Sound Handling](https://mintlify.wiki/minekube/gate/developers/protocol/sound-system.md): Understand how Gate handles sound packets at the protocol level for playing and controlling sounds.
- [Bedrock Crossplay](https://mintlify.wiki/minekube/gate/features/bedrock-crossplay.md): Enable cross-platform play between Java and Bedrock Edition players using Gate's built-in Geyser integration
- [Built-in Commands](https://mintlify.wiki/minekube/gate/features/builtin-commands.md): Learn about Gate's built-in proxy commands including /server, /glist, and /send for managing players across your network
- [Lite Mode](https://mintlify.wiki/minekube/gate/features/lite-mode.md): Ultra-lightweight reverse proxy for hostname-based routing with minimal resource usage
- [Modded Server Support](https://mintlify.wiki/minekube/gate/features/modded-servers.md): Use Gate with Fabric and NeoForge modded Minecraft servers with Velocity modern forwarding
- [Rate Limiting](https://mintlify.wiki/minekube/gate/features/rate-limiting.md): Configure rate limiting in Gate to prevent abuse and DDoS attacks with IP-based connection and login limiters
- [Binary Installation](https://mintlify.wiki/minekube/gate/installation/binary.md): Download and install Gate from pre-built binaries for Linux, macOS, and Windows
- [Docker Installation](https://mintlify.wiki/minekube/gate/installation/docker.md): Run Gate in Docker containers with docker run, docker-compose, or Podman
- [Go Installation](https://mintlify.wiki/minekube/gate/installation/go.md): Install Gate using Go tools, build from source, or run directly with go run
- [Kubernetes Installation](https://mintlify.wiki/minekube/gate/installation/kubernetes.md): Deploy Gate on Kubernetes with manifests, Kustomize, and complete network examples
- [Introduction](https://mintlify.wiki/minekube/gate/introduction.md): Learn about Gate, a modern, cloud-native Minecraft proxy server built in Go that's designed as a fast, scalable replacement for BungeeCord and Velocity.
- [Quick Start](https://mintlify.wiki/minekube/gate/quickstart.md): Get Gate up and running in minutes with this step-by-step guide.
- [Forwarding Modes - Secure Player Info Forwarding](https://mintlify.wiki/minekube/gate/security/forwarding-modes.md): Configure Gate's forwarding modes to securely transmit player information to backend servers: legacy, velocity, bungeeguard, and none.
- [Key Authentication - Minecraft 1.19+ Security](https://mintlify.wiki/minekube/gate/security/key-authentication.md): Configure Gate's forceKeyAuthentication setting to enable or disable Minecraft 1.19+ chat signing and message verification.
- [Online Mode - Mojang Authentication](https://mintlify.wiki/minekube/gate/security/online-mode.md): Configure Gate's online mode for Mojang authentication and understand the security implications of offline mode.
- [Proxy Protocol - HAProxy Protocol Support](https://mintlify.wiki/minekube/gate/security/proxy-protocol.md): Configure Gate to support HAProxy PROXY protocol for preserving client IP addresses when behind load balancers and reverse proxies.
- [Why Gate?](https://mintlify.wiki/minekube/gate/why-gate.md): Discover why Gate is the modern choice for Minecraft proxy servers with cloud-native design, minimal resource usage, and built-in cross-play support.