Quick Start Guide for Using DBGate on Windows and Linux

Table of Contents

• Quick Start on Windows
• Quick Start on Linux

Quick Start on Windows

Using the Portable Package

1. Download the DBGate portable package.
2. Unzip it to any folder on your local drive.
3. Run dbgate.exe from the dbgate subfolder.

Using the Installer Package

1. Download the DBGate installer package.
2. Unzip it to any folder on your local drive.
3. Run setup.exe to install DBGate.
4. Run dbgate.exe from the C:\Program Files\DBGate\dbgate folder.

You should see the following console application:

If the console doesn't appear, run setup.exe from the dbgate folder and follow the wizard to install the ASP.NET Core Runtime.

Alternatively, you can download and install the Hosting Bundle, which includes the ASP.NET Core Runtime and IIS support, from:

• https://dotnet.microsoft.com/en-us/download/dotnet/8.0

Once the console app is running, open the following URLs in your browser: http://localhost:5003/ or https://localhost:5003/

You should see the index page.

Click on the mssql-023 connection and open the cashbook table of the online sample:

Next, try connecting to your local SQL Server, MySQL, and PostgreSQL databases from the home page or using these direct URLs:

• http://localhost:5003/edit/mssql/
• http://localhost:5003/edit/mysql/
• http://localhost:5003/edit/pgsql/

You can view and edit data for free!

To connect to remote databases, add the server and database to the connection string like this: /edit/mssql:mssql.savetodb.com,AzureDemo100/.

At this point, you've tested both local and remote connections.

Now, run setup.exe from the dbgate folder or use the DBGate Setup link from the Start menu.

The wizard will help you configure an IIS website, IIS application, or a Windows service, along with HTTPS settings.

For more details, check out installing DBGate under IIS.

You can add connections to all your servers and databases. See appsettings and DBGate endpoints for more information.

Quick Start on Linux

Using the Portable Package

1. Download the DBGate package.
2. Unzip it and copy the dbgate folder to /var/www.
3. Navigate to the /var/www/dbgate folder and run: dotnet dbgate.dll

You should see the following response:

If DBGate fails to start, install the ASP.NET Core Runtime by following the instructions at:

• https://dotnet.microsoft.com/en-us/download/dotnet/8.0

Once DBGate is running, you can retrieve data using a command like:

curl http://localhost:5003/api/mssql-023/cashbook

You should see data from the online SQL Server database.

Press Ctrl-C to close the app and refer to the next steps in how to install DBGate on Linux.