From aca894e0edd0aa821200fe8bf6725679e47c72e9 Mon Sep 17 00:00:00 2001 From: Jose Gracia Date: Wed, 15 May 2024 15:07:25 +0200 Subject: [PATCH] Capitalize HTTP and SSH protocol as they are fixed terms --- guides/Best_practise--Connecting_Hawk_to_the_world | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/guides/Best_practise--Connecting_Hawk_to_the_world b/guides/Best_practise--Connecting_Hawk_to_the_world index 8f76140..edf50f2 100644 --- a/guides/Best_practise--Connecting_Hawk_to_the_world +++ b/guides/Best_practise--Connecting_Hawk_to_the_world @@ -100,13 +100,13 @@ Both protocols can routed through a SOCKS5 proxy. ==**TODO: do we recommend one over the other?**== -### git https protocol +### Git HTTP protocol Requirements: - set up a proxy with ssh as describe in [this section](#setting-up-a-proxy-with-ssh) - set https proxy variables as describe in [this section](#httpshttp-proxy-variables) -The https protocol is mostly used to clone public git repositories for read-only access (without the intension to push changes upstream). In these cases, git does not use any kind of authentication. However, git can also use authentication through the https protocol. +The HTTP protocol is mostly used to clone public git repositories for read-only access (without the intension to push changes upstream). In these cases, git does not use any kind of authentication. However, git can also use authentication through the HTTP protocol. In the simplest case, cloning public repositories without authentication just requires setting up the SOCKS5 proxy and defining the https/http proxy environment variables as explained above. Then just clone with ```bash @@ -135,12 +135,12 @@ hawk> git push Any of these commands may ask you for credentials such as username and password. Enter your access code when prompted for the password. You may consider [managing credentials in git](https://git-scm.com/docs/gitcredentials). -### Git with ssh protocol +### Git with SSH protocol Requirements: - set up a proxy with ssh as describe in [this section](#setting-up-a-proxy-with-ssh) -The other protocol for accessing remote git repositories uses ssh. Repository URLs for this protocol in general look like +The other protocol for accessing remote git repositories is the SSH protocol. Repository URLs for this protocol in general look like ```bash [user@]server:[somepath/]project.git ``` @@ -151,7 +151,7 @@ git@github.com:user/project.git Repositories like these require to authenticate with an ssh public key. We recommend to create a dedicated key for access to the repository from Hawk, and to register (upload) it with the repository. The following will assume the public key file is name `repo_from_hawk.pub`. -When using the ssh protocol, git will start ssh to establish a connection from Hawk to the repository server (e.g. github) but fail. Instead, you need to tell ssh to routed the connection through your reverse tunnel, the one you have set up [above](#setting-up-a-proxy-with-ssh). The easiest is to add the following to your ssh configuration file (`.ssh/config`): +When using the SSH protocol, git will start ssh to establish a connection from Hawk to the repository server (e.g. github) but fail. Instead, you need to tell ssh to routed the connection through your reverse tunnel, the one you have set up [above](#setting-up-a-proxy-with-ssh). The easiest is to add the following to your ssh configuration file (`.ssh/config`): ```bash Host github.com