From 4389bf2013a0319ab87e99654d0c9c978ad65203 Mon Sep 17 00:00:00 2001 From: LukeGus Date: Mon, 12 Oct 2026 12:46:26 -0500 Subject: [PATCH] chore: simplify readme and docs wording --- CONTRIBUTING.md | 14 ++++++------- README.md | 38 +++++++++++++++++------------------ packages/plugin-sdk/README.md | 4 ++-- 3 files changed, 28 insertions(+), 28 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0e97834e3..7771685cd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,21 +38,21 @@ npm run format # format the code with Prettier ## Making a change -1. **Fork the repository**: Click "Fork" at the top right of the [repository page](https://github.com/Termix-SSH/Termix). -2. **Create a branch**: +1. Fork the [repo](https://github.com/Termix-SSH/Termix). +2. Create a branch: ```sh git checkout -b feature/my-new-feature ``` -3. **Make your changes** and add or update tests for them. -4. **Commit your changes**: +3. Make your changes and add or update tests for them. +4. Commit your changes: ```sh git commit -m "feat: add my new feature" ``` -5. **Push to your fork**: +5. Push to your fork: ```sh git push origin feature/my-new-feature ``` -6. **Open a pull request** against the current `dev-*` branch with a clear description. +6. Open a pull request against the current `dev-*` branch with a clear description. ## Guidelines @@ -72,4 +72,4 @@ Start from the [plugin template](https://github.com/Termix-SSH/Termix-Plugin-Tem ## Support -Bugs and ideas for Termix itself go in [this repo](https://github.com/Termix-SSH/Termix/issues/new/choose). Plugin problems go in that plugin's own `Plugin-` repo. Please be as detailed as possible, preferably in English. You can also ask in the [Discord](https://discord.gg/jVQGdvHDrf) server. +Bugs and ideas for Termix itself go in [this repo](https://github.com/Termix-SSH/Termix/issues/new/choose). Plugin problems go in that plugin's own `Plugin-` repo. Add as much detail as you can, in English if possible. You can also ask in the [Discord](https://discord.gg/jVQGdvHDrf) server. diff --git a/README.md b/README.md index 597ab9b7a..6151d144b 100644 --- a/README.md +++ b/README.md @@ -24,30 +24,30 @@ ## Overview -Termix is a free, open source, self-hosted platform for managing your servers, built on plugins. The core is small. It keeps your hosts, credentials, users, sharing and sessions. Everything else, like the SSH terminal, remote desktop, file manager, Docker and metrics, is a plugin you can turn on, turn off or remove. +Termix is a free, open source, self-hosted server management platform built on plugins. The core keeps your hosts, credentials, users, sharing and sessions. Everything else, like the SSH terminal, remote desktop, file manager, Docker and metrics, is a plugin you can turn on, off or remove. -It runs on web, desktop and mobile, and it is a self-hosted alternative to Termius that stays free forever. +It runs on web, desktop and mobile. Think of it as a free, self-hosted Termius.
## Try the Demo -Want to see it before you install it? Try the demo at [demo.termix.site](https://demo.termix.site/). Any username and password works. +Try it at [demo.termix.site](https://demo.termix.site/). Any username and password works.
## Core -What every Termix install has, with or without plugins: +What every install has, with or without plugins: -- **Hosts:** Save hosts in nested folders with tags and parent hosts, bulk edit, import and export, and use Quick Connect for one-off connections -- **Credentials:** Reuse saved passwords and keys across hosts, with host defaults you can set for the server, a user or a folder -- **Sharing and Roles:** Share hosts, credentials and folders with users or roles at four levels: connect, view, edit and manage -- **Accounts:** Local accounts, sessions you can see and revoke, trusted devices, API keys and an audit log -- **Security:** Passwords, keys and other secrets are encrypted per user, and the database can be encrypted on disk -- **Desktop Sync:** The desktop app runs on its own and can link to a Termix server to keep an offline copy of your account -- **Interface:** Tabs and split screen, a command palette (double tap left shift), rebindable shortcuts, themes, branding and around 30 languages -- **Databases:** SQLite by default, with PostgreSQL and MySQL supported too +- Hosts: Save hosts in nested folders with tags and parent hosts, bulk edit, import and export, and use Quick Connect for one-off connections +- Credentials: Reuse saved passwords and keys across hosts, with host defaults you can set for the server, a user or a folder +- Sharing and Roles: Share hosts, credentials and folders with users or roles at four levels: connect, view, edit and manage +- Accounts: Local accounts, sessions you can see and revoke, trusted devices, API keys and an audit log +- Security: Passwords, keys and other secrets are encrypted per user, and the database can be encrypted on disk +- Desktop Sync: The desktop app runs on its own and can link to a Termix server to keep an offline copy of your account +- Interface: Tabs and split screen, a command palette (double tap left shift), rebindable shortcuts, themes, branding and around 30 languages +- Databases: SQLite by default, with PostgreSQL and MySQL supported too
@@ -133,7 +133,7 @@ Want to build your own? Start from the [plugin template](https://github.com/Term ## Installation -Visit the [Termix Docs](https://docs.termix.site/install) for full install steps on every platform. +See the [docs](https://docs.termix.site/install) for install steps on every platform. Sample Docker Compose file (you can leave out `guacd` and the network if you don't plan to use the Remote Desktop plugin): @@ -178,15 +178,15 @@ networks: ### Cloud Hosting -You can run Termix on a VPS instead of inside your own network. If Termix runs on the network it manages, an outage takes Termix down with it, right when you need it to fix things. Running it somewhere else keeps it reachable, gives you a static IP and lets you get in from anywhere without a VPN or port forward. +If Termix runs on the network it manages, an outage takes it down right when you need it. A VPS keeps it reachable, gives you a static IP and works from anywhere without a VPN or port forward. -[GINERNET](https://docs.termix.site/install/ginernet) sponsors Termix, and the docs have a step by step guide for their VPS platform. +[GINERNET](https://docs.termix.site/install/ginernet) sponsors Termix and the docs have a setup guide for their VPS.
## Donate -Termix is free and open source with no subscriptions or paid plans. If you find it useful, consider donating to help cover server costs, domains and development time. +Termix has no paid plans. Donations cover servers, domains and development time. [Donate](https://donate.termix.site/) @@ -194,7 +194,7 @@ Termix is free and open source with no subscriptions or paid plans. If you find ## Sponsors -Interested in a paid placement to support development? Email [mail@termix.site](mailto:mail@termix.site). +For a paid sponsor spot, email [mail@termix.site](mailto:mail@termix.site). @@ -242,7 +242,7 @@ Bugs and ideas for Termix itself (login, hosts, credentials, sharing, sync, the Every plugin has its own repo, so a problem with the terminal, file manager, Docker, remote desktop or any other plugin goes in that plugin's repo (see the table above, or use Report an issue on the plugin's page in the app, which fills in your versions for you). Not sure where it goes? Open it here and it will be moved. -You need to be logged in to GitHub. Please be as detailed as possible, preferably in English. +You need a GitHub account. Add as much detail as you can, in English if possible. For discussions and questions, join the [Discord](https://discord.gg/jVQGdvHDrf) server. Update videos are on [YouTube](https://www.youtube.com/@TermixSSH/videos). @@ -250,4 +250,4 @@ For discussions and questions, join the [Discord](https://discord.gg/jVQGdvHDrf) ## License -Distributed under the Apache License Version 2.0. See [LICENSE](LICENSE) for more information. +Apache License 2.0. See [LICENSE](LICENSE). diff --git a/packages/plugin-sdk/README.md b/packages/plugin-sdk/README.md index cc35c310a..a07f344f0 100644 --- a/packages/plugin-sdk/README.md +++ b/packages/plugin-sdk/README.md @@ -50,7 +50,7 @@ in place of the flags. Reload the page to pick up frontend changes. ## Support -Bugs and ideas for the SDK or the `termix-plugin` CLI go in the [Termix repo](https://github.com/Termix-SSH/Termix/issues/new/choose). You need to be logged in to GitHub. Please be as detailed as possible, preferably in English. +Bugs and ideas for the SDK or the `termix-plugin` CLI go in the [Termix repo](https://github.com/Termix-SSH/Termix/issues/new/choose). Add as much detail as you can, in English if possible. For discussions and questions, join the [Discord](https://discord.gg/jVQGdvHDrf) server. @@ -58,4 +58,4 @@ For discussions and questions, join the [Discord](https://discord.gg/jVQGdvHDrf) ## License -Distributed under the Apache License Version 2.0. See [LICENSE](https://github.com/Termix-SSH/Termix/blob/main/LICENSE) for more information. +Apache License 2.0. See [LICENSE](https://github.com/Termix-SSH/Termix/blob/main/LICENSE).