From faf7134594749e59df1048d4dc2911d78d7e434b Mon Sep 17 00:00:00 2001 From: Kamil Kisiela Date: Mon, 20 Oct 2025 13:24:51 +0200 Subject: [PATCH] Rename default config file to router.config --- README.md | 10 +++++----- lib/router-config/src/lib.rs | 8 ++++---- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index c4b4eb978..8518fe9a3 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,8 @@ A fully open-source MIT-licensed GraphQL API router that can act as a [GraphQL federation](https://the-guild.dev/graphql/hive/federation) Router, built with Rust for maximum performance and robustness. > [!TIP] -> 🚀 [Blog post: Welcome Hive Router](https://the-guild.dev/graphql/hive/blog/welcome-hive-router) -> +> 🚀 [Blog post: Welcome Hive Router](https://the-guild.dev/graphql/hive/blog/welcome-hive-router) +> > Interested in the benchmark results? Check out the [Federation Gateway Performance comparison](https://the-guild.dev/graphql/hive/federation-gateway-performance) It can be run as a standalone binary or a Docker Image. Query planner can be used as a standalone Crate library. @@ -26,7 +26,7 @@ curl -o- https://raw.githubusercontent.com/graphql-hive/router/main/install.sh | Create a simple configuration file that points to your supergraph schema file: ```yaml -# hive-router.config.yaml +# router.config.yaml supergraph: source: file path: ./supergraph.graphql @@ -42,7 +42,7 @@ HIVE__SUPERGRAPH__PATH=./supergraph.graphql Then, run the router: ```bash -# By default, "hive-router.config.yaml" is used for configuration. Override it by setting "ROUTER_CONFIG_FILE_PATH=some-custom-file.yaml" +# By default, "router.config.yaml" is used for configuration. Override it by setting "ROUTER_CONFIG_FILE_PATH=some-custom-file.yaml" # If you are using env vars, make sure to set the variables before running the router. ./hive_router ``` @@ -71,7 +71,7 @@ Alternativly, you can mount the configuration file using `-v` and pass all other ```bash docker run \ -p 4000:4000 \ - -v ./hive-router.config.yaml:/app/hive-router.config.yaml \ + -v ./router.config.yaml:/app/router.config.yaml \ ghcr.io/graphql-hive/router:latest ``` diff --git a/lib/router-config/src/lib.rs b/lib/router-config/src/lib.rs index 49184d869..9c2f6e4f0 100644 --- a/lib/router-config/src/lib.rs +++ b/lib/router-config/src/lib.rs @@ -78,10 +78,10 @@ pub enum RouterConfigError { } static DEFAULT_FILE_NAMES: &[&str] = &[ - "hive-router.config.yaml", - "hive-router.config.yml", - "hive-router.config.json", - "hive-router.config.json5", + "router.config.yaml", + "router.config.yml", + "router.config.json", + "router.config.json5", ]; pub fn load_config(