Skip to content

Commit b681b6b

Browse files
authored
Merge pull request #2035 from globus/move_user_dir_doc-sc-36095
move .globus_compute directory doc to Endpoints from quickstart
2 parents acc6498 + 26438af commit b681b6b

File tree

2 files changed

+34
-34
lines changed

2 files changed

+34
-34
lines changed

docs/endpoints/endpoints.rst

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,40 @@ will probably not behave as expected. Example:
205205
These will be injected into the user endpoint process as environment variables.
206206

207207

208+
.. _config-dir:
209+
210+
Directories
211+
-----------
212+
213+
By default, Globus Compute uses ``$HOME/.globus_compute`` to store endpoint
214+
configuration, logs and cached credentials.
215+
216+
This default location can be overridden via the ``GLOBUS_COMPUTE_USER_DIR``
217+
environment variable or the ``--config-dir`` option when issuing endpoint commands.
218+
219+
* ``GLOBUS_COMPUTE_USER_DIR``
220+
221+
.. code-block:: console
222+
223+
$ export GLOBUS_COMPUTE_USER_DIR=$HOME/.custom_dir_2
224+
225+
$ globus-compute-endpoint configure endpoint_in_new_group
226+
227+
$ globus-compute-endpoint start endpoint_in_new_group
228+
229+
230+
* ``--config-dir``
231+
232+
.. code-block:: console
233+
234+
$ globus-compute-endpoint configure --config-dir ~/.custom_3 endpoint_in_group_3
235+
236+
$ globus-compute-endpoint start --config-dir ~/.custom_3 endpoint_in_group_3
237+
238+
.. note::
239+
``--config-dir`` overrides ``GLOBUS_COMPUTE_USER_DIR`` if both are specified.
240+
241+
208242
.. _starting-the-endpoint:
209243

210244
Starting the Endpoint

docs/quickstart.rst

Lines changed: 0 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -168,37 +168,3 @@ refer to the :doc:`endpoints/index` documentation.
168168
169169
$ globus-compute-endpoint start <ENDPOINT_NAME>
170170
171-
172-
Directories
173-
===========
174-
175-
.. _config-dir:
176-
177-
By default, Globus Compute uses ``$HOME/.globus_compute`` to store endpoint
178-
configuration, logs and cached credentials.
179-
180-
This default location can be overridden via the ``GLOBUS_COMPUTE_USER_DIR``
181-
environment variable or the ``--config-dir`` option when issuing endpoint commands.
182-
183-
* ``GLOBUS_COMPUTE_USER_DIR``
184-
185-
.. code-block:: console
186-
187-
$ export GLOBUS_COMPUTE_USER_DIR=$HOME/.custom_dir_2
188-
189-
$ globus-compute-endpoint configure endpoint_in_new_group
190-
191-
$ globus-compute-endpoint start endpoint_in_new_group
192-
193-
194-
* ``--config-dir``
195-
196-
.. code-block:: console
197-
198-
$ globus-compute-endpoint configure --config-dir ~/.custom_3 endpoint_in_group_3
199-
200-
$ globus-compute-endpoint start --config-dir ~/.custom_3 endpoint_in_group_3
201-
202-
.. note::
203-
``--config-dir`` overrides ``GLOBUS_COMPUTE_USER_DIR`` if both are specified.
204-

0 commit comments

Comments
 (0)