Files
HS-Rename/docs/GEARLEVER.md
T
Bulk RenamerandCursor db460fb9b3 Release v1.0.4: fix TheTVDB search ID parsing.
Parse series-76320 style search hits from TheTVDB v4, document Gear Lever Forgejo setup, and adjust AppImage build metadata for update detection.

Co-authored-by: Cursor <[email protected]>
2026-07-03 17:17:49 -05:00

68 lines
2.4 KiB
Markdown

# Using HSRename with Gear Lever
[Gear Lever](https://github.com/mijorus/gearlever) 4.x can update HSRename from Gitea releases. Gitea uses the same API as **Forgejo**, which Gear Lever supports directly.
## Important: use Forgejo, not Default
In the HSRename details screen:
- **Source** must be **Forgejo** (not `Default`).
- The **Website** field is only metadata. It does **not** check for updates.
- Do **not** paste the release download URL into Website.
## Configure updates (Gear Lever 4+)
1. Open **Gear Lever** → select **HSRename**.
2. Set **Source** to **Forgejo**.
3. Fill in:
| Field | Value |
|-------|--------|
| **Repo URL** | `https://git.hisora.dev/Dawnsorrow/HS-Rename` |
| **Release file name** | `HSRename.AppImage` |
| **Allow pre-releases** | Off (unless you want draft releases) |
4. Save, then use **Check for updates** / **List updates**.
If the fields validate (no error), Gear Lever queries:
`https://git.hisora.dev/api/v1/repos/Dawnsorrow/HS-Rename/releases/latest`
and compares the release asset size with your local AppImage.
## Direct download URL pattern
For release tag `vX.Y.Z`:
```
https://git.hisora.dev/Dawnsorrow/HS-Rename/releases/download/vX.Y.Z/HSRename.AppImage
```
Latest release today:
```
https://git.hisora.dev/Dawnsorrow/HS-Rename/releases/download/v1.0.3/HSRename.AppImage
```
## Fallback: Static URL
If Forgejo does not work in your Gear Lever build, set **Source** to **Static URL** and paste the **exact** URL of the newest release (update this manually each release):
```
https://git.hisora.dev/Dawnsorrow/HS-Rename/releases/download/v1.0.3/HSRename.AppImage
```
## CLI (if `gearlever` is installed)
Gear Lever 4 may use different CLI options than older docs. Prefer the GUI Forgejo fields above. If your install still supports `--set-update-url`, the old wildcard pattern is **not** reliable for self-hosted Gitea; use Forgejo instead.
## Troubleshooting
| Symptom | Likely cause |
|---------|----------------|
| No update offered | Source is still **Default**, or local file is already the latest release (same size as `releases/latest`). |
| URL looks truncated in Website | Website is cosmetic only; configure **Forgejo** fields instead. |
| Update never finds newer builds | Wrong repo URL, wrong filename, or release has no `HSRename.AppImage` asset attached. |
Releases page: https://git.hisora.dev/Dawnsorrow/HS-Rename/releases