Pipy is a programmable network proxy for the cloud, edge and IoT. Written in C++, Pipy is extremely lightweight and fast. It's also programmable by using PipyJS, a tailored version of the standard JavaScript language.
Although Pipy is mostly used as a high-performance reverse proxy, the true power of Pipy relies on providing you a range of pluggable building blocks, aka. filters, without imposing any restrictions on how you combine them. It's entirely up to you as to how you want to use Pipy. We've seen people using Pipy as a protocol converter, traffic recorder, message signer/verifier, serverless function starter, health checker and more.
Pipy is written in C++. It leverages asynchronous networking. Allocated resources are pooled and reused. Data is transferred internally by pointers whenever possible, minimizing the pressure on memory bandwidth. It's fast in every way.
A build of Pipy worker-mode instance gives you an executable merely around 10MB with zero external dependencies. You'll experience the fastest download and startup times with Pipy.
At the core, Pipy is a script engine running PipyJS, a tailored version of ECMA standard JavaScript. By speaking the planet's most widely used programming language, Pipy gives you unparalleled expressiveness over what you have in YAML or the like.
Pipy is more open than open source. It doesn’t try to hide every detail in the black box, so you always know what you are doing. But never fear. It doesn’t require a rocket scientist to figure out how the different parts work together. In fact, you’ll have more fun as you have full control over everything.
The following prerequisites are required before building:
- Clang 5.0+
- CMake 3.10+
- Node.js v12+ (if the builtin Admin UI is enabled)
Run the build script to start building:
./build.sh
The final product will be left at bin/pipy.
Run bin/pipy with zero command line options, Pipy will start in repo-mode listening on default port 6060.
$ bin/pipy
[INF] [admin] Starting admin service...
[INF] [listener] Listening on port 6060 at ::
Open the browser of your choice, point it to http://localhost:6060. You will now see the Admin UI where you can start exploring the documentation and playing around with the tutorial codebases.
You can find the Pipy documentation under docs/.
- Overview
- Concept
- Quick start
- Tutorials
- Learnings & Articles
- Katacoda - Katacoda scenarios
- InfoQ article - Brief Introduction
- Copyright
- Licence
Pipy is being constantly tested on these platforms:
- RHEL/CentOS
- Fedora
- Ubuntu
- Debian
- macOS
- FreeBSD
- OpenBSD
- OpenEuler
- OpenWrt
- Deepin
- Kylin
Pipy can run on the following architectures:
- X86/64
- ARM64
- LoongArch
- Hygon
Please refer to COPYRIGHT and LICENCE.
- For security issues, please email to security@flomesh.io
- For legal issues, please email to legal@flomesh.io
- For commercial, sales and marketing topics, please email to sales@flomesh.io
- For other topics not suitable for the public, please email to pipy@flomesh.io
- For public discussions, please go to GitHub issues: https://github.com/flomesh-io/pipy/issues