Is it possible to change listening ports?

[yorek]

Is it possible to set the listening TCP ports for service (instead of defaults 5000/5001) ?

[yorek]

While there are no specific configuration options in Data API builder at the moment, since it is a regular .NET Core application, you can use the ASPNETCORE_URLS variable to set the desired listening address and ports, as explained here:

https://learn.microsoft.com/en-us/aspnet/core/fundamentals/servers/kestrel/endpoints?view=aspnetcore-6.0#url-prefixes-1

With PowerShell, for example, you can do something like:

$env:ASPNETCORE_URLS="http://localhost:8080;https://localhost:8081"

if you are on Linux, instead:

export ASPNETCORE_URLS="http://localhost:8080;https://localhost:8081"

and the start Data API builder as usual via

dab start

and it will be listening on port 8080 and 8081

[fgbustoa]

OK.

So this means that i have an unique listening ports couple per machine.

Thus i cannot expose more than one database per machine: if i prepare two config json files, for two different databases, only the first service that i start will succeed, since the second will try to start listening onto the same ports.... and will fail.

[yorek]

That's a good point. I would say that right now, if you need to run DAB on the same machine, the best option is to run it in a container, so that each container can listen to a different port. For example:

docker run --name dab1 -it -v $pwd\config:/App/config -p 8080:5000 mcr.microsoft.com/azure-databases/data-api-builder:latest --ConfigFileName ./config/dab-config.json

and the you can run another one mapping it to port 8090:

docker run --name dab2 -it -v $pwd\config:/App/config -p 8090:5000 mcr.microsoft.com/azure-databases/data-api-builder:latest --ConfigFileName ./config/dab-config.json

provided that your config file is in the config folder.

I would recommend using docker-compose if also your database is running in a container, so that to simplify networking configuration: https://github.com/Azure/data-api-builder/blob/main/docs/running-using-a-container.md

[ClaudioG64]

Thank you @yorek (Ciao Davide !), great suggestions.

If you run run from Powershell something like:

$env:ASPNETCORE_URLS="http://$($env:ComputerName):8080;https://$($env:ComputerName):8081"
dab start

You end with a network accessible endpoint on all of your IPv4/v6 addresses.

So if you want to host multiple "Db-Api" pairs on a single machine, you just have to run multiple instances of Powershell with different ASPNETCORE_URLS env variable for each process.

[yorek]

Good point, thanks @ClaudioG64! (So happy to see you around!!!)

[seantleonard]

You can also modify the appsetting.json file with custom Kestrel endpoint settings to override the default ports per https://learn.microsoft.com/en-us/aspnet/core/fundamentals/servers/kestrel/endpoints?view=aspnetcore-6.0#configureiconfiguration

