Enable the Web Console¶
Check that the Web Apps service runs, then turn on the BO console, Monitor and Meta Query on the web in the MetaMiner Administrator (MMA).
Before you begin¶
- The MetaMiner Server (MMS) is installed and running, with a PostgreSQL MetaMiner Database (MMDB).
- You can run the MMA on the MMS machine with administrator rights.
- MMS SSL is on, or you plan to open the console only from the MMS machine itself. See SSL Overview.
- MetaMiner user-based security is on, so that the BO console and Meta Query can ask users to sign in. See User-Based Security.
- For Meta Query on the web: a MetaMiner Ultimate licence.
How the switches work¶
Each app has its own switch. An app that is off answers every page and data request with "This web app is turned off on this MetaMiner Server (MetaMiner Administrator > Preferences > Settings)", and its MMC launcher is greyed out.
| Switch (MMA label) | MMA page | Server property | Default | What it controls |
|---|---|---|---|---|
| BO console (/web/bo) | WebApps | web.bo.enabled |
false |
All BO console pages: Home, Servers, Insights, Reliability, System Info, Publications, notifications and jobs |
| Sign-in: Required / Optional / Off (no sign-in) | WebApps | web.bo.login |
required |
Whether the BO console asks for a MetaMiner sign-in. See Sign In. |
| Pulse (/web/monitor) | WebApps | web.monitor.enabled |
false |
The Monitor app (BO host and process metrics with MMS metrics) |
| Enable the web console (/web/metaquery) | MetaQuery | web.metaquery.enabled |
false |
Meta Query on the web. When off, the page loads but sign-in and queries are refused. |
| Allow anonymous use (lower limits, nothing saved) | MetaQuery | allow.anonymous.web.metaquery |
false |
Lets anyone who reaches the page run read-only SQL without signing in, at the Anonymous tier limits |
Two more settings on the WebApps page tune what the BO console dashboards show:
| MMA label | Server property | Default | Effect |
|---|---|---|---|
| Service accounts: | web.apps.bo.service.users |
empty | Comma-separated BO logins to treat as service accounts, in addition to the login MetaMiner uses on each environment. Dashboards can count people only or people plus service accounts. |
| Internal mail domains: | web.apps.bo.internal.mail.domains |
empty | Comma-separated e-mail domains of your organisation (subdomains included). Recipients outside them count as external. Empty: internal and external are not shown. |
Where the values live
The MMA writes these properties to server\config\config.json (the properties block). The MMS reads the app switches on every request, so a change takes effect without a restart.
Steps¶
- Open the MMA on the MMS machine.
-
Choose Preferences > Settings... and select the WebApps page.
Image of the MMA Settings dialog, WebApps page, with the Web apps group showing BO console (/web/bo) ticked, Sign-in set to Required, Pulse (/web/monitor) ticked, and the Service accounts and Internal mail domains fields
../images/web-console/mma-settings-webapps.png -
Tick BO console (/web/bo) and leave Sign-in: at Required.
- Tick Pulse (/web/monitor) if you want the Monitor app.
- Optional: enter your service account logins in Service accounts: and your e-mail domains in Internal mail domains:.
-
Select the MetaQuery page. In the Web console group, tick Enable the web console (/web/metaquery).
Image of the MMA Settings dialog, MetaQuery page, Web console group: Enable the web console ticked, Allow anonymous use and Allow sign-in over plain HTTP unticked, and the Timeout (s) / Row cap grid for Users, MMDB administrators and Anonymous
../images/web-console/mma-settings-metaquery-web.png -
Review the per-tier Timeout (s) and Row cap values. See Meta Query on the Web.
- Leave Allow sign-in over plain HTTP (password sent unencrypted) unticked. Use MMS SSL so that remote browsers sign in over HTTPS.
- Save the settings.
Result: the MMC File menu launchers for the apps you turned on become available to users who have access.
The Web Apps service¶
| Item | Value |
|---|---|
| Windows service | MetaMinerWebApps |
| Started by | The MMS, automatically, once the MMDB is reachable. The MMA Start and Stop actions include it. |
| Stopped by | The MMS stop sequence, before the MMS itself |
| Port | 49717 (property web.apps.port). Answers page requests from the local machine only; browsers always go through the MMS port. |
| Logs | server\logs\webapps.log, webapps.start.log, webapps.queries.log (slow and Meta Query statements) |
You normally never start or stop this service by hand. After a first install or an upgrade, the MMS can take up to a minute to discover it; until then /web/ pages answer "not found".
Verify¶
- On the MMS machine, open
http://127.0.0.1:49717/api/webapps/healthin a browser. A JSON reply means the service runs. - From your desk, open
https://<mms-host>:<port>/web/bo/. The BO console sign-in box appears. - In the MMC, open the File menu: Launch BO Console... is enabled.
Troubleshooting¶
The page says "This web app is turned off on this MetaMiner Server"
The app switch is off. Turn it on in Preferences > Settings... on the WebApps page (BO console, Pulse) or the MetaQuery page (Meta Query).
The browser shows "Web Apps service is not running"
The MMS knows the Web Apps service but cannot reach it. Start MetaMinerWebApps in Windows Services, or restart the MetaMiner Server from the MMA, then check server\logs\webapps.start.log and webapps.log.
Every /web/ address answers 404 after a new install
The Web Apps service has not run yet on this server, so the MMS does not know it. Start the MMS (it starts the service), wait a minute, and reload.
A dashboard shows "busy" or loads slowly
The web apps answer a limited number of data requests at a time (8 by default) and dashboards retry automatically. If it persists, check server\logs\webapps.queries.log for slow statements and the MMDB load.
The MMC launcher is greyed out
Hover the menu item. "You should connect to MetaMiner Server first", "This web app is turned off on this MetaMiner Server" and "You do not have access to this web app" each name the cause. Access needs the MMC permission on a BO environment (BO console) or Tab: Meta Query (Meta Query).
TODO: confirm which installers include the MetaMinerWebApps service
Confirm that both the full installer and the update installer install and register the service, and whether an upgrade from a release without it needs any manual step.