opendev/infra-manual
Code Issues Proposed changes

Make it clearer that SSH is the preferred Gerrit comms protocol

Browse Source 
We have a document section dedicated to explaining how to set up an
HTTPS remote for Gerrit. While this section indicates that this
shouldn't be necessary it doesn't explicitly call out that SSH is
preferred. Make this change.

Also point people back to the Getting started document if they haven't
read that yet as it covers Gerrit SSH connectivity.

Change-Id: Ibb0fe097cd63ff57111455c94a00586ff2b050d2
This commit is contained in:
Clark Boylan
2026-02-06 08:54:28 -08:00
parent 536b485c92
commit 91bab6d6ae
1 changed files with 12 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/source/developers.rst
+12 -5
View File
@@ -73,11 +73,18 @@ Accessing Gerrit over HTTPS
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Git-review normally communicates with Gerrit using SSH over port 29418 with
no further configuration needed. However, if you suspect that ssh
over non-standards ports might be blocked (or you need to access the web
using https) then you can configure git-review to use an https endpoint
instead of ssh. Keep in mind that you will need to generate an
`HTTP password in Gerrit
no further configuration needed. Using SSH with the default git-review
remotes configured by::
git review -s
is the preferred connectivity method. Please read the
:ref:`getting_started` document if you haven't yet.
If you suspect that SSH over non-standard ports might be blocked (or you
need to access the web using HTTPS) then you can configure git-review to use
an HTTPS endpoint instead of SSH. Keep in mind that you will need to generate
an `HTTP password in Gerrit
<https://review.opendev.org/#/settings/http-password>`_ to use this
connection. You should run the following command before "git review -s"::