Commit 55765654 authored by Michael Kozono's avatar Michael Kozono

Clarify the reasons for disabling writes

parent 14ea01a5
...@@ -649,8 +649,9 @@ ...@@ -649,8 +649,9 @@
By default, we write to the "authorized_keys" file to support old By default, we write to the "authorized_keys" file to support old
OpenSSH servers. If, and only if, you have configured the GitLab OpenSSH servers. If, and only if, you have configured the GitLab
instance to use the AuthorizedKeysCommand, uncheck this to improve instance to use the AuthorizedKeysCommand, uncheck this to improve
performance. performance by preventing a sequential file read on each git SSH
= link_to icon('question-circle'), help_page_path('administration/operations/speed_up_ssh', anchor: 'tidying-up') access.
= link_to icon('question-circle'), help_page_path('administration/operations/speed_up_ssh', anchor: 'the-solution')
- if Gitlab::Geo.license_allows? - if Gitlab::Geo.license_allows?
%fieldset %fieldset
......
...@@ -40,16 +40,22 @@ AuthorizedKeysCommand /opt/gitlab-shell/authorized_keys %u %k ...@@ -40,16 +40,22 @@ AuthorizedKeysCommand /opt/gitlab-shell/authorized_keys %u %k
AuthorizedKeysCommandUser git AuthorizedKeysCommandUser git
``` ```
Finally, reload the SSHD service: Reload the SSHD service:
``` ```
sudo service sshd reload sudo service sshd reload
``` ```
## Tidying up Confirm that SSH is working by removing your user's SSH key in the UI, adding a new one, and attempting to pull a repo.
> **Warning:** Do not disable writes until SSH is confirmed to be working perfectly because the file will quickly become out-of-date. > **Warning:** Do not disable writes until SSH is confirmed to be working perfectly because the file will quickly become out-of-date.
You may disable any more writes to the `authorized_keys` file by unchecking `Write to "authorized_keys" file` in the Application Settings of your GitLab installation. In the case of lookup failures (which are not uncommon), the `authorized_keys` file will still be scanned. So git SSH performance will still be slow for many users as long as a large file exists.
You can disable any more writes to the `authorized_keys` file by unchecking `Write to "authorized_keys" file` in the Application Settings of your GitLab installation.
![Write to authorized keys setting](img/write_to_authorized_keys_setting.png) ![Write to authorized keys setting](img/write_to_authorized_keys_setting.png)
Again, confirm that SSH is working by removing your user's SSH key in the UI, adding a new one, and attempting to pull a repo.
Then you can backup and delete your `authorized_keys` file for best performance.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment