envoy README

The project's README from github.com/envoyproxy/envoy. As one markdown file: README.md.

Envoy Logo

Cloud-native high-performance edge/middle/service proxy

Envoy is hosted by the Cloud Native Computing Foundation (CNCF). If you are a company that wants to help shape the evolution of technologies that are container-packaged, dynamically-scheduled and microservices-oriented, consider joining the CNCF. For details about who's involved and how Envoy plays a role, read the CNCF announcement.

CII Best Practices OpenSSF Scorecard CLOMonitor

Documentation

Contact

Please see this email thread for information on email list usage.

Contributing

Contributing to Envoy is fun and modern C++ is a lot less scary than you might think if you don't have prior experience. To get started:

Community Meeting

The Envoy team has a scheduled meeting time twice per month on Tuesday at 9am PT. The public Google calendar is here. The meeting will only be held if there are agenda items listed in the meeting minutes. Any member of the community should be able to propose agenda items by adding to the minutes. The maintainers will either confirm the additions to the agenda, or will cancel the meeting within 24 hours of the scheduled date if there is no confirmed agenda.

Security

Security Audit

There has been several third party engagements focused on Envoy security:

Reporting security vulnerabilities

If you've found a vulnerability or a potential vulnerability in Envoy, please open a GitHub Security Advisory. This is the preferred reporting channel, as the reports can be triaged directly on GitHub.

Alternatively, you may email [email protected].

For further details please see our complete security release process.

OSS fuzzing

Fuzzing Status

ppc64le builds

Builds for the ppc64le architecture are not covered by the envoy security policy. The ppc64le architecture is currently best-effort and not maintained by the Envoy maintainers.

Jenkins

Other builds

Jenkins

Releases

For further details please see our release process.

envoy (envoyproxy/envoy)

Searching Database…

29.1K ·GitHub
What is this?Envoy is a cloud-native, high-performance proxy for edge, middle, and service-to-service traffic. It is an open-source project hosted by the CNCF.
Is Envoy a library I add to my code, or something I deploy on its own?It is a standalone proxy you deploy in front of or alongside your services — not a library you import. You configure it and route traffic through it.
How do I get Envoy running?The README itself gives no install steps — it points to the official documentation for that. If you want to build from source, builds and tests run through a Docker-based quick start.
Is it all C++, or are other languages involved too?The core is modern C++, though the repository also contains Go and Rust code. The contributing guide says you do not need prior C++ experience to get involved.
Are there any platform gaps I should know about?Yes — builds for the ppc64le (PowerPC) architecture are best-effort and not covered by the Envoy security policy, so the core maintainers do not support them.
Has Envoy been independently security audited?Yes — Cure53 performed a security audit in 2018, and Ada Logics audited the fuzzing infrastructure in 2021. The project also runs continuous OSS fuzzing and sends security announcements through a dedicated mailing list.
What other repositories are part of the Envoy project?Three are listed in the README: data-plane-api (the v2 API definitions, a read-only mirror), envoy-perf (a performance testing framework), and envoy-filter-example (how to add new filters and link them to the main repo).
Why do the repo topics mention cats, corgis, and rocket ships?They are tongue-in-cheek placeholders — cars, cats, cats-over-dogs, corgis, more-cats, nanoservices, rocket-ships. The maintainers clearly had fun with the topic list; none of them describe the technology.
Creator
envoyproxy
Size
347.2 MB
Stars
29.1K
Age
10y
Commits · 90 Days