diff options
| author | Jens Timmerman <github@caret.be> | 2023-01-26 22:50:15 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-01-26 16:50:15 -0500 |
| commit | 65eb5c0a9f4ecf0f358c5c81f9c9e3202a0fde41 (patch) | |
| tree | 32178e96f94a2929840f9d6600e5d7fb1f2ccd5c /docs/docsite | |
| parent | 6cd1a1404a5179aa99aa7f9182fcce068b297cf9 (diff) | |
| download | ansible-65eb5c0a9f4ecf0f358c5c81f9c9e3202a0fde41.tar.gz | |
Update dev_guide.rst (#79625)
Diffstat (limited to 'docs/docsite')
| -rw-r--r-- | docs/docsite/rst/galaxy/dev_guide.rst | 28 |
1 files changed, 4 insertions, 24 deletions
diff --git a/docs/docsite/rst/galaxy/dev_guide.rst b/docs/docsite/rst/galaxy/dev_guide.rst index 094ef532a3..01a92d0290 100644 --- a/docs/docsite/rst/galaxy/dev_guide.rst +++ b/docs/docsite/rst/galaxy/dev_guide.rst @@ -95,32 +95,12 @@ Alternatively, the role_skeleton and ignoring of files can be configured via ans Authenticate with Galaxy ------------------------ -Using the ``import``, ``delete`` and ``setup`` commands to manage your roles on the Galaxy website requires authentication, and the ``login`` command -can be used to do just that. Before you can use the ``login`` command, you must create an account on the Galaxy website. +Using the ``import``, ``delete`` and ``setup`` commands to manage your roles on the Galaxy website requires authentication in the form of an API key, you must create an account on the Galaxy website. -The ``login`` command requires using your GitHub credentials. You can use your username and password, or you can create a `personal access token <https://help.github.com/articles/creating-an-access-token-for-command-line-use/>`_. If you choose to create a token, grant minimal access to the token, as it is used just to verify identify. +#. Log in to the Galaxy website and open the `Preferences <https://galaxy.ansible.com/me/preferences>`_ view. +#. Select **Show API key** and then copy it. -The following shows authenticating with the Galaxy website using a GitHub username and password: - -.. code-block:: text - - $ ansible-galaxy login - - We need your GitHub login to identify you. - This information will not be sent to Galaxy, only to api.github.com. - The password will not be displayed. - - Use --github-token if you do not want to enter your password. - - GitHub Username: dsmith - Password for dsmith: - Successfully logged into Galaxy as dsmith - -When you choose to use your username and password, your password is not sent to Galaxy. It is used to authenticates with GitHub and create a personal access token. -It then sends the token to Galaxy, which in turn verifies that your identity and returns a Galaxy access token. After authentication completes the GitHub token is -destroyed. - -If you do not want to use your GitHub password, or if you have two-factor authentication enabled with GitHub, use the ``--github-token`` option to pass a personal access token that you create. +#. Save your token in the path set in the :ref:`GALAXY_TOKEN_PATH`. Import a role |