Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: fioctl symbolic link to setup git cannot be fixed #623

Merged
merged 1 commit into from
Nov 8, 2023
Merged

doc: fioctl symbolic link to setup git cannot be fixed #623

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions source/getting-started/install-fioctl/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ``sudo fioctl configure-git`` 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::

Expand Down
42 changes: 42 additions & 0 deletions source/user-guide/troubleshooting/troubleshooting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,48 @@
Errors and Solutions
---------------------

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

If for some reason the command ``sudo fioctl configure-git`` fails with an error, the following manual steps can be
taken to get the exact same result:

1. 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

2. 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 42 in source/user-guide/troubleshooting/troubleshooting.rst

View workflow job for this annotation

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": 42, "column": 15}}}, "severity": "ERROR"}

.. code-block:: bash

sudo ln -s /usr/local/bin/fioctl /usr/bin/git-credential-fio

3. 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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down