diff options
author | Alicia Cozine <879121+acozine@users.noreply.github.com> | 2019-05-20 17:11:43 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-05-20 17:11:43 -0500 |
commit | 2d414b277811a13677d69f1535429b322df624fe (patch) | |
tree | e0d3599e8ce914707d1d152f71b3889e22e2749a | |
parent | f4ce200b97e2c3f4ceadce4ad83a550247435eb4 (diff) | |
download | ansible-2d414b277811a13677d69f1535429b322df624fe.tar.gz |
Update default roles_path documentation (#56320) (#56665)
(cherry picked from commit c1ebc8d9c2558ccdfa2011d7a1c5c4f1ea894f64)
-rw-r--r-- | docs/docsite/rst/reference_appendices/galaxy.rst | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/docs/docsite/rst/reference_appendices/galaxy.rst b/docs/docsite/rst/reference_appendices/galaxy.rst index 4059b350f6..6e829692ec 100644 --- a/docs/docsite/rst/reference_appendices/galaxy.rst +++ b/docs/docsite/rst/reference_appendices/galaxy.rst @@ -43,12 +43,11 @@ Use the ``ansible-galaxy`` command to download roles from the `Galaxy website <h roles_path ========== -Be aware that by default Ansible downloads roles to the path specified by the environment variable :envvar:`ANSIBLE_ROLES_PATH`. This can be set to a series of -directories (i.e. */etc/ansible/roles:~/.ansible/roles*), in which case the first writable path will be used. When Ansible is first installed it defaults -to */etc/ansible/roles*, which requires *root* privileges. +By default Ansible downloads roles to the first writable directory in the default list of paths ``~/.ansible/roles:/usr/share/ansible/roles:/etc/ansible/roles``. This will install roles in the home directory of the user running ``ansible-galaxy``. -You can override this by setting the environment variable in your session, defining *roles_path* in an *ansible.cfg* file, or by using the *--roles-path* option. -The following provides an example of using *--roles-path* to install the role into the current working directory: +You can override this by setting the environment variable :envvar:`ANSIBLE_ROLES_PATH` in your session, defining ``roles_path`` in an ``ansible.cfg`` file, or by using the ``--roles-path`` option. + +The following provides an example of using ``--roles-path`` to install the role into the current working directory: :: |