Skip to content

Commit

Permalink
Update mirrors.rst
Browse files Browse the repository at this point in the history
Add discussion around using `--scope`
  • Loading branch information
douglasjacobsen authored Sep 24, 2024
1 parent 6f557e1 commit 5029ce8
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion lib/ramble/docs/tutorials/mirrors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -518,10 +518,15 @@ For example, using the mirror directories we created above,

.. code-block:: console
$ ramble mirror add --scope={site,user} ramble_mirror $HOME/wrfv4_mirror/inputs
$ ramble mirror add --scope=site ramble_mirror $HOME/wrfv4_mirror/inputs
$ spack mirror add spack_mirror $HOME/wrfv4_mirror/software
**NOTE**: The ``--scope`` argument controls at what level Ramble is configured to use this mirror. The default scope
is ``user`` which places the config within the ``~/.ramble`` directory, and it only applies to the user that executed
this comment. Using ``--scope=site`` applies the config to the installation directory for Ramble, and all users that
use this same installation would have the config option applied to them.

To validate that the mirrors were installed correctly, try something like the following,

.. code-block:: console
Expand Down

0 comments on commit 5029ce8

Please sign in to comment.