README.md 1.61 KB
Newer Older
1
# GitLab Workhorse
Jacob Vosmaer's avatar
Jacob Vosmaer committed
2

3
GitLab Workhorse is a smart reverse proxy for GitLab. It handles
4
5
"large" HTTP requests such as file downloads, file uploads, Git
push/pull and Git archive downloads.
Jacob Vosmaer's avatar
Jacob Vosmaer committed
6

7
Workhorse itself is not a feature, but there are [several features in
ooooooo_q's avatar
ooooooo_q committed
8
GitLab](doc/architecture/gitlab_features.md) that would not work efficiently without Workhorse.
9

10
11
12
13
14
15
16
17
18
19
20
21
22
23
## Canonical source

The canonical source for Workhorse is currently
[gitlab-org/gitlab-workhorse](https://gitlab.com/gitlab-org/gitlab-workhorse).
As explained in https://gitlab.com/groups/gitlab-org/-/epics/4826, we
are in the process of moving the canonical source to
[gitlab-org/gitlab/workhorse](https://gitlab.com/gitlab-org/gitlab/tree/master/workhorse).

Until that transition is complete, changes (Merge Requests) for
Workhorse should be submitted at
[gitlab-org/gitlab-workhorse](https://gitlab.com/gitlab-org/gitlab-workhorse).
Once merged, they will propagate to gitlab-org/gitlab/workhorse via
the usual Workhorse release process.

24
## Documentation
25

26
Workhorse documentation is available in the [`doc` folder of this repository](doc/).
27

28
29
30
* Architectural overview
  * [GitLab features that rely on Workhorse](doc/architecture/gitlab_features.md)
  * [Websocket channel support](doc/architecture/channel.md)
31
* Operating Workhorse
32
33
34
  * [Source installation](doc/operations/install.md)
  * [Workhorse configuration](doc/operations/configuration.md)
* [Contributing](CONTRIBUTING.md)
Alessio Caiazza's avatar
Alessio Caiazza committed
35
  * [Adding new features](doc/development/new_features.md)
36
  * [Testing your code](doc/development/tests.md)
37

Jacob Vosmaer's avatar
Jacob Vosmaer committed
38
39
## License

Ben Bodenmiller's avatar
Ben Bodenmiller committed
40
This code is distributed under the MIT license, see the [LICENSE](LICENSE) file.
41