From e9ac4faa407bfdf027c87dec52b3be2d4face778 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20K=C3=B6nig?= Date: Wed, 2 Jul 2025 12:45:51 +0200 Subject: [PATCH 1/5] feat: remove dbNamePrefix from the connector config --- _docs_operate/configuration.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/_docs_operate/configuration.md b/_docs_operate/configuration.md index d48bfc4d3..98073fd59 100644 --- a/_docs_operate/configuration.md +++ b/_docs_operate/configuration.md @@ -196,19 +196,13 @@ aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - **dbName** `default: "default"` - The `dbName` string is used as the name of the MongoDB database, prefixed with `acc-`. You can use any name you like, but keep in mind that changing it later will NOT rename the database. Instead a new database will be created, together with a new enmeshed Identity. Even though the old database will still exist, the Connector will not be able to access the data until you change the `dbName` back to its original value. + The `dbName` string is used as the name of the MongoDB database. You can use any name you like, but keep in mind that changing it later will NOT rename the database. Instead a new database will be created, together with a new enmeshed Identity. Even though the old database will still exist, the Connector will not be able to access the data until you change the `dbName` back to its original value. If you would like to use multiple Connectors with distinct Identities (one Identity per Connector) running on the same database, you have to specify a unique `dbName` for each of them. **Note:** If you are using the Connector in combintation with a FerretDB, you have to pay attention to the database name restrictions specified in the [FerretDB documentation](https://docs.ferretdb.io/diff/). {: .notice--warning} -- **dbNamePrefix** `default: "acc-"` - - The `dbNamePrefix` string is used as a prefix for the MongoDB database name. It will be **prepended** to the string configured by the `dbName` property. - - If you don't want your database name to be prefixed, you can set this value to an empty string. - ### infrastructure Each infrastructure can be enabled or disabled by passing true / false to `enabled`. @@ -367,6 +361,7 @@ It is not recommended to use this Module for production scenarios. Here you can define multiple brokers to which the Connector should publish messages. Each broker consists of a `type` (string) and a `configuration` object. The `type` specifies the type of the broker (e.g. `AMQP` or `PubSub`) and the `configuration` object contains the configuration for the broker. + - type `AMQP` **example** @@ -382,6 +377,7 @@ It is not recommended to use this Module for production scenarios. ``` **configuration** + - url `string, required` - the URL of the AMQP broker @@ -410,6 +406,7 @@ It is not recommended to use this Module for production scenarios. ``` **configuration** + - url `string, required` the URL of the MQTT broker @@ -432,6 +429,7 @@ It is not recommended to use this Module for production scenarios. ``` **configuration** + - projectId `string, required` the project id of the Google Cloud project @@ -458,6 +456,7 @@ It is not recommended to use this Module for production scenarios. ``` **configuration** + - url `string, required` the URL of the broker @@ -524,6 +523,7 @@ It is not recommended to use this Module for production scenarios. **OAuth2** The OAuth2 authentication type is used to authenticate the request to the webhook using the client credentials flow of OAuth2. The Connector will send a bearer token as part of the request in its Authentication header. The OAuth2 authentication is configured using the following parameters: + - **type** `"OAuth2", required` The type of the authentication. @@ -547,6 +547,7 @@ It is not recommended to use this Module for production scenarios. **ApiKey** The ApiKey authentication type is used to authenticate the request to the webhook using an API key. The Connector will send the API key as part of the request using a header. The ApiKey authentication is configured using the following parameters: + - **type** `"ApiKey", required` The type of the authentication. From 8a920bd0ce77426dc6239de0da18275539fdba50 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20K=C3=B6nig?= Date: Wed, 2 Jul 2025 12:48:56 +0200 Subject: [PATCH 2/5] feat: add entry to the migration guide --- _docs_integrate/migration-from-v6-to-v7.md | 1 + 1 file changed, 1 insertion(+) diff --git a/_docs_integrate/migration-from-v6-to-v7.md b/_docs_integrate/migration-from-v6-to-v7.md index 4e4edbd08..51e3e2980 100644 --- a/_docs_integrate/migration-from-v6-to-v7.md +++ b/_docs_integrate/migration-from-v6-to-v7.md @@ -37,6 +37,7 @@ The step-by-step instructions can be consulted to start the migration to version For this reason, the old data must be deleted. Alternatively, the database can be deleted as a whole and [set up again]({% link _docs_operate/setup-with-docker-compose.md %}). - The [image](https://github.com/nmshd/connector?tab=readme-ov-file#connector) used to run the Connector must be updated to version 7. +- The configuration value `database.dbNamePrefix` in the Connector was removed. Before it defaulted to `acc-`. If you want to access a database called `acc-connector`, you have to set the `database.dbName` configuration value to `acc-connector` instead of `connector` only. ### Removed and Changed Data Structures From cee08ba77c65fd4e4097333297f392e873e78ea4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20K=C3=B6nig?= Date: Wed, 2 Jul 2025 14:16:31 +0200 Subject: [PATCH 3/5] chore: formatting --- _docs_operate/configuration.md | 7 ------- 1 file changed, 7 deletions(-) diff --git a/_docs_operate/configuration.md b/_docs_operate/configuration.md index 98073fd59..1748cd0ae 100644 --- a/_docs_operate/configuration.md +++ b/_docs_operate/configuration.md @@ -361,7 +361,6 @@ It is not recommended to use this Module for production scenarios. Here you can define multiple brokers to which the Connector should publish messages. Each broker consists of a `type` (string) and a `configuration` object. The `type` specifies the type of the broker (e.g. `AMQP` or `PubSub`) and the `configuration` object contains the configuration for the broker. - - type `AMQP` **example** @@ -377,7 +376,6 @@ It is not recommended to use this Module for production scenarios. ``` **configuration** - - url `string, required` - the URL of the AMQP broker @@ -406,7 +404,6 @@ It is not recommended to use this Module for production scenarios. ``` **configuration** - - url `string, required` the URL of the MQTT broker @@ -429,7 +426,6 @@ It is not recommended to use this Module for production scenarios. ``` **configuration** - - projectId `string, required` the project id of the Google Cloud project @@ -456,7 +452,6 @@ It is not recommended to use this Module for production scenarios. ``` **configuration** - - url `string, required` the URL of the broker @@ -523,7 +518,6 @@ It is not recommended to use this Module for production scenarios. **OAuth2** The OAuth2 authentication type is used to authenticate the request to the webhook using the client credentials flow of OAuth2. The Connector will send a bearer token as part of the request in its Authentication header. The OAuth2 authentication is configured using the following parameters: - - **type** `"OAuth2", required` The type of the authentication. @@ -547,7 +541,6 @@ It is not recommended to use this Module for production scenarios. **ApiKey** The ApiKey authentication type is used to authenticate the request to the webhook using an API key. The Connector will send the API key as part of the request using a header. The ApiKey authentication is configured using the following parameters: - - **type** `"ApiKey", required` The type of the authentication. From 2adebe0abc27c1dd4139d0a208907db4215d1d7f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20K=C3=B6nig?= <33655937+jkoenig134@users.noreply.github.com> Date: Wed, 2 Jul 2025 15:14:08 +0200 Subject: [PATCH 4/5] Update _docs_integrate/migration-from-v6-to-v7.md Co-authored-by: Britta Stallknecht <146106656+britsta@users.noreply.github.com> --- _docs_integrate/migration-from-v6-to-v7.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_docs_integrate/migration-from-v6-to-v7.md b/_docs_integrate/migration-from-v6-to-v7.md index 51e3e2980..37a19f329 100644 --- a/_docs_integrate/migration-from-v6-to-v7.md +++ b/_docs_integrate/migration-from-v6-to-v7.md @@ -37,7 +37,7 @@ The step-by-step instructions can be consulted to start the migration to version For this reason, the old data must be deleted. Alternatively, the database can be deleted as a whole and [set up again]({% link _docs_operate/setup-with-docker-compose.md %}). - The [image](https://github.com/nmshd/connector?tab=readme-ov-file#connector) used to run the Connector must be updated to version 7. -- The configuration value `database.dbNamePrefix` in the Connector was removed. Before it defaulted to `acc-`. If you want to access a database called `acc-connector`, you have to set the `database.dbName` configuration value to `acc-connector` instead of `connector` only. +- The configuration value `database.dbNamePrefix` in the Connector was removed. Before, it defaulted to `acc-`. If you want to access a database called `acc-connector`, you have to set the `database.dbName` configuration value to `acc-connector` instead of `connector` only. ### Removed and Changed Data Structures From 0eb1512a1485ffa2636b504a547ad8d1e32ee632 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20K=C3=B6nig?= Date: Wed, 2 Jul 2025 15:15:12 +0200 Subject: [PATCH 5/5] chore: other comment --- _docs_integrate/migration-from-v6-to-v7.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_docs_integrate/migration-from-v6-to-v7.md b/_docs_integrate/migration-from-v6-to-v7.md index 37a19f329..1c1cdb5c7 100644 --- a/_docs_integrate/migration-from-v6-to-v7.md +++ b/_docs_integrate/migration-from-v6-to-v7.md @@ -37,7 +37,7 @@ The step-by-step instructions can be consulted to start the migration to version For this reason, the old data must be deleted. Alternatively, the database can be deleted as a whole and [set up again]({% link _docs_operate/setup-with-docker-compose.md %}). - The [image](https://github.com/nmshd/connector?tab=readme-ov-file#connector) used to run the Connector must be updated to version 7. -- The configuration value `database.dbNamePrefix` in the Connector was removed. Before, it defaulted to `acc-`. If you want to access a database called `acc-connector`, you have to set the `database.dbName` configuration value to `acc-connector` instead of `connector` only. +- The [configuration]({% link _docs_operate/configuration.md %}) value `database.dbNamePrefix` of the Connector was removed. Before, it defaulted to `acc-`. If you want to access a database called `acc-connector`, you have to set the `database.dbName` configuration value to `acc-connector` instead of `connector` only. ### Removed and Changed Data Structures