diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 47 |
1 files changed, 30 insertions, 17 deletions
@@ -6,41 +6,50 @@ info: To determine the technical writer assigned to the Stage/Group associated w # GitLab Shell -## GitLab Shell handles git SSH sessions for GitLab +[](https://gitlab.com/gitlab-org/gitlab-shell/-/pipelines?ref=main) +[](https://gitlab.com/gitlab-org/gitlab-shell/-/pipelines?ref=main) +[](https://codeclimate.com/github/gitlabhq/gitlab-shell) GitLab Shell handles git SSH sessions for GitLab and modifies the list of authorized keys. GitLab Shell is not a Unix shell nor a replacement for Bash or Zsh. +GitLab supports Git LFS authentication through SSH. + +## Requirements + +GitLab Shell is written in Go, and needs a Go compiler to build. It still requires +Ruby to build and test, but not to run. + +GitLab Shell runs on `port 22` on an Omnibus installation. To use a regular SSH +service, configure it on an alternative port. + +Download and install the current version of Go from [golang.org](https://golang.org/dl/) +We follow the [Golang Release Policy](https://golang.org/doc/devel/release.html#policy) +of supporting the current stable version and the previous two major versions. + +## How GitLab Shell works + When you access the GitLab server over SSH then GitLab Shell will: -1. Limit you to predefined git commands (git push, git pull). +1. Limit you to predefined git commands (`git push`, `git pull`, `git fetch`). 1. Call the GitLab Rails API to check if you are authorized, and what Gitaly server your repository is on 1. Copy data back and forth between the SSH client and the Gitaly server If you access a GitLab server over HTTP(S) you end up in [gitlab-workhorse](https://gitlab.com/gitlab-org/gitlab/tree/master/workhorse). -An overview of the four cases described above: +### `git pull` over SSH 1. git pull over SSH -> gitlab-shell -> API call to gitlab-rails (Authorization) -> accept or decline -> establish Gitaly session -1. git push over SSH -> gitlab-shell (git command is not executed yet) -> establish Gitaly session -> (in Gitaly) gitlab-shell pre-receive hook -> API call to gitlab-rails (authorization) -> accept or decline push -[Full feature list](doc/features.md) - -## Code status - -[](https://gitlab.com/gitlab-org/gitlab-shell/-/pipelines?ref=main) -[](https://gitlab.com/gitlab-org/gitlab-shell/-/pipelines?ref=main) -[](https://codeclimate.com/github/gitlabhq/gitlab-shell) +### `git push` over SSH -## Requirements +1. git push over SSH -> gitlab-shell (git command is not executed yet) -> establish Gitaly session -> (in Gitaly) gitlab-shell pre-receive hook -> API call to gitlab-rails (authorization) -> accept or decline push -GitLab Shell is written in Go, and needs a Go compiler to build. It still requires -Ruby to build and test, but not to run. +[Full feature list](doc/features.md) -Download and install the current version of Go from https://golang.org/dl/ +### Modifies `authorized_keys` -We follow the [Golang Release Policy](https://golang.org/doc/devel/release.html#policy) -of supporting the current stable version and the previous two major versions. +GitLab Shell modifies the `authorized_keys` file on the client machine. ## Rate Limiting @@ -102,3 +111,7 @@ See [PROCESS.md](./PROCESS.md) ## License See [LICENSE](./LICENSE). + +## Related topics + +- [Using the GitLab Shell chart](https://docs.gitlab.com/charts/charts/gitlab/gitlab-shell/#using-the-gitlab-shell-chart) |