hpcjgrac/SPMT
1
0
Fork 0
Code Issues Pull requests Releases Activity

Capitalize HTTP and SSH protocol as they are fixed terms

Browse source
This commit is contained in:
Jose Gracia 2024-05-15 15:07:25 +02:00
parent 0396d71bc9
commit aca894e0ed
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
guides/Best_practise--Connecting_Hawk_to_the_world
View file

@ -100,13 +100,13 @@ Both protocols can routed through a SOCKS5 proxy.
==**TODO: do we recommend one over the other?**== ==**TODO: do we recommend one over the other?**==
### git https protocol ### Git HTTP protocol
Requirements: Requirements:
- set up a proxy with ssh as describe in [this section](#setting-up-a-proxy-with-ssh) - 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) - 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 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 ```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). 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: Requirements:
- set up a proxy with ssh as describe in [this section](#setting-up-a-proxy-with-ssh) - 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 ```bash
[user@]server:[somepath/]project.git [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`. 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 ```bash
Host github.com Host github.com