Skip to content

README.md

Latest commit

 

History

History
42 lines (31 loc) · 1.58 KB

README.md

File metadata and controls

42 lines (31 loc) · 1.58 KB

Queue Server API (Bluesky HTTP Server)

This folder contains a dockerfile for running the Queue Server API (also named the Bluesky HTTP server in official documentation). This API provides necessary endpoints for controlling the Queue Server from a web browser client.

Install

HTTP Server Documentation

The HTTP server is part of the Queue Server system and works directly with the Queue Server.

Optional: Create python environment

conda create -n queue_server python=3.10
activate queue_server

Install HTTP Server 

pip install bluesky-httpserver

Note that conda does not work for installing http server on Mac M2.

Run

Start HTTP Server with key 'test'

The API KEY provided will be needed by a web client when making requests.

QSERVER_HTTP_SERVER_SINGLE_USER_API_KEY=test QSERVER_HTTP_SERVER_ALLOW_ORIGINS=http://localhost:5173 uvicorn --host localhost --port 60610 bluesky_httpserver.server:app

Navigate to http://localhost:60610/docs

How it works

The http server is a part of the queue server, it acts as a gateway to control the queue server. The queue server itself only communicates over ZMQ, so the http server acts as an API for web clients which otherwise cannot command the queue server directly. The http server is typically hosted on port 60610.

flowchart LR
    A[Web Client] -->|http request| B(HTTP Server)
    B --> |zmq msg| C(Queue Server)
    C --> |zmq msg|B
    B --> |http response| A
Loading