feat: use environment variables to configure (#860)

- improves docker/container experience

Author: andrewgazelka

.dockerignore

@@ -1,6 +1,44 @@
+# Rust build artifacts
 **/target/
-Dockerfile
+
+# Git and development files
 .git/
+.github/
 .gitignore
+.DS_Store
+.idea/
+.vscode/
+.envrc
+.pre-commit-config.yaml
+.trigger*
+
+# Docker files
+Dockerfile
+docker-compose.yml
+
+# Configuration and environment
 .env
-.cargo/config.toml
+deny.toml
+clippy.toml
+rustfmt.toml
+
+# Documentation and non-essential files
+docs/
+CONTRIBUTING.md
+LICENSE
+README.md
+CNAME
+
+# Node.js
+node_modules/
+pnpm-lock.yaml
+
+# Nix
+flake.nix
+flake.lock
+result/
+
+# Project-specific
+run/
+.devcontainer.json
+libvoidstar.so

Cargo.lock

@@ -100,23 +100,27 @@ COPY --from=build-release /app/build/hyperion-proxy /
 LABEL org.opencontainers.image.source="https://github.com/andrewgazelka/hyperion" \
     org.opencontainers.image.description="Hyperion Proxy Server" \
     org.opencontainers.image.version="0.1.0"
-EXPOSE 8080
+EXPOSE 25565
+ENV HYPERION_PROXY_PROXY_ADDR="0.0.0.0:25565" \
+    HYPERION_PROXY_SERVER="127.0.0.1:35565"
 ENTRYPOINT ["/hyperion-proxy"]
-CMD ["0.0.0.0:8080"]
 
 FROM runtime-base AS tag
 COPY --from=build-release /app/build/tag /
 LABEL org.opencontainers.image.source="https://github.com/andrewgazelka/hyperion" \
     org.opencontainers.image.description="Hyperion Tag Event" \
     org.opencontainers.image.version="0.1.0"
+ENV TAG_IP="0.0.0.0" \
+    TAG_PORT="35565"
 ENTRYPOINT ["/tag"]
-CMD ["--ip", "0.0.0.0", "--port", "35565"]
 
 FROM runtime-base AS rust-mc-bot
 COPY --from=build-release /app/build/rust-mc-bot /
 LABEL org.opencontainers.image.source="https://github.com/andrewgazelka/rust-mc-bot" \
     org.opencontainers.image.description="Rust Minecraft Bot" \
     org.opencontainers.image.version="0.1.0"
+ENV BOT_SERVER="hyperion-proxy:25565" \
+    BOT_BOT_COUNT="500" \
+    BOT_THREADS="4"
 ENTRYPOINT ["/rust-mc-bot"]
-CMD ["hyperion-proxy:25565", "500", "4"]
 

Dockerfile

@@ -1,22 +1,25 @@
 [dependencies]
-colored = {workspace = true}
-kanal = {workspace = true}
-papaya = {workspace = true}
-rkyv = {workspace = true}
-rustc-hash = {workspace = true}
-tokio = {workspace = true, features = ["full", "tracing"]}
-tokio-util = {workspace = true, features = ["full"]}
-anyhow = {workspace = true}
-bvh = {workspace = true}
-bytes = {workspace = true}
-clap = {workspace = true}
-glam = {workspace = true}
-heapless = {workspace = true}
-hyperion-proto = {workspace = true}
-more-asserts = {workspace = true}
-slotmap = {workspace = true}
-tracing = {workspace = true}
-tracing-subscriber = {workspace = true}
+colored = { workspace = true }
+kanal = { workspace = true }
+papaya = { workspace = true }
+rkyv = { workspace = true }
+rustc-hash = { workspace = true }
+tokio = { workspace = true, features = ["full", "tracing"] }
+tokio-util = { workspace = true, features = ["full"] }
+anyhow = { workspace = true }
+bvh = { workspace = true }
+bytes = { workspace = true }
+clap = { workspace = true }
+glam = { workspace = true }
+heapless = { workspace = true }
+hyperion-proto = { workspace = true }
+more-asserts = { workspace = true }
+slotmap = { workspace = true }
+tracing = { workspace = true }
+tracing-subscriber = { workspace = true }
+serde = { version = "1.0", features = ["derive"] }
+envy = "0.4"
+dotenvy = "0.15"
 
 [lints]
 workspace = true

crates/hyperion-proxy/Cargo.toml

@@ -2,6 +2,7 @@ use std::{fmt::Debug, net::SocketAddr, path::PathBuf};
 
 use clap::Parser;
 use hyperion_proxy::run_proxy;
+use serde::Deserialize;
 use tokio::net::TcpListener;
 #[cfg(unix)]
 use tokio::net::UnixListener;
@@ -12,19 +13,29 @@ use tracing_subscriber::EnvFilter;
 #[global_allocator]
 static GLOBAL: tikv_jemallocator::Jemalloc = tikv_jemallocator::Jemalloc;
 
-#[derive(Parser)]
+#[derive(Deserialize, Debug, Parser)]
 #[clap(version)]
 struct Params {
     /// The address for the proxy to listen on. Can be either:
     /// - A TCP address like "127.0.0.1:25565"
     /// - A Unix domain socket path like "/tmp/minecraft.sock" (Unix only)
+    #[serde(default = "default_proxy_addr")]
     proxy_addr: String,
 
     /// The address of the target Minecraft game server to proxy from/to
     #[clap(short, long, default_value = "127.0.0.1:35565")]
+    #[serde(default = "default_server")]
     server: String,
 }
 
+fn default_proxy_addr() -> String {
+    "0.0.0.0:25565".to_string()
+}
+
+fn default_server() -> String {
+    "127.0.0.1:35565".to_string()
+}
+
 #[derive(Debug)]
 enum ProxyAddress {
     Tcp(SocketAddr),
@@ -78,8 +89,25 @@ fn setup_logging() {
 
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
+    // Load .env file if available
+    dotenvy::dotenv().ok();
+
     setup_logging();
-    let params = Params::parse();
+
+    // Try to load params from environment variables
+    let params = match envy::prefixed("HYPERION_PROXY_").from_env::<Params>() {
+        Ok(params) => {
+            info!("Loaded configuration from environment variables");
+            params
+        }
+        Err(e) => {
+            info!(
+                "Failed to load from environment: {}, falling back to command line arguments",
+                e
+            );
+            Params::parse()
+        }
+    };
 
     let proxy_addr = ProxyAddress::parse(&params.proxy_addr)?;
 

crates/hyperion-proxy/src/main.rs

@@ -7,10 +7,12 @@ services:
       target: hyperion-proxy
     ports:
       - "25565:25565"
-    command: [ "--server", "tag:35565", "0.0.0.0:25565" ]
+    command: []
     restart: "no"
     environment:
       - RUST_LOG=info
+      - HYPERION_PROXY_PROXY_ADDR=0.0.0.0:25565
+      - HYPERION_PROXY_SERVER=tag:35565
     networks:
       - proxy-network
     depends_on:
@@ -25,10 +27,12 @@ services:
       - "27750:27750"
     expose:
       - "35565"
-    command: [ ]
+    command: []
     restart: "no"
     environment:
       - RUST_LOG=info
+      - TAG_IP=0.0.0.0
+      - TAG_PORT=35565
     networks:
       - proxy-network
   rust-mc-bot:
@@ -37,12 +41,15 @@ services:
       context: .
       dockerfile: Dockerfile
       target: rust-mc-bot
-    command: [ "hyperion-proxy:25565", "500", "2" ]
+    command: []
     restart: "no"
     depends_on:
       - hyperion-proxy
     environment:
       - RUST_LOG=info
+      - BOT_SERVER=hyperion-proxy:25565
+      - BOT_BOT_COUNT=500
+      - BOT_THREADS=2
     networks:
       - proxy-network
     profiles:

docker-compose.yml

@@ -29,6 +29,8 @@ uuid = { workspace = true }
 hyperion-respawn = { workspace = true }
 valence_protocol = { workspace = true }
 valence_server = { workspace = true }
+serde = { version = "1.0", features = ["derive"] }
+envy = "0.4"
 
 [dev-dependencies]
 tracing = { workspace = true, features = ["release_max_level_info"] }

events/tag/Cargo.toml

@@ -1,6 +1,7 @@
 use std::net::SocketAddr;
 
 use clap::Parser;
+use serde::Deserialize;
 use tag::init_game;
 use tracing_subscriber::{EnvFilter, Registry, layer::SubscriberExt};
 // use tracing_tracy::TracyLayer;
@@ -10,16 +11,27 @@ use tracing_subscriber::{EnvFilter, Registry, layer::SubscriberExt};
 static GLOBAL: tikv_jemallocator::Jemalloc = tikv_jemallocator::Jemalloc;
 
 /// The arguments to run the server
-#[derive(Parser)]
+#[derive(Parser, Deserialize, Debug)]
 struct Args {
     /// The IP address the server should listen on. Defaults to 0.0.0.0
     #[clap(short, long, default_value = "0.0.0.0")]
+    #[serde(default = "default_ip")]
     ip: String,
+
     /// The port the server should listen on. Defaults to 25565
     #[clap(short, long, default_value = "35565")]
+    #[serde(default = "default_port")]
     port: u16,
 }
 
+fn default_ip() -> String {
+    "0.0.0.0".to_string()
+}
+
+const fn default_port() -> u16 {
+    35565
+}
+
 fn setup_logging() {
     tracing::subscriber::set_global_default(
         Registry::default()
@@ -41,9 +53,22 @@ fn main() {
 
     setup_logging();
 
-    let Args { ip, port } = Args::parse();
+    // Try to load config from environment variables
+    let args = match envy::prefixed("TAG_").from_env::<Args>() {
+        Ok(args) => {
+            tracing::info!("Loaded configuration from environment variables");
+            args
+        }
+        Err(e) => {
+            tracing::info!(
+                "Failed to load from environment: {}, falling back to command line arguments",
+                e
+            );
+            Args::parse()
+        }
+    };
 
-    let address = format!("{ip}:{port}");
+    let address = format!("{ip}:{port}", ip = args.ip, port = args.port);
     let address = address.parse::<SocketAddr>().unwrap();
 
     init_game(address).unwrap();