Zum Hauptinhalt springen

Installation

Install on Windows#

qmBase can be installed on Windows.

Prerequisites#

  • MS SQL 2019 Database
  • Windows 10 Pro or higher
  • ASP.NET Core Hosting Bundle 5.0.x
  • IIS Webserver V 10
  • SSL Certificate Public or self signed
  • Hardware requirements
    • min 4 GB Ram
    • min 10 GB HDD

Recommended Folder Structure#

  • D:\qmbase\
    • app\ -> Save the app data here
    • builds\ -> Save old builds here if you need to roll back an update
    • databases\ -> Store databases here
    • uploads\{CustomerId}\ -> Save user generated uploads here
note

Use a dedidacted partition (D:\) to store the data.

How to install?#

  1. Download the latest qmBase version from here. You will get the credentials via mail after you have signed the contract.

  2. Extract the ZIP file to the folder where the IIS is located.

  3. Run the latest database migrations. The SQL scripts will be provided on the download page as well. You will need to create 2 databases. Use the following name schema

    • multi-tenant
    • qmbase{CustomerId}
  4. qmBase requires a SSL connection. So you have to configure the IIS to use either a self signed certificate or use a regular certificate.

  5. Configure qmBase and start running.

Configure qmBase#

To configure qmBase you have take actions in 2 different places.

Insert this row in your multi tenant database

INSERT INTO [yourDatabase].[dbo].[MultiTenants]
(
,[DatabaseType]
,[Host]
,[ConnectionString]
,[StorageConnectionString]
,[Name]
,[CustomerId]
)
VALUES
(
,0
,pathToYour.qmbase
,SQL Connection string
,NULL
,yourCustomerName
,yourCustomerId
)

Change the appSettings.Production.json file

// These settings will only be applied if HostingEnvironment is "Production"
// Use this file to customize the behavior in Production
{
//ApplicationInsights settings omitted for brevity.
"ConnectionStrings": {
"MultiTenantConnection": "Connection string to multiTenantContext",
// These settings are not needed if multiTenant==true
"DefaultConnection": "Your Ms SQL ConnectionString -> not needed in MultiTenantScenario"
},
"AppSettings": {
"MultiTenantContext": true,
"StorageType": "FileSystem", //"FileSystem" | "AzureBlobStorage"
"PhysicalFileProviderRootPath": "D:\\qmbase\\uploads"
}
}

How to update?#

We are improving qmBase continuously. That means that we are releasing multiple Updates per Day. So if you are experiencing any bugs you can always try to download the latest release.

  1. Delete all files in app folder except web.config and appSettings.Production.json.
  2. Extract the zip file from the update and copy all files except web.config and appSettings.Production.json to the app folder.

qmBase.Installer#

Alternatively you can use the qmBase.Installer.exe. If you use the default configuration you can do 9 out of 10 updates automatically. Please note that the qmBase.Installer is part of the Enterprise subscription.

Install on Linux#

Possible but not yet documented

Breaking Changes#

Deployment Status#

Status
BuildBuild status
Deployment

Tools & Frameworks we use#

qmBase builds upon modern and popular technologies. For our backend we use

  • ASP.NET 5.0

For our frontend we use

  • React
  • Code is written in TypeScript
Last updated on