Skip to content

Commit 125dcb2

Browse files
committed
docs(update-mechanisms): update PLG file example and add CLI plugin commands for better clarity
1 parent 35b3074 commit 125dcb2

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

docs/advanced/update-mechanisms.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Your PLG file's version is defined in the DOCTYPE:
2020

2121
```xml
2222
<!DOCTYPE PLUGIN [
23-
<!ENTITY name "yourplugin">
23+
<!ENTITY name "your.plugin">
2424
<!ENTITY author "Your Name">
2525
<!ENTITY version "2024.01.15">
2626
<!ENTITY pluginURL "https://raw.githubusercontent.com/you/repo/main/yourplugin.plg">
@@ -34,7 +34,7 @@ Your PLG file's version is defined in the DOCTYPE:
3434
Common versioning schemes:
3535

3636
| Scheme | Example | Notes |
37-
|--------|---------|-------|
37+
| ------ | ------- | ----- |
3838
| Date-based | `2024.01.15` | Common for Unraid plugins |
3939
| SemVer | `1.2.3` | Major.Minor.Patch |
4040
| Hybrid | `2024.01.15a` | Date with suffix |
@@ -46,11 +46,13 @@ Unraid checks the `pluginURL` for updates. The remote PLG version is compared to
4646
### Hosting PLG Files
4747

4848
**GitHub Raw (most common):**
49+
4950
```xml
5051
<!ENTITY pluginURL "https://raw.githubusercontent.com/username/repo/main/yourplugin.plg">
5152
```
5253

5354
**GitHub Pages:**
55+
5456
```xml
5557
<!ENTITY pluginURL "https://username.github.io/repo/yourplugin.plg">
5658
```
@@ -122,11 +124,22 @@ if ($newVersion) {
122124
?>
123125
```
124126

127+
## CLI Plugin Commands
128+
129+
Unraid provides a wrapper for plugin actions (mostly for automation or debugging):
130+
131+
- `plugin install <url>` - install a plugin from a .plg URL
132+
- `plugin delete <name>` - remove an installed plugin
133+
- `plugin update <name>` - force update check + install new version
134+
- `plugin check <name>` - check remote version without installing
135+
136+
These commands are useful for script-driven plugin maintenance and matched by `pluginURL` updates.
137+
125138
## Branch Strategies
126139

127140
### Stable Releases
128141

129-
```
142+
```text
130143
main/master branch → pluginURL for stable releases
131144
```
132145

@@ -186,6 +199,7 @@ Always include checksums for security:
186199
```
187200

188201
Generate MD5:
202+
189203
```bash
190204
md5sum package.txz
191205
```

0 commit comments

Comments
 (0)