felis/community-plugins
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: standardize and validate plugin READMEs

Browse Source
This commit is contained in:
Lemmy
2026-07-15 21:56:42 -04:00
parent 1148c2d698
commit c057379c91
17 changed files with 700 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files
mini-docker/README.md
+39 -16
View File
@@ -1,32 +1,55 @@
# Mini Docker
Mini Docker is a Noctalia v5 plugin for managing Docker from the shell. The bar widget shows Docker availability and the running-container count. Its management panel can start, stop, restart, and remove containers; run and remove images; and inspect or remove volumes and networks.
Mini Docker manages Docker containers, images, volumes, and networks from
Noctalia. Its bar widget shows Docker availability and the number of running
containers, while its panel provides common management actions.
This Luau implementation migrates the Noctalia v4 Mini Docker plugin originally written by [MannuVilasara](https://github.com/MannuVilasara).
## Plugin
| Field | Value |
| --- | --- |
| ID | `8bury/mini-docker` |
| Entries | Bar widget: `mini-docker`; panel: `manager`; service: `docker-service` |
## Requirements
- Noctalia 5.0.0 or newer
- Docker CLI and a reachable Docker daemon
- Permission for the current user to access Docker
Install the Docker `docker` CLI and make sure your user can connect to the
Docker daemon. Test that `docker info` succeeds without unexpected prompts.
## Usage
Enable `8bury/mini-docker`, then add its `mini-docker` widget to a bar. Click the widget to open the management panel. Right-click it to refresh Docker state immediately.
Add the `mini-docker` widget to a bar. Left-click it to open the management
panel and right-click it to refresh Docker state immediately.
Open the panel directly with:
```sh
noctalia msg panel-toggle 8bury/mini-docker:manager
```
The panel has four tabs:
- Containers: start, stop, restart, or remove a selected container
- Images: run an image with optional name, network, port, and environment variables, or remove an unused image
- Volumes: inspect and remove volumes
- Networks: inspect and remove non-default networks
- **Containers:** start, stop, restart, and remove containers.
- **Images:** run images with an optional name, network, published port, and
environment variables; remove images that are not in use.
- **Volumes:** inspect and remove volumes.
- **Networks:** inspect and remove non-default networks.
Settings control the refresh interval, default run network, running count, icon color, and status indicator.
## Settings
## Security
| Setting | Type | Default | Description |
| --- | --- | --- | --- |
| `refresh_interval` | `int` | `5` | Seconds between Docker state refreshes. |
| `default_network` | `string` | `bridge` | Network initially selected when running an image. |
| `show_count` | `bool` | `true` | Shows the running-container count in the widget. |
| `glyph_color` | `select` | `on_surface` | Theme color used for the Docker glyph. |
| `status_mode` | `select` | `always` | Shows the status dot always, only while running, or never. |
| `active_color` | `select` | `tertiary` | Status color when a container is running. |
| `inactive_color` | `select` | `error` | Status color when no containers are running. |
Mini Docker invokes only the local `docker` CLI. Subprocess arguments are shell-quoted, and user-entered container names, ports, and environment-variable keys are validated before execution.
## Notes
## License
MIT. Attribution to the original v4 author is retained above.
Mini Docker runs the local Docker CLI with your user's existing daemon access.
Destructive actions require confirmation in the panel. It does not request
elevated privileges, store Docker credentials, mount host paths, or expose
ports unless you explicitly configure a port while running an image.