setup_positron_server
setup_positron_server()Configure jupyter-server-proxy to run Positron Server.
Returns a configuration dictionary that jupyter-server-proxy uses to launch or connect to a Positron Server instance. The behavior depends on environment variables:
- If
JSP_POSITRON_PORTis set, connects to an existing server on that TCP port - If
JSP_POSITRON_SOCKETis set, connects to an existing server via UNIX socket - Otherwise, starts a new positron-server process
Returns
| Name | Type | Description |
|---|---|---|
| dict | Configuration dictionary containing: - new_browser_window (bool): Whether to open in a new browser window - timeout (int): Server startup timeout in seconds - launcher_entry (dict): JupyterLab launcher configuration - command (list): Command to start server (empty if connecting to existing) - port (int) or unix_socket (str): Connection details (if applicable) - environment (dict): Environment variables for the server process |
See Also
which_positron_server : Locates the positron-server executable.