Ethica/Termix
1
0
Fork 0
mirror of https://github.com/Termix-SSH/Termix.git synced 2026-07-15 04:43:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: update readme

Browse Source
This commit is contained in:
LukeGus
2026-05-13 23:46:34 -05:00
parent 165ef058d9
commit d295c0b15e
1 changed files with 57 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+57 -57
View File
@@ -9,20 +9,20 @@
<p>Open-source · Forever free · Self-hosted server management</p> <p>Open-source · Forever free · Self-hosted server management</p>
<p> <p>
🇺🇸 English · English ·
<a href="readme/README-CN.md">🇨🇳 中文</a> · <a href="readme/README-CN.md">中文</a> ·
<a href="readme/README-JA.md">🇯🇵 日本語</a> · <a href="readme/README-JA.md">日本語</a> ·
<a href="readme/README-KO.md">🇰🇷 한국어</a> · <a href="readme/README-KO.md">한국어</a> ·
<a href="readme/README-FR.md">🇫🇷 Français</a> · <a href="readme/README-FR.md">Français</a> ·
<a href="readme/README-DE.md">🇩🇪 Deutsch</a> · <a href="readme/README-DE.md">Deutsch</a> ·
<a href="readme/README-ES.md">🇪🇸 Español</a> · <a href="readme/README-ES.md">Español</a> ·
<a href="readme/README-PT.md">🇧🇷 Português</a> · <a href="readme/README-PT.md">Português</a> ·
<a href="readme/README-RU.md">🇷🇺 Русский</a> · <a href="readme/README-RU.md">Русский</a> ·
<a href="readme/README-AR.md">🇸🇦 العربية</a> · <a href="readme/README-AR.md">العربية</a> ·
<a href="readme/README-HI.md">🇮🇳 हिन्दी</a> · <a href="readme/README-HI.md">हिन्दी</a> ·
<a href="readme/README-TR.md">🇹🇷 Türkçe</a> · <a href="readme/README-TR.md">Türkçe</a> ·
<a href="readme/README-VI.md">🇻🇳 Tiếng Việt</a> · <a href="readme/README-VI.md">Tiếng Việt</a> ·
<a href="readme/README-IT.md">🇮🇹 Italiano</a> <a href="readme/README-IT.md">Italiano</a>
</p> </p>
<p> <p>
@@ -49,9 +49,9 @@
--- ---
## What is Termix? ## Overview
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. 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.
--- ---
@@ -61,50 +61,50 @@ Termix is an open-source, forever-free, self-hosted all-in-one server management
<tr> <tr>
<td width="50%" valign="top"> <td width="50%" valign="top">
**🖥️ SSH Terminal** **SSH Terminal Access**
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. 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** **Remote Desktop Access**
RDP, VNC, and Telnet support directly in the browser with full customization and split screening. RDP, VNC, and Telnet support over the browser with complete customization and split screening.
**🔒 SSH Tunneling** **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 settings are stored locally per install — optional C2S preset snapshots can be saved to the server and loaded from any client. 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** **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. 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** **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. 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** **SSH Host Manager**
Save, organize, and manage your SSH connections with tags and folders. Save reusable login info and automate SSH key deployment. 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.
</td> </td>
<td width="50%" valign="top"> <td width="50%" valign="top">
**📊 Server Stats** **Server Stats**
View CPU, memory, and disk usage along with network, uptime, system info, firewall, and port monitoring on most Linux-based servers. View CPU, memory, and disk usage along with network, uptime, system information, firewall, port monitor, on most Linux based servers.
**🔑 User Authentication** **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. 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.
**🛡️ RBAC** **RBAC**
Create roles and share hosts across users and roles with fine-grained permissions. Create roles and share hosts across users/roles.
**🔐 Database Encryption** **Database Encryption**
Backend stored as encrypted SQLite database files. See [docs](https://docs.termix.site/security) for details. Backend stored as encrypted SQLite database files. View [docs](https://docs.termix.site/security) for more.
**🌐 Network Graph** **Network Graph**
Visualize your homelab based on your SSH connections with live status support. Customize your Dashboard to visualize your homelab based off your SSH connections with status support.
**🔧 SSH Tools** **SSH Tools**
Create reusable command snippets that run with a single click. Execute one command simultaneously across multiple open terminals. Create reusable command snippets that execute with a single click. Run one command simultaneously across multiple open terminals.
**📌 Persistent Tabs** **Persistent Tabs**
SSH sessions and tabs stay open across devices and refreshes when enabled in your profile. SSH sessions and tabs stay open across devices/refreshes if enabled in user profile.
**🌍 30+ Languages** **Languages**
Built-in support for ~30 languages, managed by [Crowdin](https://docs.termix.site/translations). Built-in support ~30 languages (managed by [Crowdin](https://docs.termix.site/translations)).
</td> </td>
</tr> </tr>
@@ -114,15 +114,15 @@ Built-in support for ~30 languages, managed by [Crowdin](https://docs.termix.sit
<summary><b>More features</b></summary> <summary><b>More features</b></summary>
<br /> <br />
- **Dashboard** — View server information at a glance - **Dashboard** - View server information at a glance on your dashboard
- **API Keys** — Create user-scoped API keys with expiration dates for automation and CI - **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 - **Data Export/Import** - Export and import SSH hosts, credentials, and file manager data
- **Automatic SSL Setup** — Built-in SSL certificate generation with HTTPS redirects - **Automatic SSL Setup** - Built-in SSL certificate generation and management with HTTPS redirects
- **Command History** — Auto-complete and view previously run SSH commands - **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.
- **Quick Connect** — Connect to a server without saving it first - **Command History** - Auto-complete and view previously ran SSH commands
- **Command Palette** — Double-tap left Shift to quickly find and open connections from the keyboard - **Quick Connect** - Connect to a server without having to save the connection data
- **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 - **Command Palette** - Double tap left shift to quickly access SSH connections with your keyboard
- **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 - **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.
</details> </details>
@@ -149,7 +149,7 @@ Built-in support for ~30 languages, managed by [Crowdin](https://docs.termix.sit
Visit the [Termix Docs](https://docs.termix.site/install) for full installation instructions across all platforms. 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): Sample Docker Compose file (you can omit `guacd` and the network if you don't plan on using remote desktop features):
```yaml ```yaml
services: services:
@@ -226,7 +226,7 @@ networks:
</tr> </tr>
</table> </table>
<sub>Some videos and images may be out of date or may not perfectly showcase all features.</sub> <sub>Some videos and images may be out of date or may not perfectly showcase features.</sub>
</div> </div>
@@ -234,7 +234,7 @@ networks:
## Planned Features ## Planned Features
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). 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).
--- ---
@@ -276,7 +276,7 @@ See [Projects](https://github.com/orgs/Termix-SSH/projects/2) for all planned fe
## Support ## 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. 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.
--- ---