Skip to content

Commit d16ae3c

Browse files
committed
Add SSH successful error message
Signed-off-by: jolheiser <[email protected]>
1 parent 09736ae commit d16ae3c

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

docs/content/doc/help/faq.en-us.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ Also see [Support Options]({{< relref "doc/help/seek-help.en-us.md" >}})
3636
* [Can't create repositories/files](#cant-create-repositories-files)
3737
* [Translation is incorrect/how to add more translations](#translation-is-incorrect-how-to-add-more-translations)
3838
* [SSH Issues](#ssh-issues)
39+
* [SSH Common Errors](#ssh-common-errors)
3940
* [Missing releases after migration repository with tags](#missing-releases-after-migrating-repository-with-tags)
4041
* [LFS Issues](#lfs-issues)
4142

@@ -128,7 +129,7 @@ The current way to achieve this is to create/modify a user with a max repo creat
128129

129130
### Enable Fail2ban
130131

131-
Use [Fail2Ban]({{ relref "doc/usage/fail2ban-setup.md" >}}) to monitor and stop automated login attempts and other malicious behavior based on log patterns
132+
Use [Fail2Ban]({{ relref "doc/usage/fail2ban-setup.md" >}}) to monitor and stop automated login attempts or other malicious behavior based on log patterns
132133

133134
## How to add/use custom themes
134135
Gitea supports two official themes right now, `gitea` and `arc-green` (`light` and `dark` respectively)
@@ -161,8 +162,17 @@ Whether you want to change a translation or add a new one, it will need to be th
161162

162163
## SSH issues
163164

164-
For issues reaching repositories over `ssh` while the Gitea web front-end, but
165-
`https` based git repository access works fine, consider looking into the following.
165+
If you cannot reach repositories over `ssh`, but `https` based git repository access works fine, consider looking into the following.
166+
167+
First, make sure you can access Gitea via SSH.
168+
`ssh -i ~/.ssh/<keyfile> [email protected]`
169+
If the connection is successful, you should receive an error message like the following:
170+
```
171+
Hi there, You've successfully authenticated, but Gitea does not provide shell access.
172+
If this is unexpected, please log in with password and setup Gitea under another user.
173+
```
174+
175+
### SSH Common Errors
166176

167177
```
168178
Permission denied (publickey).
@@ -177,12 +187,10 @@ following things:
177187
* Make sure there are no issues in the remote url. In particular, ensure the name of the
178188
git user (before the `@`) is spelled correctly.
179189
* Ensure public and private ssh keys are correct on client machine.
180-
* Try to connect using ssh (ssh [email protected]) to ensure a connection
181-
can be made.
182190
* On the server:
183191
* Make sure the repository exists and is correctly named.
184192
* Check the permissions of the `.ssh` directory in the system user's home directory.
185-
* Verify that the correct public keys are added to `.ssh/authorized_keys`.
193+
* Verify that the correct public keys are added to `.ssh/authorized_keys`.
186194
Try to run `Rewrite '.ssh/authorized_keys' file (for Gitea SSH keys)` on the
187195
Gitea admin panel.
188196
* Read Gitea logs.

0 commit comments

Comments
 (0)