README.md 944 Bytes
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
## Documentation
11

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

14
15
16
* Architectural overview
  * [GitLab features that rely on Workhorse](doc/architecture/gitlab_features.md)
  * [Websocket channel support](doc/architecture/channel.md)
17
* Operating Workhorse
18
19
20
21
  * [Source installation](doc/operations/install.md)
  * [Workhorse configuration](doc/operations/configuration.md)
* [Contributing](CONTRIBUTING.md)
  * [Testing your code](doc/development/tests.md)
22

23

Jacob Vosmaer's avatar
Jacob Vosmaer committed
24
25
## License

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