Installing ODataDB

Installing ODataDB

ODataDB is an ASP.NET Core 3.0 application build on the cross-platform Kestrel web server for ASP.NET Core.

Kestrel can be used by itself or with a reverse proxy server, such as Internet Information Services (IIS), Nginx, or Apache.

Below are useful links to learn about installing and tuning ASP.NET Core applications in different scenarios:

Below are the short step-by-step guides that help to deploy ODataDB for the first time.

Go to Installing ODataDB on Linux.

Installing ODataDB on Windows

  1. Enable IIS on your machine.
  2. Install the .NET Core Hosting Bundle
  3. Restart IIS.
  4. Copy the odatadb subfolder from the ODataDB download package to your local drive. For example, copy it to C:\inetpub folder.
  5. Add connection strings for your databases to the appsettings.Production.json file.
  6. Create an ODataDB application pool.
  7. Create an ODataDB website or application.

Creating ODataDB Application Pool

To create an application pool, open the IIS Manager, select Application Pools, and click the Add Application Pool... action.

Use the following values:

ODataDB Installation on Windows - Creating Application Pool

Creating ODataDB Website

Use this scenario to create a subdomain like odatadb.contoso.com.

Also, use it to create a local website accessible through a URL like http://odatadb.

In this case, also add the following line to the c:\windows\system32\drivers\etc\hosts file:

127.0.0.1 odatadb

To create a website, select the Sites node and click the Add Website... action.

Then use the following values:

ODataDB Installation on Windows - Creating Website

Note that it is important to choose the odatadb application pool created in the previous step.

To test the local website installation, open the URL:

http://odatadb

You have to see the index page. Play with samples. ODataDB loads data from an online SQL Server database.

For example, try the s02_cashbook table:

ODataDB Website - s02.cashbook

Configuring HTTPS Certificate

Do not use ODataDB over HTTP as it uses the basic authentication and sends logins and passwords as plain text.

Always turn on HTTPS and redirect HTTP to HTTPS.

Below are steps to create a self-signed certificate.

  1. Open Windows PowerShell (Admin) and execute the command:
    New-SelfSignedCertificate -NotBefore (Get-Date) -NotAfter (Get-Date).AddYears(5) -DnsName "localhost", "odatadb" -KeyAlgorithm "RSA" -KeyLength 2048 -HashAlgorithm "SHA256" -CertStoreLocation "Cert:\LocalMachine\My" -KeyUsage KeyEncipherment -FriendlyName "ODataDB Certificate" -TextExtension @("2.5.29.19={critical}{text}","2.5.29.37={critical}{text}1.3.6.1.5.5.7.3.1")
    
    It creates a self-signed sertificate for localhost and odatadb hosts. See more details here: New-SelfSignedCertificate
  2. Open certlm.msc and copy the ODataDB Certificate from the Personal Certificates store to Trusted Root Certification Authorities.
  3. Open IIS Manager, select Default Web Site and its bindings.
    Select https, click Edit..., and select ODataDB Certificate in the SSL Certificate list. Click OK.

To roll back the changes, restore the initial SSL certificate first and then delete the ODataDB Certificate using the certlm.msc.

Creating ODataDB Application

Use this scenario to create an application like www.contoso.com/odatadb or localhost/odatadb.

To create an application, select the desired web site node, right-click on it, and click the Add Application... action.

Then use the following values:

ODataDB Installation on Windows - Creating Application

Note that it is important to choose the odatadb application pool created in the previous step.

Using ODataDB as an IIS application requires an additional step:

- replace the <base href="/"> line to <base href="/odatadb/"> in the following files:

To test the localhost application, open the URL:

http://localhost/odatadb

You have to see the index page. Play with samples. ODataDB loads data from an online SQL Server database.

For example, try the s02_cashbook table:

ODataDB Application - s02.cashbook

Installing ODataDB on Linux

Here are the complete guides:

In short, make the following steps:

  1. Install the ASP.NET Core Runtime
  2. Copy the odatadb subfolder from the ODataDB download package to the /var/www folder.
  3. Add connection strings for your databases to the appsettings.Production.json file.
  4. Check or change the default Kestrel ODataDB port 5002 in the appsettings.Production.json file.
  5. Create a service file to manage the Kestrel process and enable the service.
  6. Create an odatadb subdomain.
  7. Configure an HTTPS certificate.

Creating a service file to manage the Kestrel process and enabling the service

Here is a complete guide: Create the service file

We recommend creating the /etc/systemd/system/kestrel-odatadb.service file with the following content:

[Unit]
Description=odatadb

[Service]
WorkingDirectory=/var/www/odatadb
ExecStart=/usr/bin/dotnet /var/www/odatadb/odatadb.dll
Restart=on-failure
Restart=always
# Restart service after 10 seconds if the dotnet service crashes:
RestartSec=10
KillSignal=SIGINT
SyslogIdentifier=dotnet-odatadb
User=www-data
Environment=ASPNETCORE_ENVIRONMENT=Production
Environment=DOTNET_PRINT_TELEMETRY_MESSAGE=false

[Install]
WantedBy=multi-user.target

After creating the file, enable and start the service:

sudo systemctl enable kestrel-odatadb.service
sudo systemctl start  kestrel-odatadb.service
sudo systemctl status kestrel-odatadb.service

To test the service, try to get data using a command like this:

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

Create an odatadb subdomain

To create a subdomain, make the following steps:

  1. Create the DNS A record for your domain.
  2. Add a subdomain section to your domain configuration file.

Here is an Nginx configuration of the samples.odatadb.com subdomain:

server {

    server_name samples.odatadb.com;

    location / {
        proxy_pass         http://localhost:5002;
        proxy_http_version 1.1;
        proxy_set_header   Upgrade $http_upgrade;
        proxy_set_header   Connection keep-alive;
        proxy_set_header   Host $host;
        proxy_cache_bypass $http_upgrade;
        proxy_set_header   X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header   X-Forwarded-Proto $scheme;
    }
}

Configuring an HTTPS certificate

We recommend reading this resource: Secure HTTP Traffic with Certbot