gitlab-org--gitlab-foss/workhorse/README.md

GitLab Workhorse

GitLab Workhorse is a smart reverse proxy for GitLab. It handles "large" HTTP requests such as file downloads, file uploads, Git push/pull and Git archive downloads.

Workhorse itself is not a feature, but there are several features in GitLab that would not work efficiently without Workhorse.

Canonical source

The canonical source for Workhorse is currently 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.

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

Documentation

Workhorse documentation is available in the doc folder of this repository.

• Architectural overview
  • GitLab features that rely on Workhorse
  • Websocket channel support
• Operating Workhorse
  • Source installation
  • Workhorse configuration
• Contributing
  • Adding new features
  • Testing your code

License

This code is distributed under the MIT license, see the LICENSE file.