chore: clarify SSH clone URL related config options (#37877)

move "SSH_PORT" alongside "SSH_DOMAIN" and explain more
This commit is contained in:
wxiaoguang
2026-05-27 15:59:16 +08:00
committed by GitHub
parent b7a3c7a3be
commit 729c4b8813

View File

@@ -159,6 +159,16 @@
;; Domain name to be exposed in clone URL, defaults to DOMAIN or the domain part of ROOT_URL
;SSH_DOMAIN =
;;
;; Port number to be exposed in clone URL.
;; If you need a different "SSH clone port" from the real "SSH listen port", set the SSH_LISTEN_PORT separately.
;SSH_PORT = 22
;;
;; The network interface that the builtin SSH server should listen on
;SSH_LISTEN_HOST =
;;
;; The port number that the builtin SSH server should listen on, defaults to SSH_PORT
;SSH_LISTEN_PORT =
;;
;; SSH username displayed in clone URLs. It defaults to BUILTIN_SSH_SERVER_USER or RUN_USER.
;; If it is set to "(DOER_USERNAME)", it will use current signed-in user's username.
;; This option is only for some advanced users who have configured their SSH reverse-proxy
@@ -166,15 +176,6 @@
;; Most users should just leave it blank.
;SSH_USER =
;;
;; The network interface the builtin SSH server should listen on
;SSH_LISTEN_HOST =
;;
;; Port number to be exposed in clone URL
;SSH_PORT = 22
;;
;; The port number the builtin SSH server should listen on, defaults to SSH_PORT
;SSH_LISTEN_PORT =
;;
;; Root path of SSH user directory for the system's standalone SSH server if Gitea is not using its builtin SSH server.
;; Default is the '.ssh' directory in the run user's home directory.
;SSH_ROOT_PATH =