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
What is this?XPipe is a connection hub that lets you access your entire server infrastructure (SSH hosts, Docker, Kubernetes, VMs, cloud servers, WSL, and more) from one local desktop app, without installing any agent on the remote systems.
Is this a desktop app or a cloud service?It is a desktop application you install locally; it works on top of command-line tools already on your machine like SSH and docker, and there is no cloud backend behind it. A Docker 'webtop' image exists only for accessing it from a browser.
Do I need SSH or Docker already set up on my machine?XPipe just drives tools you already have installed (SSH clients, Docker CLI, terminal emulators, editors) and needs nothing configured on the remote side.
Is the whole app open source?The core application is open source under Apache 2.0, but the homelab/professional plan features and the shell-handling library are closed-source, following an open-core model.
Where do my connections and passwords go?Everything is kept in an encrypted vault on your own systems; XPipe pulls secrets from your existing password manager instead of storing them itself, and nothing is sent to any outside server.
What is the XPipe Webtop?It is a Docker container image that bundles a full desktop environment with XPipe and preinstalled terminals/editors, letting you access XPipe from a browser via KasmVNC.
Can AI agents use XPipe?Yes, XPipe includes an integrated MCP server you can enable so AI agents can directly use its connection hub and file browsing features.
Can I sync my connections across multiple machines?Yes, you can synchronize your vault across systems and share it with teammates through your own self-hosted git repository.
Which terminals and shells does the launcher support?It works with virtually every terminal emulator across Windows, macOS, and Linux, and with shells like bash, zsh, fish, cmd, and PowerShell, plus multiplexers like tmux/zellij and prompts like starship.
What are similar projects?labtether, WindTerm, omnyssh, AceShell, ProxmoxVE, navop, sshdesk, Termix
Creator
xpipe-io
Size
72.2 MB
Stars
14.6K
Age
3y
Commits · 90 Days