Skip to content

Commit

Permalink
update startup instructions with options for data sources
Browse files Browse the repository at this point in the history
  • Loading branch information
ehneilsen committed Mar 12, 2024
1 parent 34c9818 commit 7f1d671
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,24 @@ Usage
Running ``scheduler_dashboard``
-------------------------------

Activate the conda environment and start the app:

::
Begin by activating the conda environment::

$ conda activate schedview
$ scheduler_dashboard

The app will then give you the URL at which you can find the app.
There are two ways to start the dashboard, depending on what you want to use
as the source of data.
One way is for users to enter arbitrary URLs or file paths from which to load
the data. **This is insecure,** because users can point the dashboard to malicious
snapshots. It is, however, much more flexible in a secure environment::

$ scheduler_dashboard --data-from-urls

Alternately, the dashboard can be started with a flag to only allow users to
load data from a pre-specified directory on the host running the dashboard::

$ scheduler_dashboard --data_dir /where/the/snapshot/pickles/are

In either case, the app will then give you the URL at which you can find the app.

Running ``prenight``
--------------------
Expand Down

0 comments on commit 7f1d671

Please sign in to comment.