Use QS as web service

[prjemian]

Instead of starting QS with start-re-manager, try starting as a web server, such as https://github.com/BCDA-APS/qs-web2023/issues/5.

[prjemian]

What does the configuration file look like? Are there any examples?

[prjemian]

https://blueskyproject.io/bluesky-httpserver/configuration.html

[prjemian]

Regarding API access: https://blueskyproject.io/bluesky-httpserver/configuration.html#basic-api-access-policy

[prjemian]

• https://github.com/bluesky/bluesky-httpserver/issues/50

[prjemian]

To access the server from other network hosts, start the server with a different host:

host	accessible from
--host localhost	only clients running on localhost
--host "${HOSTNAME}"	any clients which can access HOSTNAME via http://

[prjemian]

Here are a few test URLs (all are GET, not POST):

• http://QS_WEB_SERVER:60610/api/status
• http://QS_WEB_SERVER:60610/api/history/get
• http://QS_WEB_SERVER:60610/api/queue/get
• http://QS_WEB_SERVER:60610/api/devices/allowed
• http://QS_WEB_SERVER:60610/api/plans/allowed

[prjemian]

Next steps for the server: add user-based session authentication

[prjemian]

This schematic shows the implementation to use. It allows the use of existing local tools, such as the queue-monitor GUI, in addition to providing a QS Web Server for Web Clients. The QS Web Server is needed since web clients cannot make ZMQ requests directly to the queueserver process (using ports 60615 and 60625). The QS Web Server is the necessary intermediary that handles web clients by http(s) and talks with the queueserver by ZMQ.

[prjemian]

Push to next milestone ...

[prjemian]

No longer a priority.