diff --git a/templates/docs/required/template-update-server-joomla.md b/templates/docs/required/template-update-server-joomla.md deleted file mode 100644 index d47dc93..0000000 --- a/templates/docs/required/template-update-server-joomla.md +++ /dev/null @@ -1,90 +0,0 @@ -# Update Server — Joomla Extensions - -## Overview - -MokoGitea provides a built-in Update Server that dynamically generates Joomla-compatible update XML feeds from repository releases. **No static `updates.xml` file is needed in the repository.** - -## How It Works - -1. **Enable Update Server** in the repository's Settings > Advanced Settings -2. **Configure metadata** in Settings > Update Server (extension name, type, target version, etc.) -3. **Create releases** with tagged assets (e.g. `pkg_mokowaas-02.19.00.zip`) -4. MokoGitea automatically serves the update feed at `/{owner}/{repo}/updates.xml` - -## Feed URL - -``` -https://git.mokoconsulting.tech/{owner}/{repo}/updates.xml -``` - -This URL is what goes into your Joomla extension's `update_server` element in the manifest XML. - -## Manifest Configuration - -In your extension's manifest XML (`*.xml`), add: - -```xml - - - https://git.mokoconsulting.tech/MokoConsulting/{RepoName}/updates.xml - - -``` - -## Release Naming Convention - -Release assets must follow this naming pattern for the feed generator to detect them: - -``` -{extension_name}-{version}.zip -{extension_name}-{version}.tar.gz -``` - -Examples: -- `pkg_mokowaas-02.19.00.zip` -- `tpl_mokoonyx-02.19.00.zip` -- `mod_mokojoomhero-01.05.00.zip` - -## Update Server Settings - -Configure these in Settings > Update Server: - -| Field | Description | Example | -|-------|-------------|---------| -| Extension Name | Joomla element name | `pkg_mokowaas` | -| Display Name | Human-readable name | `Package - MokoWaaS` | -| Extension Type | package, plugin, template, module, component | `package` | -| Target Version | Regex for compatible Joomla versions | `(5|6)\..*` | -| PHP Minimum | Minimum PHP version | `8.1` | -| Maintainer | Organization name | `Moko Consulting` | -| Maintainer URL | Organization website | `https://mokoconsulting.tech` | -| Support URL | Product support page | `https://mokoconsulting.tech/products/{alias}` | -| Info URL | Product information page | `https://mokoconsulting.tech/products/{alias}` | - -## Download Gating - -Three modes control who can download release assets: - -| Mode | Behavior | -|------|----------| -| `none` | All downloads are public | -| `prerelease` | Pre-release downloads require a license key; stable releases are public | -| `all` | All downloads require a license key | - -The update feed XML is **always public** — only the actual file downloads are gated. - -## What NOT to Do - -- **Do NOT commit `updates.xml` to the repository** — it is served dynamically -- **Do NOT use static update server workflows** — the old CI-generated approach is deprecated -- **Do NOT hardcode version numbers in feed URLs** — the feed auto-detects from releases - -## Changelog Feed - -A changelog XML is also served automatically at: - -``` -https://git.mokoconsulting.tech/{owner}/{repo}/changelog.xml -``` - -This is generated from release notes (markdown body of each release).