Ethica/Termix
1
0 Fork 0
mirror of https://github.com/Termix-SSH/Termix.git synced 2026-10-29 06:35:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

plugins/docker/README.md
+36 -25
View File
@@ -1,37 +1,48 @@
# Docker
<div align="center">
Manage Docker and Podman containers over SSH, with logs and a container console.
<img src="https://raw.githubusercontent.com/Termix-SSH/Termix/main/public/icon.svg" width="120" height="120" alt="Termix Logo" />
<h1>Docker</h1>
<p>Manage Docker and Podman containers on your hosts</p>
</div>
<br />
## Overview
Docker manages the containers running on your hosts over SSH. It is not meant to replace Portainer or Dockge, just to handle the containers you already have.
<br />
## Features
- List, inspect, start, stop, restart, pause and remove containers.
- Read and download container logs.
- Open an interactive console inside a container.
- Works with Docker or Podman.
- Adds a Docker widget to the homepage.
- Start, stop, restart, pause and remove containers
- Live CPU, memory, network and disk stats
- Read and download container logs
- Open a shell inside a container
- Works with Docker and Podman
## Settings
### Host
- Enable Docker: show the Docker tab for this host.
- Container Runtime: Docker or Podman.
## Permissions
- `docker.use`: Use Docker. Admins and users have it by default.
<br />
## Services
Provides to other plugins:
- `docker.containers`: list containers and start, stop, restart, pause, unpause or remove them.
- `docker.events`: get notified when a container starts, exits, restarts or turns unhealthy.
- `docker.containers`: list containers and start, stop, restart, pause, unpause or remove them
- `docker.events`: get notified when a container starts, exits, restarts or turns unhealthy
## 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.