Public Access
chore: remove update-server docs [skip ci]
This commit is contained in:
@@ -1,56 +0,0 @@
|
||||
# Update Server — Dolibarr Modules
|
||||
|
||||
## Overview
|
||||
|
||||
MokoGitea provides a built-in Update Server that can serve Dolibarr-compatible JSON update feeds from repository releases. **No static feed 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 (set platform to `dolibarr`)
|
||||
3. **Create releases** with tagged module archives
|
||||
4. MokoGitea serves the update feed at `/{owner}/{repo}/updates/dolibarr.json`
|
||||
|
||||
## Feed URL
|
||||
|
||||
```
|
||||
https://git.mokoconsulting.tech/{owner}/{repo}/updates/dolibarr.json
|
||||
```
|
||||
|
||||
## Release Naming Convention
|
||||
|
||||
Release assets should follow:
|
||||
|
||||
```
|
||||
{module_name}-{version}.zip
|
||||
```
|
||||
|
||||
Examples:
|
||||
- `mokocrm-18.0.1.zip`
|
||||
- `mokodolisign-3.2.0.zip`
|
||||
|
||||
## Update Server Settings
|
||||
|
||||
Configure these in Settings > Update Server:
|
||||
|
||||
| Field | Description | Example |
|
||||
|-------|-------------|---------|
|
||||
| Platform | Set to `dolibarr` | `dolibarr` |
|
||||
| Extension Name | Dolibarr module directory name | `mokocrm` |
|
||||
| Display Name | Human-readable name | `Module - MokoCRM` |
|
||||
| Extension Type | Usually `module` | `module` |
|
||||
| Maintainer | Organization name | `Moko Consulting` |
|
||||
| Support URL | Product support page | `https://mokoconsulting.tech/support/mokocrm` |
|
||||
|
||||
## Download Gating
|
||||
|
||||
Same three modes as Joomla: `none`, `prerelease`, `all`.
|
||||
|
||||
## Status
|
||||
|
||||
Dolibarr Update Server support is currently **disabled for all modules except MokoCRM**. Metadata is pre-configured and ready to enable when needed.
|
||||
|
||||
## What NOT to Do
|
||||
|
||||
- **Do NOT commit static feed files to the repository**
|
||||
- **Do NOT use legacy update check mechanisms** — use the built-in feed
|
||||
Reference in New Issue
Block a user