xpipe README

The project's README from github.com/xpipe-io/xpipe. As one markdown file: README.md.

XPipe Banner

About

XPipe is a connection hub that allows you to access your entire server infrastructure from your local desktop. It works on top of your installed command-line programs like SSH, docker, or others, and does not require any setup on your remote systems. It integrates with your favourite text editors, terminals, shells, VNC/RDP clients, password managers, and command-line tools. The platform is designed to be extensible, allowing anyone to add easily support for more tools or to implement custom functionality through a modular extension system.

It currently supports:


Connection hub

Connection hub

File browser

Browser

Terminal launcher

Terminal

Versatile scripting system

scripts

And much more

Downloads

Note that this is a desktop application that should be run on your local desktop workstation, not on any server or containers. It will be able to connect to your server infrastructure from there.

For a full reference and instructions, see the installation docs and managed installation docs.

Windows

Installers are the easiest way to get started and come with an optional automatic update functionality:

If you don't like installers, you can also use a portable version that is packaged as an archive:

Alternatively, you can also use the following package managers:

macOS

Installers are the easiest way to get started and come with an optional automatic update functionality:

If you don't like installers, you can also use a portable version that is packaged as an archive:

Alternatively, you can also use Homebrew to install XPipe with brew install --cask xpipe-io/tap/xpipe.

Linux

You can install XPipe the fastest by pasting the installation command into your terminal. This will perform the setup automatically. The script supports installation via apt, dnf, yum, zypper, rpm, and pacman on Linux:

bash <(curl -sL https://github.com/xpipe-io/xpipe/raw/master/get-xpipe.sh)

Of course, there are also other installation methods available.

Debian-based distros

The following debian installers are available:

Note that you should use apt to install the package with sudo apt install <file> as other package managers, for example dpkg, are not able to resolve and install any dependency packages.

RHEL-based distros

The rpm releases are signed with the GPG key https://xpipe.io/signatures/0xDD3E0AD0.asc. You can import it via rpm --import https://xpipe.io/signatures/0xDD3E0AD0.asc to allow your rpm-based package manager to verify the release signature.

The following rpm installers are available:

Arch

There is an official AUR package available that you can either install manually or via an AUR helper such as with yay -S xpipe.

AppImages

Alternatively, there are also AppImages available. These can be useful if you are using an immutable distro.

NixOS

There's an official xpipe nixpkg available that you can install with nix-env -iA nixos.xpipe on x86_64 Linux systems. This package is however usually not up to date.

There is also a custom repository that contains the latest up-to-date release flakes for Linux and macOS systems: https://github.com/xpipe-io/nixpkg.

Tarball

In case you prefer to use an archive version that you can extract anywhere, you can use these:

Docker container

XPipe is a desktop application first and foremost. It requires a full desktop environment to function with various installed applications such as terminals, editors, shells, CLI tools, and more. So there is no true web-based interface for XPipe.

Since it might make sense however to access your XPipe environment from the web, there is also a so-called webtop docker container image for XPipe. XPipe Webtop is a web-based desktop environment that can be run in a container and accessed from a browser via KasmVNC. The desktop environment comes with XPipe and various terminals and editors preinstalled and configured. This image is also available for Kasm Workspaces in the XPipe Kasm Registry.

Further information

Contributing

See CONTRIBUTING.md for details.

contrib.rocks image

Open source model

XPipe follows an open core model, which essentially means that the main application is open source while certain other components are not. This mainly concerns the features only available in the homelab/professional plan and the shell handling library implementation. Furthermore, some CI pipelines and tests that run on private servers are also not included in the open repository.

The distributed XPipe application consists out of two parts:

Additional features are available in the homelab/professional plan. For more details see https://xpipe.io/pricing. If your enterprise puts great emphasis on having access to the full source code, there are also full source-available enterprise options available.

Documentation

You can find the documentation at https://docs.xpipe.io.

Discord

Discord

xpipe (xpipe-io/xpipe)

Searching Database…

14.6K ·GitHub
这是什么?XPipe 是一个连接中心,让你可以通过一个本地桌面应用访问整个服务器基础设施(SSH 主机、Docker、Kubernetes、虚拟机、云服务器、WSL 等),且无需在远程系统上安装任何代理程序。
这是桌面应用还是云服务?这是一个需要安装在本地的桌面应用;它依赖你电脑上已有的命令行工具(如 SSH 和 docker)运行,背后没有任何云端后台。Docker 的 'webtop' 镜像仅用于从浏览器访问它。
我的电脑上需要先设置好 SSH 或 Docker 吗?XPipe 只是调用你已安装的工具(SSH 客户端、Docker 命令行、终端模拟器、编辑器),远程端无需进行任何配置。
整个应用都是开源的吗?核心应用采用 Apache 2.0 协议开源,但家庭实验室/专业版功能以及 shell 处理库是闭源的,采用的是开源核心(open-core)模式。
我的连接信息和密码会被发送到哪里?所有内容都保存在你自己系统中的加密保险库里;XPipe 从你现有的密码管理器获取凭据,而不是自己存储,也不会将任何内容发送到外部服务器。
XPipe Webtop 是什么?它是一个 Docker 容器镜像,内置完整的桌面环境,预装了 XPipe 以及终端和编辑器,让你可以通过 KasmVNC 在浏览器中访问 XPipe。
AI 代理可以使用 XPipe 吗?可以,XPipe 内置了 MCP 服务器,你可以启用它,让 AI 代理直接使用其连接中心和文件浏览功能。
我可以在多台机器之间同步连接信息吗?可以,你可以在多个系统之间同步保险库,并通过你自己托管的 git 仓库与团队成员共享。
启动器支持哪些终端和 shell?它几乎可以在 Windows、macOS 和 Linux 上的所有终端模拟器中使用,支持 bash、zsh、fish、cmd 和 PowerShell 等 shell,以及 tmux/zellij 等终端复用工具和 starship 等提示符工具。
What are similar projects?labtether, WindTerm, omnyssh, AceShell, ProxmoxVE, navop, sshdesk, Termix
Creator
xpipe-io
Size
72.3 MB
Stars
14.6K
Age
3y
Commits · 90 Days