From 165ef058d9b1e2d8b94d83b0beebb882d741d82e Mon Sep 17 00:00:00 2001 From: LukeGus Date: Wed, 13 May 2026 23:44:02 -0500 Subject: [PATCH] feat: update readme --- README.md | 358 +++++++++++++++++++++++++++++++++--------------------- 1 file changed, 218 insertions(+), 140 deletions(-) diff --git a/README.md b/README.md index 117836d6..c81a7bec 100644 --- a/README.md +++ b/README.md @@ -1,97 +1,155 @@ -# Repo Stats +
-

-🇺🇸 English · 🇨🇳 中文 · 🇯🇵 日本語 · 🇰🇷 한국어 · 🇫🇷 Français · 🇩🇪 Deutsch · 🇪🇸 Español · 🇧🇷 Português · 🇷🇺 Русский · 🇸🇦 العربية · 🇮🇳 हिन्दी · 🇹🇷 Türkçe · 🇻🇳 Tiếng Việt · 🇮🇹 Italiano +Termix Logo + +

+ Termix +

+ +

Open-source · Forever free · Self-hosted server management

+ +

+ 🇺🇸 English · + 🇨🇳 中文 · + 🇯🇵 日本語 · + 🇰🇷 한국어 · + 🇫🇷 Français · + 🇩🇪 Deutsch · + 🇪🇸 Español · + 🇧🇷 Português · + 🇷🇺 Русский · + 🇸🇦 العربية · + 🇮🇳 हिन्दी · + 🇹🇷 Türkçe · + 🇻🇳 Tiếng Việt · + 🇮🇹 Italiano

