Difference between revisions of "Lianja Server Manager on Windows"
Yvonne.milne (Talk | contribs) |
Yvonne.milne (Talk | contribs) (→Settings) |
||
(57 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | + | ==See Also== | |
+ | [[Lianja ODBC Driver on Linux]], [[Lianja ODBC Driver on Windows]], [[Lianja ODBC Manager on Windows]], [[Lianja Server Manager on Linux]], [[License Management on Windows]], [[SQL System Tables]] | ||
− | * Control the Lianja | + | ==The Lianja Server Manager== |
− | * Configure the Lianja SQL Server | + | The Lianja Server Manager allows you to: |
+ | |||
+ | * Control the Lianja Server service that listens for Lianja SQL Server and Lianja Cloud Server requests | ||
+ | * Activate and deactivate Lianja SQL Server and Lianja Cloud Server licenses | ||
+ | * Configure settings for the Lianja Server service, Lianja SQL Server and Lianja Cloud Server | ||
* Manage background scripts running via Lianja SQL Server | * Manage background scripts running via Lianja SQL Server | ||
− | + | The Lianja Server Manager can be accessed from its desktop shortcut or from the Windows Start Menu under ''Lianja SQL Server'' or ''Lianja Cloud Server''. | |
− | + | ||
− | + | ||
− | + | ||
===User Account Control=== | ===User Account Control=== | ||
− | If you have User Account Control enabled, please click Yes on the UAC dialog displayed when you run the Lianja | + | If you have User Account Control enabled, please click Yes on the UAC dialog displayed when you run the Lianja Server Manager. On Windows XP, please run the Lianja Server Manager as the Administrator. |
==Service Manager== | ==Service Manager== | ||
+ | [[{{ns:file}}:l5_wserveman1.png|link={{filepath:l5_wserveman1.png}}|Service Manager tab]] | ||
+ | <br clear=all> | ||
− | + | The Service Manager tab allows you to perform the following operations on the Lianja Server service: | |
− | + | ||
− | The Service Manager tab allows you to perform the following operations on the Lianja | + | |
* Start | * Start | ||
* Pause | * Pause | ||
Line 24: | Line 26: | ||
Pausing the service has no effect on existing connections, but prevents further connections to the server being made. To resume normal service after a Pause, click the Start/Continue button. | Pausing the service has no effect on existing connections, but prevents further connections to the server being made. To resume normal service after a Pause, click the Start/Continue button. | ||
− | Checking the Auto-start service box ensures that the Lianja | + | Checking the Auto-start service box ensures that the Lianja Server service will be restarted when the machine is rebooted. |
+ | |||
+ | The current status of the Lianja Server is shown in the status bar. | ||
+ | |||
+ | The '''License Information''' section displays your current license owner, type, maximum connections and IP address. To add a license, enter the key in the ''License key'' box and click ''Activate''. The ''Deactivate'' button is used to deactivate the current license. This is demonstrated in the [http://videos.lianja.com/video/84785719|Lianja License Activation video]. | ||
− | |||
− | |||
==Settings== | ==Settings== | ||
+ | [[{{ns:file}}:l9_wserverman2.png|link={{filepath:l9_wserverman2.png}}|Settings tab]] | ||
+ | <br clear=all> | ||
+ | |||
The following settings can be configured: | The following settings can be configured: | ||
− | {| class="wikitable" width=100% | + | {| class="wikitable" width="100%" |
!Section||Item||Description | !Section||Item||Description | ||
|- | |- | ||
− | |valign=top|Port Listener||Retries||Number of times a connection attempt will be tried before returning an error. Default is 29. | + | |valign="top"|Port Listener||Retries||Number of times a connection attempt will be tried before returning an error. Default is 29. |
|- | |- | ||
− | |||valign=top|Delay||Number of seconds the Port Listener will wait to verify that the server it called was successfully started. Default is 10. | + | |||valign="top"|Delay||Number of seconds the Port Listener will wait to verify that the server it called was successfully started. Default is 10. |
|- | |- | ||
− | |||valign=top|Timeout||Number of seconds between each connection attempt. Default is 1. | + | |||valign="top"|Timeout||Number of seconds between each connection attempt. Default is 1. |
|- | |- | ||
− | |valign=top|Directory Paths||Root Directory||The Lianja | + | |valign="top"|Directory Paths||Root Directory||The Lianja Server root folder. |
|- | |- | ||
− | |||valign=top|Log files||The default folder for Lianja | + | |||valign="top"|Log files||The default folder for Lianja Server log files. |
|- | |- | ||
− | |||valign=top|Error files||The default folder for Lianja | + | |||valign="top"|Error files||The default folder for Lianja Server error files. |
|- | |- | ||
− | |||valign=top|Temporary files||The default folder for Lianja | + | |||valign="top"|Temporary files||The default folder for Lianja Server temporary files. |
|- | |- | ||
− | |||valign=top| | + | |||valign="top"|Data||The default folder for Lianja Server databases. |
|- | |- | ||
− | |||valign=top| | + | |||valign="top"|Apps||The default folder for Lianja Server Apps. |
|- | |- | ||
− | |valign=top| | + | |||valign="top"|Library||The default folder for Lianja Server Library files. |
|- | |- | ||
− | |valign=top| | + | |||valign="top"|Services||The default folder for Lianja Server background script services. |
|- | |- | ||
− | + | |valign="top"|Environment||Cursors||Maximum concurrent cursors. | |
|- | |- | ||
− | |||valign=top| | + | |||valign="top"|Offline databases||Reserved for future use. |
|- | |- | ||
− | + | |valign="top"|Log Files||Enabled||Check to enable log file creation. | |
|- | |- | ||
− | |||valign=top|Purge||Click to purge all log files | + | |||valign="top"|Versions||Check to enable log file versioning. |
+ | |- | ||
+ | |||valign="top"|Listener||Click to view the current Listener log file. | ||
+ | |- | ||
+ | |||valign="top"|Server||Click to view the current Server log file. | ||
+ | |- | ||
+ | |||valign="top"|Purge||Click to purge all log files. | ||
|- | |- | ||
|} | |} | ||
− | + | Important: The '''Database''' directory for Lianja Server is the ''Runtime'' data directory. This is the same directory used by the Lianja App Center and is different from the ''Development'' directory used by the Lianja App Builder. To make your databases or changes you have made to the southwind sample database available to the Lianja Server, you will need to deploy them to the ''Runtime'' data directory. This can be done in a few clicks from the Deploy Worksurface in the Lianja App Builder: see [[Deploying to Local Directory|here]] for details. | |
− | Note: When the Lianja | + | Note: When the Lianja Server service is started, the Port Listener is activated and listens for client requests. Once a client makes a connection, the Port Listener starts the Server for that connection. |
One client could have more than one connection / Server. | One client could have more than one connection / Server. | ||
Line 76: | Line 89: | ||
Note: Logging should only be enabled when required, not for general usage. | Note: Logging should only be enabled when required, not for general usage. | ||
− | + | ==HTTP Settings== | |
+ | [[{{ns:file}}:l5_wserveman4.png|link={{filepath:l5_wserveman4.png}}|HTTP Settings tab]] | ||
<br clear=all> | <br clear=all> | ||
− | |||
− | |||
− | |||
− | |||
− | + | The HTTP Settings apply to the Lianja Cloud Server. | |
− | + | ||
− | {| class="wikitable" width=100% | + | The following settings can be configured: |
− | ! | + | |
+ | {| class="wikitable" width="100%" | ||
+ | !width="25%"|Setting||Description | ||
|- | |- | ||
− | |valign=top| | + | |valign="top"|Enable HTTP server||Check to tell the Lianja Server to listen for HTTP/Cloud Server requests. The Lianja Server listens for requests on port 8001. If the port 80 checkbox is checked, it will also listen for request on port 80. |
|- | |- | ||
− | + | |valign="top"|Enable HTTP port 80||valign="top"|Check to tell the Lianja Server to listen for HTTP/Cloud Server requests on port 80 as well as 8001. | |
|- | |- | ||
− | + | |valign="top"|Enable caching||Check to enable caching on the Lianja Server. This should be unchecked during development. | |
|- | |- | ||
− | |valign=top| | + | |valign="top"|wwwroot||The root folder for the Lianja Cloud Server. Default is C:\Lianja\cloudserver\tenants\public\wwwroot\. |
|- | |- | ||
− | + | |valign="top"|Default Page||The default page displayed. Default is login.rsp in the folder specified by ''wwwroot''. See also [[Customizing the Login Page]]. | |
|- | |- | ||
− | + | |valign="top"|Run as||The account to run as: Guest Account or This Account. For 'This Account', specify the login username and password. | |
|- | |- | ||
− | + | |valign="top"|Enable debug||Check to enable the creation of debug log files. | |
|- | |- | ||
− | + | |valign="top"|Enable logging||Check to enable the creation of ''Common Log Format'' log files. | |
|- | |- | ||
− | |||valign=top| | + | |valign="top"|Trace requests||Check to enable the creation of trace request log files. |
+ | |- | ||
+ | |valign="top"|OData Trace||Check to enable the creation of OData performance metrics tracing information log files (from v5.3). | ||
+ | |- | ||
+ | |valign="top"|Tenancy||The tenancy name. | ||
+ | |- | ||
+ | |valign="top"|Custom Login page||The name of the custom login page script for the above tenancy. | ||
+ | |- | ||
+ | |valign="top"|Custom Login recaptcha page||The name of the custom login page with reCAPTCHA script for the above tenancy. | ||
+ | |- | ||
+ | |valign="top"|Custom App Center||The name of the custom App Center page script for the above tenancy. | ||
|- | |- | ||
|} | |} | ||
− | === | + | ==Security== |
− | + | [[{{ns:file}}:l8_wserveman5.png|link={{filepath:l8_wserveman5.png}}|Security tab]] | |
− | + | <br clear=all> | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | The following Security settings can be configured: | |
− | // | + | |
− | //----------- | + | {| class="wikitable" width="100%" |
− | + | !width="25%"|Setting||Description | |
− | + | |- | |
− | + | |valign="top"|Allow unauthenticated local access||If checked local clients (same IP address) can connect without specifying a username/password. For ODBC/JDBC clients, use ?/? as the username/password. | |
+ | |- | ||
+ | |valign="top"|Enable WebSockets service||Check to enable the WebSockets service. | ||
+ | |- | ||
+ | |valign="top"|Enable OData Read service||Check to enable the OData Read service. | ||
+ | |- | ||
+ | |valign="top"|Enable OData Update service||Check to enable the OData Update service. | ||
+ | |- | ||
+ | |valign="top"|Authenticate OData service||Check to enable OData authentication. | ||
+ | |- | ||
+ | |valign="top"|Authenticate Page requests||Check to enable Page authentication ([[Visual FoxPro Server Pages|.rsp]], [[JavaScript Server Pages|.jssp]]). | ||
+ | |- | ||
+ | |valign="top"|Enable server delegates||Check to enable server delegates. | ||
+ | |- | ||
+ | |valign="top"|[[Cloud Server Registrations|Enable registrations]]||Check to enable registrations. From v8.0. | ||
+ | |- | ||
+ | |valign="top"|Enable reCAPTCHA||Check to enable reCAPTCHA authentication on default login pages. | ||
+ | |- | ||
+ | |valign="top"|Enable package auto update||Check to enable package auto updates. See the [[Lianja_Package_Manager#Lianja_Cloud_Server|Lianja Package Manager]] for full details. | ||
+ | |- | ||
+ | |valign="top"|[[Customizing_the_Login_Page#One-Time_Passcode_Two_Factor_Authentication|Enable 2FA]]||Check to enable 2FA. From v8.0. | ||
+ | |- | ||
+ | |valign="top"|API Key||If the optional API key is specified then no authentication is required but the HTTP headers must contain "LianjaAPIKEY:key" and the key must match the specified API key.<br>See also the use of the API key for deployment via [[Cross_Platform_App_Deployment_with_Lianja_v6#http.2Fhttps|http/https]]. | ||
+ | |- | ||
+ | |} | ||
− | / | + | ===Allow / Deny Masks=== |
− | + | This section permits you to specify individual or groups of IP addresses allowed or denied access to the Lianja Server. Type the IP address or IP address range in the box, e.g. 192.168.*.*, then click the Add button to add it to the list. Select an IP address or range from the box and click Modify or Remove to modify or remove it. | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | Note: if specifying IP addresses in the allow list, the localhost (127.0.0.1) must be included in the list. | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ===Allowing Unauthenticated Apps=== | |
− | + | From Lianja v5.2, two registry environment variables have been introduced to handle the support of unauthenticated Apps. By default, a user needs successful authentication of their username and password before being able to access an App. | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ====DB_ALLOWUNAUTHENTICATED_APPS==== | |
− | + | If the DB_ALLOWUNAUTHENTICATED_APPS registry entry is set to 'true', Apps that have the [[App Settings|Enable guest access App Setting]] checked and appear in the [[#DB_UNAUTHENTICATED_APPS|DB_UNAUTHENTICATED_APPS]] list can be accessed without authentication. | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | DB_ALLOWUNAUTHENTICATED_APPS is a string value and should be created under the following node: | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | Windows 32 bit: | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | / | + | <pre>HKEY_LOCAL_MACHINE\SOFTWARE\Lianja\Lianja Server\Netserver</pre> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | Windows 64 bit: | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | <pre>HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Lianja\Lianja Server\Netserver</pre> | |
− | + | ||
− | + | ====DB_UNAUTHENTICATED_APPS==== | |
− | + | The DB_UNAUTHENTICATED_APPS registry entry should be specified as a comma-separated list of App names for Apps that allow unauthenticated access, e.g. | |
− | + | ||
− | + | ||
− | + | ||
− | + | <pre>example_webapp1,example_webapp2,example_pagecenter</pre> | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | As [[#DB_ALLOWUNAUTHENTICATED_APPS|above]], the DB_ALLOWUNAUTHENTICATED_APPS registry entry must also be set to 'true'. | |
− | + | ||
− | + | ||
− | + | DB_UNAUTHENTICATED_APPS is a string value and should be created under the following node: | |
− | + | ||
− | + | ||
− | + | ||
− | + | Windows 32 bit: | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | / | + | <pre>HKEY_LOCAL_MACHINE\SOFTWARE\Lianja\Lianja Server\Netserver</pre> |
− | + | ||
− | + | ||
− | + | ||
− | + | Windows 64 bit: | |
− | + | <pre>HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Lianja\Lianja Server\Netserver</pre> | |
− | + | [[Category:Lianja SQL Server]] | |
− | + | [[Category:Lianja Cloud Server]] | |
− | + | [[Category:Lianja Server]] | |
− | + | [[Category:Lianja v8.0]] | |
− | + | ||
− | [[Category: | + | |
− | [[Category: | + |
Latest revision as of 08:40, 22 June 2023
Contents
See Also
Lianja ODBC Driver on Linux, Lianja ODBC Driver on Windows, Lianja ODBC Manager on Windows, Lianja Server Manager on Linux, License Management on Windows, SQL System Tables
The Lianja Server Manager
The Lianja Server Manager allows you to:
- Control the Lianja Server service that listens for Lianja SQL Server and Lianja Cloud Server requests
- Activate and deactivate Lianja SQL Server and Lianja Cloud Server licenses
- Configure settings for the Lianja Server service, Lianja SQL Server and Lianja Cloud Server
- Manage background scripts running via Lianja SQL Server
The Lianja Server Manager can be accessed from its desktop shortcut or from the Windows Start Menu under Lianja SQL Server or Lianja Cloud Server.
User Account Control
If you have User Account Control enabled, please click Yes on the UAC dialog displayed when you run the Lianja Server Manager. On Windows XP, please run the Lianja Server Manager as the Administrator.
Service Manager
The Service Manager tab allows you to perform the following operations on the Lianja Server service:
- Start
- Pause
- Stop
- Restart
Pausing the service has no effect on existing connections, but prevents further connections to the server being made. To resume normal service after a Pause, click the Start/Continue button.
Checking the Auto-start service box ensures that the Lianja Server service will be restarted when the machine is rebooted.
The current status of the Lianja Server is shown in the status bar.
The License Information section displays your current license owner, type, maximum connections and IP address. To add a license, enter the key in the License key box and click Activate. The Deactivate button is used to deactivate the current license. This is demonstrated in the License Activation video.
Settings
The following settings can be configured:
Section | Item | Description |
---|---|---|
Port Listener | Retries | Number of times a connection attempt will be tried before returning an error. Default is 29. |
Delay | Number of seconds the Port Listener will wait to verify that the server it called was successfully started. Default is 10. | |
Timeout | Number of seconds between each connection attempt. Default is 1. | |
Directory Paths | Root Directory | The Lianja Server root folder. |
Log files | The default folder for Lianja Server log files. | |
Error files | The default folder for Lianja Server error files. | |
Temporary files | The default folder for Lianja Server temporary files. | |
Data | The default folder for Lianja Server databases. | |
Apps | The default folder for Lianja Server Apps. | |
Library | The default folder for Lianja Server Library files. | |
Services | The default folder for Lianja Server background script services. | |
Environment | Cursors | Maximum concurrent cursors. |
Offline databases | Reserved for future use. | |
Log Files | Enabled | Check to enable log file creation. |
Versions | Check to enable log file versioning. | |
Listener | Click to view the current Listener log file. | |
Server | Click to view the current Server log file. | |
Purge | Click to purge all log files. |
Important: The Database directory for Lianja Server is the Runtime data directory. This is the same directory used by the Lianja App Center and is different from the Development directory used by the Lianja App Builder. To make your databases or changes you have made to the southwind sample database available to the Lianja Server, you will need to deploy them to the Runtime data directory. This can be done in a few clicks from the Deploy Worksurface in the Lianja App Builder: see here for details.
Note: When the Lianja Server service is started, the Port Listener is activated and listens for client requests. Once a client makes a connection, the Port Listener starts the Server for that connection.
One client could have more than one connection / Server.
At any one time, there will be only one Port Listener process, but there may be many Server processes.
Note: Logging should only be enabled when required, not for general usage.
HTTP Settings
The HTTP Settings apply to the Lianja Cloud Server.
The following settings can be configured:
Setting | Description |
---|---|
Enable HTTP server | Check to tell the Lianja Server to listen for HTTP/Cloud Server requests. The Lianja Server listens for requests on port 8001. If the port 80 checkbox is checked, it will also listen for request on port 80. |
Enable HTTP port 80 | Check to tell the Lianja Server to listen for HTTP/Cloud Server requests on port 80 as well as 8001. |
Enable caching | Check to enable caching on the Lianja Server. This should be unchecked during development. |
wwwroot | The root folder for the Lianja Cloud Server. Default is C:\Lianja\cloudserver\tenants\public\wwwroot\. |
Default Page | The default page displayed. Default is login.rsp in the folder specified by wwwroot. See also Customizing the Login Page. |
Run as | The account to run as: Guest Account or This Account. For 'This Account', specify the login username and password. |
Enable debug | Check to enable the creation of debug log files. |
Enable logging | Check to enable the creation of Common Log Format log files. |
Trace requests | Check to enable the creation of trace request log files. |
OData Trace | Check to enable the creation of OData performance metrics tracing information log files (from v5.3). |
Tenancy | The tenancy name. |
Custom Login page | The name of the custom login page script for the above tenancy. |
Custom Login recaptcha page | The name of the custom login page with reCAPTCHA script for the above tenancy. |
Custom App Center | The name of the custom App Center page script for the above tenancy. |
Security
The following Security settings can be configured:
Setting | Description |
---|---|
Allow unauthenticated local access | If checked local clients (same IP address) can connect without specifying a username/password. For ODBC/JDBC clients, use ?/? as the username/password. |
Enable WebSockets service | Check to enable the WebSockets service. |
Enable OData Read service | Check to enable the OData Read service. |
Enable OData Update service | Check to enable the OData Update service. |
Authenticate OData service | Check to enable OData authentication. |
Authenticate Page requests | Check to enable Page authentication (.rsp, .jssp). |
Enable server delegates | Check to enable server delegates. |
Enable registrations | Check to enable registrations. From v8.0. |
Enable reCAPTCHA | Check to enable reCAPTCHA authentication on default login pages. |
Enable package auto update | Check to enable package auto updates. See the Lianja Package Manager for full details. |
Enable 2FA | Check to enable 2FA. From v8.0. |
API Key | If the optional API key is specified then no authentication is required but the HTTP headers must contain "LianjaAPIKEY:key" and the key must match the specified API key. See also the use of the API key for deployment via http/https. |
Allow / Deny Masks
This section permits you to specify individual or groups of IP addresses allowed or denied access to the Lianja Server. Type the IP address or IP address range in the box, e.g. 192.168.*.*, then click the Add button to add it to the list. Select an IP address or range from the box and click Modify or Remove to modify or remove it.
Note: if specifying IP addresses in the allow list, the localhost (127.0.0.1) must be included in the list.
Allowing Unauthenticated Apps
From Lianja v5.2, two registry environment variables have been introduced to handle the support of unauthenticated Apps. By default, a user needs successful authentication of their username and password before being able to access an App.
DB_ALLOWUNAUTHENTICATED_APPS
If the DB_ALLOWUNAUTHENTICATED_APPS registry entry is set to 'true', Apps that have the Enable guest access App Setting checked and appear in the DB_UNAUTHENTICATED_APPS list can be accessed without authentication.
DB_ALLOWUNAUTHENTICATED_APPS is a string value and should be created under the following node:
Windows 32 bit:
HKEY_LOCAL_MACHINE\SOFTWARE\Lianja\Lianja Server\Netserver
Windows 64 bit:
HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Lianja\Lianja Server\Netserver
DB_UNAUTHENTICATED_APPS
The DB_UNAUTHENTICATED_APPS registry entry should be specified as a comma-separated list of App names for Apps that allow unauthenticated access, e.g.
example_webapp1,example_webapp2,example_pagecenter
As above, the DB_ALLOWUNAUTHENTICATED_APPS registry entry must also be set to 'true'.
DB_UNAUTHENTICATED_APPS is a string value and should be created under the following node:
Windows 32 bit:
HKEY_LOCAL_MACHINE\SOFTWARE\Lianja\Lianja Server\Netserver
Windows 64 bit:
HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Lianja\Lianja Server\Netserver