中文 | 日本語

Pipy

Pipy is a programmable proxy for the cloud, edge and IoT. It's written in C++, which makes it extremely lightweight and fast. It's also fully programmable by using PipyJS, a tailored version from the standard JavaScript language.

Why Pipy?

Versatile

Although Pipy is mostly used as a high-performance reverse proxy, the real power of Pipy relies on providing you a range of basic pluggable building blocks, aka. "filters", and not imposing any restrictions on how you combine them. It's entirely up to you. We've seen people using Pipy to convert protocols, record network traffic, sign/verify messages, trigger serverless functions, health-check servers, and more.

Fast

Pipy is written in C++. It leverages asynchronous network I/O. Allocated resources are pooled and reused. Data is transferred internally by pointers whenever possible. It's fast in every way.

Tiny

A build of Pipy with no built-in GUI frontend resources gives you an executable merely around 10MB with zero external dependencies. You'll experience the fastest download and startup times with Pipy.

Programmable

At the core, Pipy is a script engine running PipyJS, a tailored version from ECMA standard JavaScript. By speaking the planet's most widely used programming language, Pipy gives you unparalleled freedom over what you have in other products based on YAML configuration files and the like.

Open

Pipy is more open than open source. It doesn’t try to hide details in a black box. You'll always know what you are doing. It might sound a bit daunting but fear not, it doesn’t require a rocket scientist to understand how the different parts work together. In fact, you’ll only have more fun as you have complete control over everything.

Quick Start

Build

The following prerequisites are required to build Pipy:

• Clang 5.0+
• CMake 3.10+
• Node.js v12+ (only if the builtin Admin UI is enabled)

Run the build script to start building:

./build.sh

The final product can be found at bin/pipy.

Run

Run bin/pipy with zero command line options, Pipy will start in repo-mode listening on the default port 6060.

$ bin/pipy

[INF] [admin] Starting admin service...
[INF] [listener] Listening on port 6060 at ::

Open the browser of your choice, point 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.

Documentation

• Overview
• Getting started
• Tutorials
• Reference
  • API Reference
  • PipyJS Reference
• Learning Resources
  • Blog
  • Docker Desktop Extension - Flomesh Pipy Docker Desktop Extension
  • InfoQ article - Brief Introduction
• Copyright
• Licence

Compatibility

Pipy is being constantly tested on these platforms:

• RHEL/CentOS
• Fedora
• Ubuntu
• Debian
• macOS
• FreeBSD
• OpenBSD
• OpenEuler
• OpenWrt
• Deepin
• Kylin

Pipy runs on the following architectures:

• X86/64
• ARM64
• LoongArch
• Hygon

Copyright & License

Please refer to COPYRIGHT and LICENCE.

Contact

• For security issues, please email to [email protected]
• For legal issues, please email to [email protected]
• For commercial, sales and marketing topics, please email to [email protected]
• For other topics not suitable for the public, please email to [email protected]
• For public discussions, please go to GitHub issues: https://github.com/flomesh-io/pipy/issues