Reader launch options

Guide · Installation

Updated

Browse documentation
On this page

Earlier command and setup reference · Engine 18.6.0rc590 / Reader 8.11.0rc649

What the Reader is

The Reader is a local web app. It opens one result file read-only and listens on the local loopback address unless you configure another address. The security it enforces is in Security and runtime.

Options

Serve a file
observatory-reader PATH serves the file, or the folder that holds it, at http://127.0.0.1:8765.
Open the browser
Add --open-browser to open the served address in your default browser.
Choose an address
--host H --port N. A public deployment also requires --public-origin https://your-reader-host, configured authentication and a trusted HTTPS reverse proxy.
Check only
--check opens the file the way the app does and exits with 0 or 2. No socket opens.
No file
Without a path, the Reader requires exactly one SQLite file in the current directory.
Allow uploads
Add --allow-upload to permit replacing the admitted artifact in a local deployment. Uploads are disabled by default and limited to 64 MiB.

Environment

Use --host and --port to choose the address. The supported OBSERVATORY_READER_* variables configure authentication and HTTPS settings.