Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: fioctl symbolic link to setup git cannot be fixed
Browse files Browse the repository at this point in the history
Signed-off-by: Camila Macedo <[email protected]>
Camila Macedo committed Nov 6, 2023

Verified

This commit was signed with the committer’s verified signature.
sleepyfran Fran González
1 parent b26edc1 commit 04bca2d
Showing 2 changed files with 42 additions and 5 deletions.
6 changes: 1 addition & 5 deletions source/getting-started/install-fioctl/index.rst
Original file line number Diff line number Diff line change
@@ -213,11 +213,7 @@ Run the following command to add the relevant entries to the Git configuration:
This is because it needs to have privileges to create a symlink in the same directory as where ``git`` is located.

.. warning::
* If for some reason the command fails with an error, the following manual steps can be taken to get the exact same result::

git config --global credential.https://source.foundries.io.username fio-oauth2
git config --global credential.https://source.foundries.io.helper fio
ln -s /usr/local/bin/fioctl /usr/bin/git-credential-fio
* If for some reason the command fails with an error, manual steps can be taken to get the exact same result. For comprehensive instructions, please see the :ref:`Fioctl™ Errors <ref-ts-errors>` section.

* Existing users reconfiguring Git access may need to remove the following lines from ``.gitconfig`` to use ``fioctl configure-git`` utility::

41 changes: 41 additions & 0 deletions source/user-guide/troubleshooting/troubleshooting.rst
Original file line number Diff line number Diff line change
@@ -10,6 +10,47 @@ This page covers a variety of topics falling under addressing specific :ref:`err
Errors and Solutions
---------------------

Fioctl™ Errors
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

If for some reason the command fails with an error, the following manual steps can be taken to get the exact same result:

- Configure Git with the necessary credentials:

.. code-block:: bash
git config --global credential.https://source.foundries.io.username fio-oauth2
git config --global credential.https://source.foundries.io.helper fio
- Create the symbolic link manually. The correct path will be displayed in the `Fioctl` error message and may vary depending on your operating system and Git configuration environment.

**Example**:

.. code-block:: bash
$ sudo fioctl configure-git
Symlinking /usr/local/bin/fioctl to /opt/homebrew/bin/git-credential-fio
ERROR: symlink /usr/local/bin/fioctl /opt/homebrew/bin/git-credential-fio: file exists
In the above example, the symbolic link command would be:

.. code-block:: bash
sudo ln -sf /usr/local/bin/fioctl /usr/local/bin/git-credential-fio
However, for Linux environments, it is usually:

Check failure on line 41 in source/user-guide/troubleshooting/troubleshooting.rst

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Fio-docs.Linux-trademark] 'Linux' should be marked as a trademark first time it occurs in body of text. Raw Output: {"message": "[Fio-docs.Linux-trademark] 'Linux' should be marked as a trademark first time it occurs in body of text.", "location": {"path": "source/user-guide/troubleshooting/troubleshooting.rst", "range": {"start": {"line": 41, "column": 15}}}, "severity": "ERROR"}

Check failure on line 41 in source/user-guide/troubleshooting/troubleshooting.rst

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Fio-docs.Linux-trademark] 'Linux' should be marked as a trademark first time it occurs in body of text. Raw Output: {"message": "[Fio-docs.Linux-trademark] 'Linux' should be marked as a trademark first time it occurs in body of text.", "location": {"path": "source/user-guide/troubleshooting/troubleshooting.rst", "range": {"start": {"line": 41, "column": 15}}}, "severity": "ERROR"}

.. code-block:: bash
sudo ln -s /usr/local/bin/fioctl /usr/bin/git-credential-fio
- Configure Git to use the correct `git-credential-fio` helper by specifying its path:

.. code-block:: bash
git config --global credential.helper /path/to/symlinking/git-credential-fio
Aktualizr-Lite Common Reports
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

0 comments on commit 04bca2d

Please sign in to comment.