{
  "Logging": {
    "LogLevel": {
      "Default": "Error",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*",
  "Kestrel": {
    "Endpoints": {
      "Https": {
        "Url": "https://localhost:6543"
      }
    }
  }
}

[acolville]

I want to change to an IP address, rather than localhost to allow connections across the LAN, but neither of these options work. DAB always starts listening on localhost:5000/5001. Is it possible to change this?

[seantleonard]

How are you launching DAB? If your are using VSCode, you may need change the launchSettings.json file.

[acolville]

From a terminal window, I will try and find the LaunchSettings.json file is it in System32? Alistair Colville Director ***@***.*** t: e: w: 01983 882874 ***@***.******@***.***> https://www.colvillecare.co.uk<https://www.colvillecare.co.uk/> From: Sean Leonard ***@***.***> Sent: Wednesday, January 3, 2024 12:03 AM To: Azure/data-api-builder ***@***.***> Cc: Alistair Colville ***@***.***>; Comment ***@***.***> Subject: Re: [Azure/data-api-builder] Is it possible to change listening ports? (Discussion #1425) How are you launching DAB? If your are using VSCode, you may need change the launchSettings.json file. — Reply to this email directly, view it on GitHub<#1425 (reply in thread)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AX5G2HQS74U2ZDIX7UMXMIDYMSN2RAVCNFSM6AAAAAAWX2KASSVHI2DSMVQWIX3LMV43SRDJONRXK43TNFXW4Q3PNVWWK3TUHM3TSOJYGIYTE>. You are receiving this because you commented.Message ID: ***@***.******@***.***>>

[seantleonard]

Do you use dotnet run to launch DAB from the terminal? System32 should not be touched for changing DAB configuration. Here are the two files that are applicable to port/ip in the DAB project:

• https://github.com/Azure/data-api-builder/blob/main/src/Service/Properties/launchSettings.json
• https://github.com/Azure/data-api-builder/blob/main/src/Service/appsettings.json

In addition, here is the documentation for various hosting options of asp.net projects (which DAB is an asp.net project). You may benefit from hosting DAB with one of these mechanisms which their own specific ways of configuring host settings:

• https://learn.microsoft.com/aspnet/core/host-and-deploy/?view=aspnetcore-6.0

[acolville]

I followed the example for on-prem Overview to Azure data API builder | Microsoft Learn<https://learn.microsoft.com/en-us/azure/data-api-builder/overview-to-data-api-builder?tabs=azure-sql#run-data-api-builder-on-premises> so to run I just type” dab start” I will see if I can track down those files and have a look. Alistair Colville Director ***@***.*** t: e: w: 01983 882874 ***@***.******@***.***> https://www.colvillecare.co.uk<https://www.colvillecare.co.uk/> From: Sean Leonard ***@***.***> Sent: Wednesday, January 3, 2024 4:19 PM To: Azure/data-api-builder ***@***.***> Cc: Alistair Colville ***@***.***>; Comment ***@***.***> Subject: Re: [Azure/data-api-builder] Is it possible to change listening ports? (Discussion #1425) Do you use dotnet run to launch DAB from the terminal? System32 should not be touched for changing DAB configuration. Here are the two files that are applicable to port/ip in the DAB project: * https://github.com/Azure/data-api-builder/blob/main/src/Service/Properties/launchSettings.json * https://github.com/Azure/data-api-builder/blob/main/src/Service/appsettings.json In addition, here is the documentation for various hosting options of asp.net projects (which DAB is an asp.net project). You may benefit from hosting DAB with one of these mechanisms which their own specific ways of configuring host settings: * https://learn.microsoft.com/aspnet/core/host-and-deploy/?view=aspnetcore-6.0 — Reply to this email directly, view it on GitHub<#1425 (reply in thread)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AX5G2HXV5TXXEEG3UVP7AMDYMWAF3AVCNFSM6AAAAAAWX2KASSVHI2DSMVQWIX3LMV43SRDJONRXK43TNFXW4Q3PNVWWK3TUHM4DAMBUGYZTC>. You are receiving this because you commented.Message ID: ***@***.******@***.***>>

[acolville]

Many thanks, that is all running now. Alistair Colville Director ***@***.*** t: e: w: 01983 882874 ***@***.******@***.***> https://www.colvillecare.co.uk<https://www.colvillecare.co.uk/> From: Claudio Galletti ***@***.***> Sent: Wednesday, January 3, 2024 5:12 PM To: Azure/data-api-builder ***@***.***> Cc: Alistair Colville ***@***.***>; Comment ***@***.***> Subject: Re: [Azure/data-api-builder] Is it possible to change listening ports? (Discussion #1425) Thank you @yorek<https://github.com/yorek> (Ciao Davide !), great suggestions. If you run run from Powershell something like: $env:ASPNETCORE_URLS="http://$($env:ComputerName):8080;https://$($env:ComputerName):8081<http://$($env:ComputerName):8080;https:/$($env:ComputerName):8081>" dab start You end with a network accessible endpoint on all of your IPv4/v6 addresses. So if you want to host multiple "Db-Api" pairs on a single machine, you just have to run multiple instances of Powershell with different ASPNETCORE_URLS env variable for each process. — Reply to this email directly, view it on GitHub<#1425 (reply in thread)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AX5G2HSJ4PHIPXE73IQLYQTYMWGNTAVCNFSM6AAAAAAWX2KASSVHI2DSMVQWIX3LMV43SRDJONRXK43TNFXW4Q3PNVWWK3TUHM4DAMBVGE4DA>. You are receiving this because you commented.Message ID: ***@***.******@***.***>>

[pholcroft]

I just wanted to contribute another method to the above using a .env file, although you lose the extra security of an environment variable.
You only need a certificate if using https.

C:\ContactsAPI\.env
C:\ContactsAPI\dab-config.json
C:\ContactsAPI\Certificate\ContactsAPI.pfx

.env
АЅРΝЕТСОRЕ_URLЅ=httрѕ://*:5090
ASPNETCORE_Kestrel__Certificates__Default__Password="REPLACEWITHARANDOMPASSWORD"
ASPNETCORE_Kestrel__Certificates__Default__Path=C:\ContactsAPI\Certificate\ContactsAPI.pfx

CreateCert.ps1
$cert = New-SelfSignedCertificate -DnsName @("localhost") -CertStoreLocation "cert:\LocalMachine\My" -NotAfter (Get-Date).AddYears(10)
$certKeyPath = "C:\ContactsAPI\Certificate\ContactsAPI.pfx"
$password = ConvertTo-SecureString 'REPLACEWITHARANDOMPASSWORD' -AsPlainText -Force
$cert | Export-PfxCertificate -FilePath $certKeyPath -Password $password