Настройка доступа по SSH ключу в GitHub в Windows и MacOS

При первой загрузке/выгрузке изменений в/из Github часто возникает ошибка git@github.com: Permission denied (publickey). fatal: Could not read from remote repository. Данная статья раз и навсегда положит этим ошибкам конец!

Всё то, о чём пойдет речь ниже, можно посмотреть в этом видео

ШАГ 1. Поиск существующего SSH ключа

Открываем терминал в том месте где у вас лежит код, который вы хотите интегрировать в Github или Gitlab. Проверяем есть ли уже существующий SSH ключ, для этого вводим команду ниже: ls -al ~/.ssh
Пример НЕсуществующего ключа SSH:
Пример существующего ключа SSH:
Если ключ существует переходите сразу к шагу 4 или создайте отдельный новый ключ специально для Github.

ШАГ 2. Генерация нового SSH ключа

• Введите в терминале команду ниже:
  ssh-keygen -t ed25519 -C "your_email@example.com"
  Пояснения команды:
  

  ssh-keygen	команда для генерации SSH ключа
  -t ed25519	алгоритм шифрования, по умолчанию алгоритм rsa, Github рекомендует использовать алгоритм ed25519
  -C	значит "комментарий", все что после этой команды в кавычках будет комментарием
  "your_email@example.com"	комментарий, замените на свой email в Github - это нужно чтобы различать SSH ключи между собой, их может быть несколько

• Теперь нужно указать путь и название файла, можно оставить по умолчанию и нажать Enter, но давайте поменяем имя файла, чтобы понимать что он сгенерирован именно для Github!
  Скопируйте и вставьте путь по умолчанию, поменяйте имя файла и нажмите Enter.
• Далее нужно будет задать пароль (кодовую фразу) для нашего ключа, пропускаем этот шаг, просто два раза нажимаем Enter, иначе придется постоянно вводить этот пароль.
• Если вы все сделали правильно будет примерно также, как на скриншоте ниже:

ШАГ 3. Добавление SSH ключа в SSH-agent

Не пропускайте этот шаг! Без него ничего работать не будет.

Что же такое SSH-agent на сайте habr.com вот такое описание: "ssh-agent — это менеджер ключей для SSH. Он хранит ваши ключи и сертификаты в памяти, незашифрованные и готовые к использованию ssh . Это избавляет вас от необходимости вводить пароль каждый раз, когда вы подключаетесь к серверу."

• Сначала запустим SSH-agent командой ниже:
  eval "$(ssh-agent -s)"
  надпись Agent pid 61 (у вас будет любое другое число) говорит о том, что агент успешно запущен!
  
• Добавьте SSH ключ в SSH агент командой ниже, предварительно поменяв название SSH ключа на ваше:
  ssh-add ~/.ssh/id_ed25519_github
  надпись примерная как на скрине ниже, говорит о том, что ключ успешно добавлен
  
• Добавим конфигурационный файл, чтобы SSH ключ автоматически добавлялся в SSH-agent, введите команду ниже, она создаст файл config, если он отсутствует:
  touch ~/.ssh/config
• Теперь в созданный файл config добавим следующий текст, заменив id_ed25519_github на название своего ключа, если нужно:
  

  Host *
    AddKeysToAgent yes
    IdentityFile ~/.ssh/id_ed25519_github

  
  
  • Для пользователей MacOS вводим команду ниже, откроется обычный редактор текста, вставляем в него текст и сохраняем изменения
    open ~/.ssh/config
    
  • Для пользователей Windows вводим команду ниже и нажимаем Enter
    cat > ~/.ssh/config <<EOF
    далее вставить текст, нажать Enter, ввести команду ниже и нажать Enter
    EOF
    
• Проверьте что текст был добавлен в файл config командой
  cat ~/.ssh/config
  должно быть как на скриншоте:

ШАГ 4. Добавление SSH в Github

• Откройте файл где хранится публичный SSH ключ (.pub) и скопируте его содержимое:
  cat ~/.ssh/id_ed25519_github.pub (меняйте на название своего ключа, если нужно)
• Переходим на сайт Github заходим в Settings->SSH and GPG keys->New SSH key
  
• Вводим название SSH ключа, вставим ранее скопированный ключ и нажмем Add SSH key
  

Готово! Проверьте что ключ работает

Возвращаемся в наш терминал и вводим команду git pull, файлы должны загрузиться или как в моем случае должна появиться надпись, что все уже обновлено.

Спасибо за внимание!