{"id":20414532,"url":"https://github.com/codecov/relay","last_synced_at":"2025-06-14T07:08:34.660Z","repository":{"id":207693932,"uuid":"719768018","full_name":"codecov/relay","owner":"codecov","description":"Provide a relay for Codecov traffic. Meant to serve as a bridge between your code host and Codecov. ","archived":false,"fork":false,"pushed_at":"2024-02-27T22:16:58.000Z","size":53,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-13T10:46:23.112Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codecov.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-11-16T21:28:32.000Z","updated_at":"2024-08-02T15:39:36.000Z","dependencies_parsed_at":"2023-11-22T03:27:40.534Z","dependency_job_id":"4634e19c-8236-4327-93a0-b45aa091f6ae","html_url":"https://github.com/codecov/relay","commit_stats":null,"previous_names":["codecov/relay"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/codecov/relay","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codecov%2Frelay","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codecov%2Frelay/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codecov%2Frelay/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codecov%2Frelay/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codecov","download_url":"https://codeload.github.com/codecov/relay/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codecov%2Frelay/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259775255,"owners_count":22909205,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T06:10:56.072Z","updated_at":"2025-06-14T07:08:34.622Z","avatar_url":"https://github.com/codecov.png","language":"Shell","readme":"# Codecov Relay\n[![CI](https://github.com/codecov/relay/actions/workflows/ci.yml/badge.svg)](https://github.com/codecov/relay/actions/workflows/ci.yml)\n[![Chart CI](https://github.com/codecov/relay/actions/workflows/chart-ci.yml/badge.svg)](https://github.com/codecov/relay/actions/workflows/chart-ci.yml)\n## Purpose\nProvide a relay for Codecov traffic. Meant to serve as a bridge between your code host and Codecov. This is designed to run in a container and can be deployed via Kubernetes/Helm.\n\nRun the relay at the edge of your network to allow Codecov to send traffic to your internal network. This is useful for when you want to use Codecov but do not want to directly expose a service on your internal network to the internet.\n\n## Usage\n\n### Simple\nDeploy and configure with the `RELAY_HOST` set to the host you want to send traffic to. Codecov will send your traffic to this relay via split DNS (most likely).\n\n### Bidirectional\nConfigure `CODECOV_RELAY_ENABLED` and `CODECOV_HOST`. The relay will then send Codecov traffic as well. This is useful for when you want to use the relay to route traffic to a self hosted or Dedicated instance of Codecov. You will likely need to send Codecov traffic to the relay via split DNS.\n\nPlease contact your Codecov representative for more information.\n\n## Configuration\n\n* Note the only required configuration is `RELAY_HOST`. This must be set for proper operation.\n\n| Environment Variable  | Default    | Description                                                                                            | Required |\n|-----------------------|------------|--------------------------------------------------------------------------------------------------------|----------|\n| CODECOV_BIND_PORT     | 8000       | IP that the relay binds to listen and forward traffic to Codecov                                       | false    |\n| RELAY_BIND_PORT       | 8080       | IP that the relay binds to listen and forward traffic to internal services                             | false    |\n| CODECOV_HOST          | codecov.io | Codecov host to forward traffic to. Typically you will want to change this.                            | false    |\n| CODECOV_PORT          | 443        | Port to forward Codecov traffic on. This should be 443 in most cases.                                  | false    |\n| RELAY_HOST            | null       | Host to forward relay traffic to. This is usually your code host or some other gateway.                | true     |\n| RELAY_PORT            | 443        | Port to forward relay traffic on                                                                       | false    |\n| CODECOV_RELAY_ENABLED | null       | When set, will enable the Codecov side of the relay. This is used when you need bidirectional routing. | false    |\n| CHROOT_DISABLED       | null       | When set, will disable chroot on haproxy. This is used when your container env cannot support chroot.  | false    |\n| HEALTH_CHECK_PORT     | 8100       | Port to respond to the health check on                                                                 | false    |\n\n\n## Installation\n\nInstall the Codecov Helm Repo\n```shell\nhelm repo add codecov https://helm.codecov.io\nhelm repo update\n```\n\n### Install\n```shell\nhelm install --set relay.host=YOURHOST codecov-relay codecov/codecov-relay\n```\n\n### Upgrade\n\n```shell\nhelm upgrade --reuse-values codecov-relay codecov/codecov-relay\n```","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodecov%2Frelay","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodecov%2Frelay","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodecov%2Frelay/lists"}