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 CLI, эмуляторы терминала, редакторы) и не требует никакой настройки на удалённой стороне.
Всё приложение открытое?Основное приложение открыто под лицензией Apache 2.0, но функции тарифных планов для домашней лаборатории и профессионального использования, а также библиотека обработки оболочек (shell) закрытые — это модель открытого ядра (open-core).
Куда попадают мои подключения и пароли?Всё хранится в зашифрованном хранилище на ваших собственных системах; XPipe берёт секреты из вашего существующего менеджера паролей, а не хранит их сам, и ничего не отправляется на внешние серверы.
Что такое XPipe Webtop?Это образ контейнера Docker, в котором собраны полноценная среда рабочего стола с XPipe и предустановленными терминалами и редакторами; он позволяет открыть XPipe в браузере через KasmVNC.
Могут ли ИИ-агенты использовать XPipe?Да, в XPipe есть встроенный MCP-сервер, который можно включить, чтобы ИИ-агенты могли напрямую использовать центр подключений и функции просмотра файлов.
Можно ли синхронизировать подключения между несколькими компьютерами?Да, вы можете синхронизировать хранилище между системами и поделиться им с коллегами через свой собственный самохостируемый git-репозиторий.
Какие терминалы и оболочки поддерживает лаунчер?Он работает практически с любым эмулятором терминала в Windows, macOS и Linux, а также с оболочками bash, zsh, fish, cmd и PowerShell, мультиплексорами 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