-![GitHub Repo stars](https://img.shields.io/github/stars/Termix-SSH/Termix?style=flat&label=Stars) -![GitHub forks](https://img.shields.io/github/forks/Termix-SSH/Termix?style=flat&label=Forks) -![GitHub Release](https://img.shields.io/github/v/release/Termix-SSH/Termix?style=flat&label=Release&v=1) -Discord - -

- Repo of the Day Achievement -
- Achieved on September 1st, 2025 +

+ + + + Discord


-

- - Termix Banner + +Termix Banner + +
+
+ +

+ Repo of the Day Achievement +
+ Achieved on September 1st, 2025

-# Overview +
-

- - Termix Banner -

+--- -Termix is an open-source, forever-free, self-hosted all-in-one server management platform. It provides a multi-platform -solution for managing your servers and infrastructure through a single, intuitive interface. Termix offers SSH terminal -access, remote desktop control (RDP, VNC, Telnet), SSH tunneling capabilities, remote SSH file management, and many other tools. Termix is the perfect -free and self-hosted alternative to Termius available for all platforms. +## What is Termix? -# Features +Termix is an open-source, forever-free, self-hosted all-in-one server management platform. It gives you a single, clean interface to manage your servers and infrastructure across any platform — SSH terminal access, remote desktop (RDP, VNC, Telnet), SSH tunneling, remote file management, and a lot more. Think of it as a free, self-hosted Termius alternative that actually runs everywhere. -- **SSH Terminal Access** - Full-featured terminal with split-screen support (up to 4 panels) with a browser-like tab system. Includes support for customizing the terminal including common terminal themes, fonts, and other components. -- **Remote Desktop Access** - RDP, VNC, and Telnet support over the browser with complete customization and split screening -- **SSH Tunnel Management** - Create and manage server-to-server SSH tunnels with automatic reconnection, health monitoring, and local, remote, or dynamic SOCKS forwarding. Desktop client-to-server tunnel settings are stored locally per desktop install, optional C2S preset snapshots can be saved to the server, renamed, loaded, or deleted when you want to move a local tunnel configuration between clients. -- **Remote File Manager** - Manage files directly on remote servers with support for viewing and editing code, images, audio, and video. Upload, download, rename, delete, and move files seamlessly with sudo support. -- **Docker Management** - Start, stop, pause, remove containers. View container stats. Control container using docker exec terminal. It was not made to replace Portainer or Dockge but rather to simply manage your containers compared to creating them. -- **SSH Host Manager** - Save, organize, and manage your SSH connections with tags and folders, and easily save reusable login info while being able to automate the deployment of SSH keys -- **Server Stats** - View CPU, memory, and disk usage along with network, uptime, system information, firewall, port monitor, on most Linux based servers -- **Dashboard** - View server information at a glance on your dashboard -- **RBAC** - Create roles and share hosts across users/roles -- **User Authentication** - Secure user management with admin controls and OIDC (with access control) and 2FA (TOTP) support. View active user sessions across all platforms and revoke permissions. Link your OIDC/Local accounts together. -- **Database Encryption** - Backend stored as encrypted SQLite database files. View [docs](https://docs.termix.site/security) for more. -- **API Keys** - Create user-scoped API keys with expiration dates to be used for automation/CI -- **Data Export/Import** - Export and import SSH hosts, credentials, and file manager data -- **Automatic SSL Setup** - Built-in SSL certificate generation and management with HTTPS redirects -- **Modern UI** - Clean desktop/mobile-friendly interface built with React, Tailwind CSS, and Shadcn. Choose between many different UI themes including light, dark, Dracula, etc. Use URL routes to open any connection in full-screen. -- **Languages** - Built-in support ~30 languages (managed by [Crowdin](https://docs.termix.site/translations)) -- **Platform Support** - Available as a web app, desktop application (Windows, Linux, and macOS, can be run standalone without Termix backend), PWA, and dedicated mobile/tablet app for iOS and Android. -- **SSH Tools** - Create reusable command snippets that execute with a single click. Run one command simultaneously across multiple open terminals. -- **Command History** - Auto-complete and view previously ran SSH commands -- **Quick Connect** - Connect to a server without having to save the connection data -- **Command Palette** - Double tap left shift to quickly access SSH connections with your keyboard -- **SSH Feature Rich** - Supports jump hosts, Warpgate, TOTP based connections, SOCKS5, host key verification, password autofill, [OPKSSH](https://github.com/openpubkey/opkssh), tmux, port knocking, etc. -- **Network Graph** - Customize your Dashboard to visualize your homelab based off your SSH connections with status support -- **Persistent Tabs** - SSH sessions and tabs stay open across devices/refreshes if enabled in user profile +--- -# Planned Features +## Features -See [Projects](https://github.com/orgs/Termix-SSH/projects/2) for all planned features. If you are looking to contribute, see [Contributing](https://github.com/Termix-SSH/Termix/blob/main/CONTRIBUTING.md). + + + + + +
-# Installation +**🖥️ SSH Terminal** +Full-featured terminal with split-screen support (up to 4 panels) and a browser-like tab system. Customize themes, fonts, and terminal components to your liking. -Supported Devices: +**🖱️ Remote Desktop** +RDP, VNC, and Telnet support directly in the browser with full customization and split screening. -- Website (any modern browser on any platform like Chrome, Safari, and Firefox) (includes PWA support) -- Windows (x64/ia32) - - Portable - - MSI Installer - - Chocolatey Package Manager -- Linux (x64/ia32) - - Portable - - AUR - - AppImage - - Deb - - Flatpak -- macOS (x64/ia32 on v12.0+) - - Apple App Store - - DMG - - Homebrew -- iOS/iPadOS (v15.1+) - - Apple App Store - - IPA -- Android (v7.0+) - - Google Play Store - - APK +**🔒 SSH Tunneling** +Create and manage server-to-server SSH tunnels with automatic reconnection, health monitoring, and local, remote, or dynamic SOCKS forwarding. Desktop client-to-server settings are stored locally per install — optional C2S preset snapshots can be saved to the server and loaded from any client. -Visit the Termix [Docs](https://docs.termix.site/install) for more information on how to install Termix on all platforms. Otherwise, view -a sample Docker Compose file here (you can omit guacd and the network if you don't plan on using remote desktop features): +**📁 Remote File Manager** +Manage files on remote servers with support for viewing and editing code, images, audio, and video. Upload, download, rename, delete, and move files seamlessly with sudo support. + +**🐳 Docker Management** +Start, stop, pause, and remove containers. View container stats and control them with a docker exec terminal. Not a Portainer replacement — just a clean way to manage containers. + +**🗂️ SSH Host Manager** +Save, organize, and manage your SSH connections with tags and folders. Save reusable login info and automate SSH key deployment. + + + +**📊 Server Stats** +View CPU, memory, and disk usage along with network, uptime, system info, firewall, and port monitoring on most Linux-based servers. + +**🔑 User Authentication** +Secure user management with admin controls, OIDC (with access control), and 2FA (TOTP) support. View and revoke active sessions across all platforms. Link OIDC and local accounts together. + +**🛡️ RBAC** +Create roles and share hosts across users and roles with fine-grained permissions. + +**🔐 Database Encryption** +Backend stored as encrypted SQLite database files. See [docs](https://docs.termix.site/security) for details. + +**🌐 Network Graph** +Visualize your homelab based on your SSH connections with live status support. + +**🔧 SSH Tools** +Create reusable command snippets that run with a single click. Execute one command simultaneously across multiple open terminals. + +**📌 Persistent Tabs** +SSH sessions and tabs stay open across devices and refreshes when enabled in your profile. + +**🌍 30+ Languages** +Built-in support for ~30 languages, managed by [Crowdin](https://docs.termix.site/translations). + +
+ +
+More features +
+ +- **Dashboard** — View server information at a glance +- **API Keys** — Create user-scoped API keys with expiration dates for automation and CI +- **Data Export/Import** — Export and import SSH hosts, credentials, and file manager data +- **Automatic SSL Setup** — Built-in SSL certificate generation with HTTPS redirects +- **Command History** — Auto-complete and view previously run SSH commands +- **Quick Connect** — Connect to a server without saving it first +- **Command Palette** — Double-tap left Shift to quickly find and open connections from the keyboard +- **SSH Feature Rich** — Jump hosts, Warpgate, TOTP-based connections, SOCKS5, host key verification, password autofill, [OPKSSH](https://github.com/openpubkey/opkssh), tmux, port knocking, and more +- **Modern UI** — Clean desktop/mobile-friendly UI built with React, Tailwind CSS, and Shadcn. Multiple themes including light, dark, Dracula, etc. Full-screen URL routes for any connection + +
+ +--- + +## Platform Support + +
+ +| Platform | Distribution | +| :--------------------------: | :--------------------------------------------------------- | +| **Web** | Any modern browser (Chrome, Safari, Firefox) · PWA support | +| **Windows** (x64/ia32) | Portable · MSI Installer · Chocolatey | +| **Linux** (x64/ia32) | Portable · AUR · AppImage · Deb · Flatpak | +| **macOS** (x64/ia32, v12.0+) | Apple App Store · DMG · Homebrew | +| **iOS/iPadOS** (v15.1+) | Apple App Store · IPA | +| **Android** (v7.0+) | Google Play Store · APK | + +
+ +--- + +## Installation + +Visit the [Termix Docs](https://docs.termix.site/install) for full installation instructions across all platforms. + +Sample Docker Compose file (you can omit `guacd` and the network if you don't need remote desktop): ```yaml services: @@ -128,80 +186,100 @@ networks: driver: bridge ``` -# Sponsors +--- -

- - DigitalOcean - -          - - Crowdin - -          - - Blacksmith - -          - - Crowdflare - -          - - TailScale - -          - - Akamai - -          - - AWS - -

+## Screenshots -# Support - -If you need help or want to request a feature with Termix, visit the [Issues](https://github.com/Termix-SSH/Support/issues) page, log in, and press `New Issue`. -Please be as detailed as possible in your issue, preferably written in English. You can also join the [Discord](https://discord.gg/jVQGdvHDrf) server and visit the support -channel, however, response times may be longer. - -# Screenshots +
[![YouTube](./repo-images/YouTube.jpg)](https://www.youtube.com/@TermixSSH/videos) -

- Termix Demo 1 - Termix Demo 2 -

+Watch the full overview on YouTube -

- Termix Demo 3 - Termix Demo 4 -

+
+
-

- Termix Demo 5 - Termix Demo 6 -

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Termix Screenshot 1Termix Screenshot 2
Termix Screenshot 3Termix Screenshot 4
Termix Screenshot 5Termix Screenshot 6
Termix Screenshot 7Termix Screenshot 8
Termix Screenshot 9Termix Screenshot 10
Termix Screenshot 11Termix Screenshot 12
-

- Termix Demo 7 - Termix Demo 8 -

+Some videos and images may be out of date or may not perfectly showcase all features. -

- Termix Demo 9 - Termix Demo 10 -

+
-

- Termix Demo 11 - Termix Demo 12 -

+--- -Some videos and images may be out of date or may not perfectly showcase features. +## Planned Features -# License +See [Projects](https://github.com/orgs/Termix-SSH/projects/2) for all planned features. If you want to contribute, check out [Contributing](https://github.com/Termix-SSH/Termix/blob/main/CONTRIBUTING.md). -Distributed under the Apache License Version 2.0. See LICENSE for more information. +--- + +## Sponsors + +
+ + + DigitalOcean + +    + + Crowdin + +    + + Blacksmith + +    + + Cloudflare + +    + + Tailscale + +    + + Akamai + +    + + AWS + + +
+ +--- + +## Support + +Need help or want to request a feature? Head to the [Issues](https://github.com/Termix-SSH/Support/issues) page and open a new issue — the more detail the better, and English is preferred. You can also join the [Discord](https://discord.gg/jVQGdvHDrf) server, though response times there may be longer. + +--- + +## License + +Distributed under the Apache License Version 2.0. See `LICENSE` for more information.