From 6033ed842003fb59376f1f3db2ceccc38e97ecab Mon Sep 17 00:00:00 2001 From: Jonas Kaninda Date: Mon, 4 Nov 2024 07:37:47 +0100 Subject: [PATCH 1/2] readme: add contributing section --- README.md | 21 +++++++++++++++++++++ docs/quickstart.md | 2 ++ 2 files changed, 23 insertions(+) diff --git a/README.md b/README.md index 4d4b810..f9dc841 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,8 @@ It comes with a lot of integrated features, such as: ### 1. Initialize configuration +You can generate the configuration file using `config init` command. + ```shell docker run --rm --name goma-gateway \ -v "${PWD}/config:/config" \ @@ -262,3 +264,22 @@ middlewares: ## Requirement - Docker + +## Contributing + +The Goma Gateway project welcomes all contributors. We appreciate your help! + + +## Give a Star! ⭐ + +If you like or are using Goma Gateway, please give it a star. Thanks! + + +## License + +This project is licensed under the Apache 2.0 License. See the LICENSE file for details. + + +## Copyright + +Copyright (c) 2024 Jonas Kaninda \ No newline at end of file diff --git a/docs/quickstart.md b/docs/quickstart.md index 72dbaa6..522f180 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -9,6 +9,8 @@ nav_order: 2 ### 1. Initialize configuration +You can generate the configuration file using `config init` command. + ```shell docker run --rm --name goma-gateway \ -v "${PWD}/config:/config" \ From 0af2d394d346da7932f539d9ff69f04f96583fbc Mon Sep 17 00:00:00 2001 From: Jonas Kaninda Date: Mon, 4 Nov 2024 07:48:03 +0100 Subject: [PATCH 2/2] docs: update configuration --- README.md | 4 +++- docs/quickstart.md | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f9dc841..48712e6 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,9 @@ It comes with a lot of integrated features, such as: ### 1. Initialize configuration -You can generate the configuration file using `config init` command. +You can generate the configuration file using `config init --output /config/config.yml` command. + +The default configuration is automatically generated if any configuration file is not provided, and is available at `/config/goma.yml` ```shell docker run --rm --name goma-gateway \ diff --git a/docs/quickstart.md b/docs/quickstart.md index 522f180..3b08927 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -9,7 +9,9 @@ nav_order: 2 ### 1. Initialize configuration -You can generate the configuration file using `config init` command. +You can generate the configuration file using `config init --output /config/config.yml` command. + +The default configuration is automatically generated if any configuration file is not provided, and is available at `/config/goma.yml` ```shell docker run --rm --name goma-gateway \