Quick Start Guide for ODataDB 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 ODataDB portable package.
2. Unzip it to any folder on your local drive.
3. Navigate to the odatadb subfolder and run odatadb.exe.

Using the Installer Package

1. Download the ODataDB installer package.
2. Unzip it to any folder on your local drive.
3. Run setup.exe to install ODataDB.
4. After installation, run odatadb.exe from the C:\Program Files\ODataDB\odatadb folder.

You should see the following console application:

If the console does not appear, rerun setup.exe from the odatadb 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 URL in your browser: http://localhost:5002/ or https://localhost:5002/.

You should see the index page.

Click on the mssql-023 connection to access the cashbook table of the online sample:

At this point, you have a correctly installed application and online samples to explore ODataDB features.

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

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

You can view and edit data for free!

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

Now you've tested both local and remote connections.

To configure an IIS website, IIS application, or a Windows service, run the setup.exe wizard from the odatadb folder or use the ODataDB Setup link from the Start menu.

For more details, check out installing ODataDB under IIS.

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

Quick Start on Linux

Using the Portable Package

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

You should see the following response:

If ODataDB 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 ODataDB is running, test data retrieval with the following command:

curl http://localhost:5002/v4/mssql-023/cashbook

You should see data from an online SQL Server database.

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