From 5b890e9538a7dd5a667ece4c0d7ebeb4033aae76 Mon Sep 17 00:00:00 2001 From: LukeGus Date: Wed, 20 May 2026 16:44:27 -0500 Subject: [PATCH] chore: continued redesign readme --- README.md | 258 ++++++++++-------------- repo-images/header-features.svg | 6 + repo-images/header-overview.svg | 6 + repo-images/header-platform-support.svg | 6 + 4 files changed, 130 insertions(+), 146 deletions(-) create mode 100644 repo-images/header-features.svg create mode 100644 repo-images/header-overview.svg create mode 100644 repo-images/header-platform-support.svg diff --git a/README.md b/README.md index 82792bd6..c6735ce1 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Termix Logo -

Termix

+

Termix

Self-hosted server management

@@ -32,7 +32,7 @@
-Termix Banner +Termix Banner

@@ -47,125 +47,127 @@
---- - -
- -## Overview - -
+Overview 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. -
-
---- - -
- -## Features +Features
- - - - - - - - - - - - - -
-
-SSH Terminal Access

+
+ +**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

+
+ +**Remote Desktop Access** + RDP, VNC, and Telnet support over the browser with complete customization and split screening. - +
-
-SSH Tunnel Management

+
+ +**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

+
+ +**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

+
+ +**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

+
+ +**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

+
+ +**Server Stats** + 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 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/roles. - + -
-Database Encryption

-Backend stored as encrypted SQLite database files. View docs for more. -
+
+ +**Database Encryption** + +Backend stored as encrypted SQLite database files. View [docs](https://docs.termix.site/security) for more. +
-
-Network Graph

+
+ +**Network Graph** + Customize your Dashboard to visualize your homelab based off your SSH connections with status support. - + -
-SSH Tools

+
+ +**SSH Tools** + 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/refreshes if enabled in user profile. - + -
-Languages

-Built-in support ~30 languages (managed by Crowdin). -
+
+ +**Languages** + +Built-in support ~30 languages (managed by [Crowdin](https://docs.termix.site/translations)). +
@@ -190,64 +192,44 @@ Built-in support ~30 languages (managed by
-## Platform Support - -
- - +
- - - + + - - - + + + + + + + + + + + + + + + + + + + + + +
-
-Web

-Any modern browser (Chrome, Safari, Firefox) · PWA support -
-
-
-Windows x64/ia32

-Portable · MSI Installer · Chocolatey -
-
-
-Linux x64/ia32

-Portable · AUR · AppImage · Deb · Flatpak -
-
PlatformDistribution
-
-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 -
-
WebAny modern browser (Chrome, Safari, Firefox) · PWA support
Windows x64/ia32Portable · MSI Installer · Chocolatey
Linux x64/ia32Portable · 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 +Installation Visit the [Termix Docs](https://docs.termix.site/install) for full installation instructions across all platforms. @@ -290,14 +272,12 @@ networks:
---- - -
- -## Screenshots +Screenshots
+
+ [![YouTube](./repo-images/YouTube.jpg)](https://www.youtube.com/@TermixSSH/videos) Watch update overviews on YouTube @@ -338,24 +318,18 @@ networks:
---- - -
- -## Planned Features +Planned 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).
---- - -
- -## Sponsors +Sponsors
+
+
DigitalOcean @@ -388,20 +362,12 @@ See [Projects](https://github.com/orgs/Termix-SSH/projects/2) for all planned fe
---- - -
- -## Support +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.
---- - -
- -## License +License Distributed under the Apache License Version 2.0. See `LICENSE` for more information. diff --git a/repo-images/header-features.svg b/repo-images/header-features.svg new file mode 100644 index 00000000..f5f752b5 --- /dev/null +++ b/repo-images/header-features.svg @@ -0,0 +1,6 @@ + + + + + Features + diff --git a/repo-images/header-overview.svg b/repo-images/header-overview.svg new file mode 100644 index 00000000..b496b59d --- /dev/null +++ b/repo-images/header-overview.svg @@ -0,0 +1,6 @@ + + + + + Overview + diff --git a/repo-images/header-platform-support.svg b/repo-images/header-platform-support.svg new file mode 100644 index 00000000..53165fae --- /dev/null +++ b/repo-images/header-platform-support.svg @@ -0,0 +1,6 @@ + + + + + Platform Support +