terraform-docs: automated action

README.md

@@ -78,9 +78,14 @@ No modules.
 
 | Name | Type |
 |------|------|
+| [azurerm_app_service_certificate_binding.libre_app_cert_binding](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/app_service_certificate_binding) | resource |
+| [azurerm_app_service_custom_hostname_binding.hostname_binding](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/app_service_custom_hostname_binding) | resource |
+| [azurerm_app_service_managed_certificate.libre_app_cert](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/app_service_managed_certificate) | resource |
 | [azurerm_cognitive_account.az_openai](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/cognitive_account) | resource |
 | [azurerm_cognitive_deployment.az_openai_models](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/cognitive_deployment) | resource |
 | [azurerm_cosmosdb_account.az_openai_mongodb](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/cosmosdb_account) | resource |
+| [azurerm_dns_cname_record.cname_record](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/dns_cname_record) | resource |
+| [azurerm_dns_txt_record.domain_verification](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/dns_txt_record) | resource |
 | [azurerm_key_vault.az_openai_kv](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/key_vault) | resource |
 | [azurerm_key_vault_secret.libre_app_creds_iv](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/key_vault_secret) | resource |
 | [azurerm_key_vault_secret.libre_app_creds_key](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/key_vault_secret) | resource |
@@ -120,6 +125,7 @@ No modules.
 | <a name="input_cosmosdb_offer_type"></a> [cosmosdb\_offer\_type](#input\_cosmosdb\_offer\_type) | The offer type to use for the Cosmos DB account | `string` | `"Standard"` | no |
 | <a name="input_cosmosdb_public_network_access_enabled"></a> [cosmosdb\_public\_network\_access\_enabled](#input\_cosmosdb\_public\_network\_access\_enabled) | Whether to enable public network access for the Cosmos DB account | `bool` | `true` | no |
 | <a name="input_cosmosdb_virtual_network_subnets"></a> [cosmosdb\_virtual\_network\_subnets](#input\_cosmosdb\_virtual\_network\_subnets) | The virtual network subnets to associate with the Cosmos DB account (Service Endpoint). If networking is created as part of the module, this will be automatically populated. | `list(string)` | `null` | no |
+| <a name="input_dns_resource_group_name"></a> [dns\_resource\_group\_name](#input\_dns\_resource\_group\_name) | The Resource Group that contains the custom DNS Zone to use for the App Service | `string` | `"dns-rg"` | no |
 | <a name="input_kv_fw_allowed_ips"></a> [kv\_fw\_allowed\_ips](#input\_kv\_fw\_allowed\_ips) | value of key vault firewall allowed ip rules. | `list(string)` | `[]` | no |
 | <a name="input_kv_fw_bypass"></a> [kv\_fw\_bypass](#input\_kv\_fw\_bypass) | List of key vault firewall rules to bypass. | `string` | `"AzureServices"` | no |
 | <a name="input_kv_fw_default_action"></a> [kv\_fw\_default\_action](#input\_kv\_fw\_default\_action) | Default action for key vault firewall rules. | `string` | `"Deny"` | no |
@@ -130,14 +136,16 @@ No modules.
 | <a name="input_libre_app_allow_registration"></a> [libre\_app\_allow\_registration](#input\_libre\_app\_allow\_registration) | Allow Registration | `bool` | `true` | no |
 | <a name="input_libre_app_allow_social_login"></a> [libre\_app\_allow\_social\_login](#input\_libre\_app\_allow\_social\_login) | Allow Social Login | `bool` | `false` | no |
 | <a name="input_libre_app_allow_social_registration"></a> [libre\_app\_allow\_social\_registration](#input\_libre\_app\_allow\_social\_registration) | Allow Social Registration | `bool` | `false` | no |
-| <a name="input_libre_app_allowed_ip_address"></a> [libre\_app\_allowed\_ip\_address](#input\_libre\_app\_allowed\_ip\_address) | The IP Address to allow access to the LibreChat App Service from. (Change to your IP Address). default is allow all | `string` | `"0.0.0.0/0"` | no |
+| <a name="input_libre_app_allowed_ip_addresses"></a> [libre\_app\_allowed\_ip\_addresses](#input\_libre\_app\_allowed\_ip\_addresses) | Allowed IP Addresses. The CIDR notation of the IP or IP Range to match to allow. For example: 10.0.0.0/24 or 192.168.10.1/32 | <pre>list(object({<br>    ip_address = string<br>    priority   = number<br>    name       = string<br>    action     = string<br>  }))</pre> | <pre>[<br>  {<br>    "action": "Allow",<br>    "ip_address": "0.0.0.0/0",<br>    "name": "ip-access-rule1",<br>    "priority": 300<br>  }<br>]</pre> | no |
+| <a name="input_libre_app_allowed_subnets"></a> [libre\_app\_allowed\_subnets](#input\_libre\_app\_allowed\_subnets) | Allowed Subnets (By default the subnet the app service is deployed in is allowed access already as priority 100). Add any additionals here | <pre>list(object({<br>    virtual_network_subnet_id = string<br>    priority                  = number<br>    name                      = string<br>    action                    = string<br>  }))</pre> | <pre>[<br>  {<br>    "action": "Allow",<br>    "name": "subnet-access-rule1",<br>    "priority": 200,<br>    "virtual_network_subnet_id": "subnet_id1"<br>  }<br>]</pre> | no |
 | <a name="input_libre_app_az_oai_api_key"></a> [libre\_app\_az\_oai\_api\_key](#input\_libre\_app\_az\_oai\_api\_key) | Azure OpenAI API Key | `string` | `null` | no |
 | <a name="input_libre_app_az_oai_api_version"></a> [libre\_app\_az\_oai\_api\_version](#input\_libre\_app\_az\_oai\_api\_version) | Azure OpenAI API Version | `string` | `"2023-07-01-preview"` | no |
 | <a name="input_libre_app_az_oai_dall3_api_version"></a> [libre\_app\_az\_oai\_dall3\_api\_version](#input\_libre\_app\_az\_oai\_dall3\_api\_version) | Azure OpenAI DALL-E API Version | `string` | `"2023-12-01-preview"` | no |
 | <a name="input_libre_app_az_oai_dall3_deployment_name"></a> [libre\_app\_az\_oai\_dall3\_deployment\_name](#input\_libre\_app\_az\_oai\_dall3\_deployment\_name) | Azure OpenAI DALL-E Deployment Name | `string` | `"dall-e-3"` | no |
 | <a name="input_libre_app_az_oai_instance_name"></a> [libre\_app\_az\_oai\_instance\_name](#input\_libre\_app\_az\_oai\_instance\_name) | Azure OpenAI Instance Name | `string` | `null` | no |
 | <a name="input_libre_app_az_oai_models"></a> [libre\_app\_az\_oai\_models](#input\_libre\_app\_az\_oai\_models) | Azure OpenAI Models. E.g. 'gpt-4-1106-preview,gpt-4,gpt-3.5-turbo,gpt-3.5-turbo-1106,gpt-4-vision-preview' | `string` | `"gpt-4-1106-preview"` | no |
 | <a name="input_libre_app_az_oai_use_model_as_deployment_name"></a> [libre\_app\_az\_oai\_use\_model\_as\_deployment\_name](#input\_libre\_app\_az\_oai\_use\_model\_as\_deployment\_name) | Azure OpenAI Use Model as Deployment Name | `bool` | `true` | no |
+| <a name="input_libre_app_custom_domain_create"></a> [libre\_app\_custom\_domain\_create](#input\_libre\_app\_custom\_domain\_create) | Create a custom domain and managed certificate for the App Service. | `bool` | `false` | no |
 | <a name="input_libre_app_custom_footer"></a> [libre\_app\_custom\_footer](#input\_libre\_app\_custom\_footer) | Add a custom footer for the App. | `string` | `"Privately hosted chat app powered by Azure OpenAI and LibreChat."` | no |
 | <a name="input_libre_app_debug_console"></a> [libre\_app\_debug\_console](#input\_libre\_app\_debug\_console) | Enable verbose server output in the console, though it's not recommended due to high verbosity. | `bool` | `false` | no |
 | <a name="input_libre_app_debug_logging"></a> [libre\_app\_debug\_logging](#input\_libre\_app\_debug\_logging) | LibreChat has central logging built into its backend (api). Log files are saved in /api/logs. Error logs are saved by default. Debug logs are enabled by default but can be turned off if not desired. | `bool` | `false` | no |
@@ -157,7 +165,9 @@ No modules.
 | <a name="input_libre_app_port"></a> [libre\_app\_port](#input\_libre\_app\_port) | The host port to listen on. | `number` | `3080` | no |
 | <a name="input_libre_app_public_network_access_enabled"></a> [libre\_app\_public\_network\_access\_enabled](#input\_libre\_app\_public\_network\_access\_enabled) | Whether or not public network access is enabled. Defaults to `false`. | `bool` | `true` | no |
 | <a name="input_libre_app_title"></a> [libre\_app\_title](#input\_libre\_app\_title) | Add a custom title for the App. | `string` | `"PrivateGPT"` | no |
-| <a name="input_libre_app_virtual_network_subnet_id"></a> [libre\_app\_virtual\_network\_subnet\_id](#input\_libre\_app\_virtual\_network\_subnet\_id) | The ID of the subnet to deploy the LibreChat App Service in. | `string` | `null` | no |
+| <a name="input_libre_app_virtual_network_subnet_id"></a> [libre\_app\_virtual\_network\_subnet\_id](#input\_libre\_app\_virtual\_network\_subnet\_id) | The ID of the subnet, used to allow access to the App Service (priority 100), e.g. cosmosdb, meilisearch etc. If networking is created as part of the module, this will be automatically populated if value is 'null'. | `string` | `null` | no |
+| <a name="input_librechat_app_custom_dns_zone_name"></a> [librechat\_app\_custom\_dns\_zone\_name](#input\_librechat\_app\_custom\_dns\_zone\_name) | The DNS Zone to use for the App Service. | `string` | `"domain.com"` | no |
+| <a name="input_librechat_app_custom_domain_name"></a> [librechat\_app\_custom\_domain\_name](#input\_librechat\_app\_custom\_domain\_name) | The custom domain to use for the App Service. | `string` | `"privategpt"` | no |
 | <a name="input_location"></a> [location](#input\_location) | Azure region where resources will be hosted. | `string` | `"uksouth"` | no |
 | <a name="input_oai_account_name"></a> [oai\_account\_name](#input\_oai\_account\_name) | The name of the OpenAI service. | `string` | `"az-openai-account"` | no |
 | <a name="input_oai_custom_subdomain_name"></a> [oai\_custom\_subdomain\_name](#input\_oai\_custom\_subdomain\_name) | The subdomain name used for token-based authentication. Changing this forces a new resource to be created. (normally the same as the account name) | `string` | `"demo-account"` | no |

tests/auto_test1/README.md

@@ -43,6 +43,7 @@ No requirements.
 | <a name="input_cosmosdb_offer_type"></a> [cosmosdb\_offer\_type](#input\_cosmosdb\_offer\_type) | The offer type to use for the Cosmos DB account | `string` | `"Standard"` | no |
 | <a name="input_cosmosdb_public_network_access_enabled"></a> [cosmosdb\_public\_network\_access\_enabled](#input\_cosmosdb\_public\_network\_access\_enabled) | Whether to enable public network access for the Cosmos DB account | `bool` | `true` | no |
 | <a name="input_cosmosdb_virtual_network_subnets"></a> [cosmosdb\_virtual\_network\_subnets](#input\_cosmosdb\_virtual\_network\_subnets) | The virtual network subnets to associate with the Cosmos DB account (Service Endpoint). If networking is created as part of the module, this will be automatically populated. | `list(string)` | `null` | no |
+| <a name="input_dns_resource_group_name"></a> [dns\_resource\_group\_name](#input\_dns\_resource\_group\_name) | The Resource Group that contains the custom DNS Zone to use for the App Service | `string` | `"dns-rg"` | no |
 | <a name="input_kv_fw_allowed_ips"></a> [kv\_fw\_allowed\_ips](#input\_kv\_fw\_allowed\_ips) | value of key vault firewall allowed ip rules. | `list(string)` | `[]` | no |
 | <a name="input_kv_fw_bypass"></a> [kv\_fw\_bypass](#input\_kv\_fw\_bypass) | List of key vault firewall rules to bypass. | `string` | `"AzureServices"` | no |
 | <a name="input_kv_fw_default_action"></a> [kv\_fw\_default\_action](#input\_kv\_fw\_default\_action) | Default action for key vault firewall rules. | `string` | `"Deny"` | no |
@@ -53,14 +54,16 @@ No requirements.
 | <a name="input_libre_app_allow_registration"></a> [libre\_app\_allow\_registration](#input\_libre\_app\_allow\_registration) | Allow Registration | `bool` | `true` | no |
 | <a name="input_libre_app_allow_social_login"></a> [libre\_app\_allow\_social\_login](#input\_libre\_app\_allow\_social\_login) | Allow Social Login | `bool` | `false` | no |
 | <a name="input_libre_app_allow_social_registration"></a> [libre\_app\_allow\_social\_registration](#input\_libre\_app\_allow\_social\_registration) | Allow Social Registration | `bool` | `false` | no |
-| <a name="input_libre_app_allowed_ip_address"></a> [libre\_app\_allowed\_ip\_address](#input\_libre\_app\_allowed\_ip\_address) | The IP Address to allow access to the LibreChat App Service from. (Change to your IP Address). default is allow all | `string` | `"0.0.0.0/0"` | no |
+| <a name="input_libre_app_allowed_ip_addresses"></a> [libre\_app\_allowed\_ip\_addresses](#input\_libre\_app\_allowed\_ip\_addresses) | Allowed IP Addresses. The CIDR notation of the IP or IP Range to match to allow. For example: 10.0.0.0/24 or 192.168.10.1/32 | <pre>list(object({<br>    ip_address = string<br>    priority   = number<br>    name       = string<br>    action     = string<br>  }))</pre> | <pre>[<br>  {<br>    "action": "Allow",<br>    "ip_address": "0.0.0.0/0",<br>    "name": "ip-access-rule1",<br>    "priority": 300<br>  }<br>]</pre> | no |
+| <a name="input_libre_app_allowed_subnets"></a> [libre\_app\_allowed\_subnets](#input\_libre\_app\_allowed\_subnets) | Allowed Subnets (By default the subnet the app service is deployed in is allowed access already as priority 100). Add any additionals here | <pre>list(object({<br>    virtual_network_subnet_id = string<br>    priority                  = number<br>    name                      = string<br>    action                    = string<br>  }))</pre> | <pre>[<br>  {<br>    "action": "Allow",<br>    "name": "subnet-access-rule1",<br>    "priority": 200,<br>    "virtual_network_subnet_id": "subnet_id1"<br>  }<br>]</pre> | no |
 | <a name="input_libre_app_az_oai_api_key"></a> [libre\_app\_az\_oai\_api\_key](#input\_libre\_app\_az\_oai\_api\_key) | Azure OpenAI API Key | `string` | `null` | no |
 | <a name="input_libre_app_az_oai_api_version"></a> [libre\_app\_az\_oai\_api\_version](#input\_libre\_app\_az\_oai\_api\_version) | Azure OpenAI API Version | `string` | `"2023-07-01-preview"` | no |
 | <a name="input_libre_app_az_oai_dall3_api_version"></a> [libre\_app\_az\_oai\_dall3\_api\_version](#input\_libre\_app\_az\_oai\_dall3\_api\_version) | Azure OpenAI DALL-E API Version | `string` | `"2023-12-01-preview"` | no |
 | <a name="input_libre_app_az_oai_dall3_deployment_name"></a> [libre\_app\_az\_oai\_dall3\_deployment\_name](#input\_libre\_app\_az\_oai\_dall3\_deployment\_name) | Azure OpenAI DALL-E Deployment Name | `string` | `"dall-e-3"` | no |
 | <a name="input_libre_app_az_oai_instance_name"></a> [libre\_app\_az\_oai\_instance\_name](#input\_libre\_app\_az\_oai\_instance\_name) | Azure OpenAI Instance Name | `string` | `null` | no |
 | <a name="input_libre_app_az_oai_models"></a> [libre\_app\_az\_oai\_models](#input\_libre\_app\_az\_oai\_models) | Azure OpenAI Models. E.g. 'gpt-4-1106-preview,gpt-4,gpt-3.5-turbo,gpt-3.5-turbo-1106,gpt-4-vision-preview' | `string` | `"gpt-4-1106-preview"` | no |
 | <a name="input_libre_app_az_oai_use_model_as_deployment_name"></a> [libre\_app\_az\_oai\_use\_model\_as\_deployment\_name](#input\_libre\_app\_az\_oai\_use\_model\_as\_deployment\_name) | Azure OpenAI Use Model as Deployment Name | `bool` | `true` | no |
+| <a name="input_libre_app_custom_domain_create"></a> [libre\_app\_custom\_domain\_create](#input\_libre\_app\_custom\_domain\_create) | Create a custom domain and managed certificate for the App Service. | `bool` | `false` | no |
 | <a name="input_libre_app_custom_footer"></a> [libre\_app\_custom\_footer](#input\_libre\_app\_custom\_footer) | Add a custom footer for the App. | `string` | `"Privately hosted chat app powered by Azure OpenAI and LibreChat."` | no |
 | <a name="input_libre_app_debug_console"></a> [libre\_app\_debug\_console](#input\_libre\_app\_debug\_console) | Enable verbose server output in the console, though it's not recommended due to high verbosity. | `bool` | `false` | no |
 | <a name="input_libre_app_debug_logging"></a> [libre\_app\_debug\_logging](#input\_libre\_app\_debug\_logging) | LibreChat has central logging built into its backend (api). Log files are saved in /api/logs. Error logs are saved by default. Debug logs are enabled by default but can be turned off if not desired. | `bool` | `false` | no |
@@ -81,7 +84,9 @@ No requirements.
 | <a name="input_libre_app_port"></a> [libre\_app\_port](#input\_libre\_app\_port) | The host port to listen on. | `number` | `3080` | no |
 | <a name="input_libre_app_public_network_access_enabled"></a> [libre\_app\_public\_network\_access\_enabled](#input\_libre\_app\_public\_network\_access\_enabled) | Whether or not public network access is enabled. Defaults to `false`. | `bool` | `true` | no |
 | <a name="input_libre_app_title"></a> [libre\_app\_title](#input\_libre\_app\_title) | Add a custom title for the App. | `string` | `"PrivateGPT"` | no |
-| <a name="input_libre_app_virtual_network_subnet_id"></a> [libre\_app\_virtual\_network\_subnet\_id](#input\_libre\_app\_virtual\_network\_subnet\_id) | The ID of the subnet to deploy the LibreChat App Service in. | `string` | `null` | no |
+| <a name="input_libre_app_virtual_network_subnet_id"></a> [libre\_app\_virtual\_network\_subnet\_id](#input\_libre\_app\_virtual\_network\_subnet\_id) | The ID of the subnet, used to allow access to the App Service (priority 100), e.g. cosmosdb, meilisearch etc. If networking is created as part of the module, this will be automatically populated if value is 'null'. | `string` | `null` | no |
+| <a name="input_librechat_app_custom_dns_zone_name"></a> [librechat\_app\_custom\_dns\_zone\_name](#input\_librechat\_app\_custom\_dns\_zone\_name) | The DNS Zone to use for the App Service. | `string` | `"domain.com"` | no |
+| <a name="input_librechat_app_custom_domain_name"></a> [librechat\_app\_custom\_domain\_name](#input\_librechat\_app\_custom\_domain\_name) | The custom domain to use for the App Service. | `string` | `"privategpt"` | no |
 | <a name="input_location"></a> [location](#input\_location) | Azure region where resources will be hosted. | `string` | `"uksouth"` | no |
 | <a name="input_oai_account_name"></a> [oai\_account\_name](#input\_oai\_account\_name) | The name of the OpenAI service. | `string` | `"az-openai-account"` | no |
 | <a name="input_oai_custom_subdomain_name"></a> [oai\_custom\_subdomain\_name](#input\_oai\_custom\_subdomain\_name) | The subdomain name used for token-based authentication. Changing this forces a new resource to be created. (normally the same as the account name) | `string` | `"demo-account"` | no |