github.com/quickfeed/quickfeed@v0.0.0-20240507093252-ed8ca812a09c/doc/templates/github-ssh.md (about)

     1  # GitHub: SSH Authentication
     2  
     3  The steps below are meant for more experienced GitHub users.
     4  They are necessary when you want to use SSH instead HTTPS for GitHub authentication.
     5  
     6  1. Register your public SSH key (typically `~/.ssh/id_rsa.pub`) at [GitHub](https://github.com/settings/ssh).
     7  
     8  2. Run the following command:
     9  
    10     ```console
    11     git config --global url."git@github.com:".insteadOf https://github.com/
    12     ```
    13  
    14     This will make Git rewrite GitHub URLs to use SSH instead of HTTPS.
    15     This "hack" is necessary since it is not possible to specify the `go get` tool to use SSH authentication.
    16  
    17  ## Problems with Access Rights
    18  
    19  If you have multiple GitHub users, you may need to clear the cache.