chore: rework plugin readmes, json changelogs and standalone repo setup

This commit is contained in:
LukeGus committed 2026-10-04 21:25:16 -05:00
1 parent a8f383d2b3
commit 29a946d02e
500 files changed
+6729 -1250

No files matched your search

+35 -23
View File
@@ -1,35 +1,47 @@
# Tunnels
<div align="center">
SSH port forwarding between servers, plus local tunnels from the desktop app.
<img src="https://raw.githubusercontent.com/Termix-SSH/Termix/main/public/icon.svg" width="120" height="120" alt="Termix Logo" />
<h1>Tunnels</h1>
<p>SSH port forwarding that stays connected</p>
</div>
<br />
## Overview
Tunnels forwards ports through your servers so you can reach services that are not exposed.
<br />
## Features
- Local, remote and dynamic (SOCKS5) SSH tunnels saved on a host.
- Start tunnels from the Tunnels tab or the host editor, or on boot.
- Route a tunnel through a second host.
- Local tunnels from the desktop app, with saved presets.
- Adds a tunnels widget to the homepage.
- Local, remote and dynamic SOCKS5 forwarding
- Reconnects on its own when a tunnel drops
- Start tunnels on boot
- Route a tunnel through a second host
- Client tunnels on your own computer from the desktop app, with presets you can save to the server
## Settings
### Host
- Enable tunnels and the list of saved tunnels for this host.
## Permissions
- `tunnels.use`: Use tunnels. Admins and users have it by default.
<br />
## Services
Provides to other plugins:
- `tunnels.access`: open a tunnel on demand, or start, stop and check saved tunnels.
- `tunnels.access`: open a tunnel on demand, or start, stop and check saved tunnels
## Development
<br />
```bash
npm run build # build into dist/
npm run test # run this plugin's tests
npm run typecheck # type-check this plugin
```
## Support
To report a bug or request a feature, open a [support ticket](https://github.com/Termix-SSH/Support/issues/new/choose). You need to be logged in to GitHub. Please be as detailed as possible, preferably in English.
For discussions and questions, join the [Discord](https://discord.gg/jVQGdvHDrf) server.
<br />
## License
Distributed under the Apache License Version 2.0. See [LICENSE](https://github.com/Termix-SSH/Termix/blob/main/LICENSE) for more information.