fix(project-manager): remover Dify KB das descriptions, marcar nota TODO
Dify foi removido 06-03-2026. Skills brainstorm/discover ainda referenciam-no no corpo. Bump v1.2 + nota top-of-file. Reescrita workflow para próxima sessão. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -1,5 +1,9 @@
|
||||
# EasyPanel API - Service Configuration
|
||||
|
||||
**Verificado:** 12-03-2026 (engenharia reversa do backend.js)
|
||||
|
||||
---
|
||||
|
||||
## Actualizar Source (GitHub)
|
||||
|
||||
```bash
|
||||
@@ -18,6 +22,8 @@ curl -s -X POST "http://localhost:3000/api/trpc/services.app.updateSourceGithub"
|
||||
|
||||
## Actualizar Source (Git Custom)
|
||||
|
||||
**IMPORTANTE:** Os parametros `repo`, `ref`, `path` devem estar no nivel RAIZ do JSON, NAO dentro de um objecto `source`.
|
||||
|
||||
```bash
|
||||
curl -s -X POST "http://localhost:3000/api/trpc/services.app.updateSourceGit" \
|
||||
-H "Authorization: Bearer $TOKEN" \
|
||||
@@ -25,12 +31,22 @@ curl -s -X POST "http://localhost:3000/api/trpc/services.app.updateSourceGit" \
|
||||
-d '{"json":{
|
||||
"projectName":"descomplicar",
|
||||
"serviceName":"minha-api",
|
||||
"repo":"https://git.descomplicar.pt/org/repo",
|
||||
"repo":"https://ealmeida:TOKEN@git.descomplicar.pt/ealmeida/repo",
|
||||
"ref":"main",
|
||||
"path":"/"
|
||||
}}'
|
||||
```
|
||||
|
||||
**Errado (causa zodErrors):**
|
||||
```json
|
||||
{"json":{"projectName":"x","serviceName":"y","source":{"type":"git","repo":"...","ref":"main","path":"/"}}}
|
||||
```
|
||||
|
||||
**Correcto:**
|
||||
```json
|
||||
{"json":{"projectName":"x","serviceName":"y","repo":"...","ref":"main","path":"/"}}
|
||||
```
|
||||
|
||||
## Actualizar Source (Docker Image)
|
||||
|
||||
```bash
|
||||
@@ -57,48 +73,20 @@ curl -s -X POST "http://localhost:3000/api/trpc/services.app.updateEnv" \
|
||||
}}'
|
||||
```
|
||||
|
||||
## Actualizar Domains
|
||||
## Actualizar Build Config
|
||||
|
||||
```bash
|
||||
curl -s -X POST "http://localhost:3000/api/trpc/services.app.updateDomains" \
|
||||
curl -s -X POST "http://localhost:3000/api/trpc/services.app.updateBuild" \
|
||||
-H "Authorization: Bearer $TOKEN" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"json":{
|
||||
"projectName":"descomplicar",
|
||||
"serviceName":"minha-api",
|
||||
"domains":[
|
||||
{"host":"api.descomplicar.pt","https":true,"port":3000}
|
||||
]
|
||||
}}'
|
||||
```
|
||||
|
||||
## Actualizar Mounts
|
||||
|
||||
```bash
|
||||
curl -s -X POST "http://localhost:3000/api/trpc/services.app.updateMounts" \
|
||||
-H "Authorization: Bearer $TOKEN" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"json":{
|
||||
"projectName":"descomplicar",
|
||||
"serviceName":"minha-api",
|
||||
"mounts":[
|
||||
{"type":"volume","name":"data","mountPath":"/app/data"}
|
||||
]
|
||||
}}'
|
||||
```
|
||||
|
||||
## Actualizar Ports (non-HTTP)
|
||||
|
||||
```bash
|
||||
curl -s -X POST "http://localhost:3000/api/trpc/services.app.updatePorts" \
|
||||
-H "Authorization: Bearer $TOKEN" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"json":{
|
||||
"projectName":"descomplicar",
|
||||
"serviceName":"minha-api",
|
||||
"ports":[
|
||||
{"published":8080,"target":3000,"protocol":"tcp"}
|
||||
]
|
||||
"build":{
|
||||
"type":"nixpacks",
|
||||
"buildCommand":"npm run build",
|
||||
"startCommand":"npm start"
|
||||
}
|
||||
}}'
|
||||
```
|
||||
|
||||
@@ -120,23 +108,6 @@ curl -s -X POST "http://localhost:3000/api/trpc/services.app.updateResources" \
|
||||
}}'
|
||||
```
|
||||
|
||||
## Actualizar Build Config
|
||||
|
||||
```bash
|
||||
curl -s -X POST "http://localhost:3000/api/trpc/services.app.updateBuild" \
|
||||
-H "Authorization: Bearer $TOKEN" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"json":{
|
||||
"projectName":"descomplicar",
|
||||
"serviceName":"minha-api",
|
||||
"build":{
|
||||
"type":"nixpacks",
|
||||
"buildCommand":"npm run build",
|
||||
"startCommand":"npm start"
|
||||
}
|
||||
}}'
|
||||
```
|
||||
|
||||
## Actualizar Deploy (Replicas, Command)
|
||||
|
||||
```bash
|
||||
@@ -154,6 +125,45 @@ curl -s -X POST "http://localhost:3000/api/trpc/services.app.updateAdvanced" \
|
||||
}}'
|
||||
```
|
||||
|
||||
## Actualizar Redirects
|
||||
|
||||
```bash
|
||||
curl -s -X POST "http://localhost:3000/api/trpc/services.app.updateRedirects" \
|
||||
-H "Authorization: Bearer $TOKEN" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"json":{
|
||||
"projectName":"descomplicar",
|
||||
"serviceName":"minha-api",
|
||||
"redirects":[]
|
||||
}}'
|
||||
```
|
||||
|
||||
## Actualizar Basic Auth
|
||||
|
||||
```bash
|
||||
curl -s -X POST "http://localhost:3000/api/trpc/services.app.updateBasicAuth" \
|
||||
-H "Authorization: Bearer $TOKEN" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"json":{
|
||||
"projectName":"descomplicar",
|
||||
"serviceName":"minha-api",
|
||||
"basicAuth":{"enabled":false}
|
||||
}}'
|
||||
```
|
||||
|
||||
## Actualizar Maintenance Mode
|
||||
|
||||
```bash
|
||||
curl -s -X POST "http://localhost:3000/api/trpc/services.app.updateMaintenance" \
|
||||
-H "Authorization: Bearer $TOKEN" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"json":{
|
||||
"projectName":"descomplicar",
|
||||
"serviceName":"minha-api",
|
||||
"maintenance":{"enabled":false}
|
||||
}}'
|
||||
```
|
||||
|
||||
## Database Backup Config
|
||||
|
||||
```bash
|
||||
@@ -176,3 +186,98 @@ curl -s -X POST "http://localhost:3000/api/trpc/services.postgres.updateBackup"
|
||||
}
|
||||
}}'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Domains API (Namespace separado)
|
||||
|
||||
**IMPORTANTE:** Os dominios NAO sao geridos por `services.app.*` mas sim pelo namespace `domains.*`.
|
||||
|
||||
### Listar Dominios (GET)
|
||||
|
||||
```bash
|
||||
INPUT='{"json":{"projectName":"descomplicar"}}'
|
||||
ENCODED=$(python3 -c "import urllib.parse; print(urllib.parse.quote('$INPUT'))")
|
||||
curl -s "http://localhost:3000/api/trpc/domains.listDomains?input=$ENCODED" \
|
||||
-H "Authorization: Bearer $TOKEN"
|
||||
```
|
||||
|
||||
### Criar Dominio (POST)
|
||||
|
||||
```bash
|
||||
curl -s -X POST "http://localhost:3000/api/trpc/domains.createDomain" \
|
||||
-H "Authorization: Bearer $TOKEN" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"json":{
|
||||
"id":"meu-dominio-id",
|
||||
"https":true,
|
||||
"host":"app.descomplicar.pt",
|
||||
"path":"/",
|
||||
"middlewares":[],
|
||||
"certificateResolver":"letsencrypt",
|
||||
"wildcard":false,
|
||||
"destinationType":"service",
|
||||
"serviceDestination":{
|
||||
"protocol":"http",
|
||||
"port":3000,
|
||||
"path":"/",
|
||||
"projectName":"descomplicar",
|
||||
"serviceName":"meu-servico"
|
||||
}
|
||||
}}'
|
||||
```
|
||||
|
||||
**Notas:**
|
||||
- O `id` pode ser qualquer string unica (cuid ou slug)
|
||||
- `certificateResolver`: `"letsencrypt"` para HTTPS, `""` para dominios internos
|
||||
- `destinationType`: `"service"` para servicos EasyPanel, `"custom"` para destinos externos
|
||||
|
||||
### Actualizar Dominio (POST)
|
||||
|
||||
```bash
|
||||
curl -s -X POST "http://localhost:3000/api/trpc/domains.updateDomain" \
|
||||
-H "Authorization: Bearer $TOKEN" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"json":{...mesmo schema de createDomain...}}'
|
||||
```
|
||||
|
||||
### Remover Dominio (POST)
|
||||
|
||||
```bash
|
||||
curl -s -X POST "http://localhost:3000/api/trpc/domains.deleteDomain" \
|
||||
-H "Authorization: Bearer $TOKEN" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"json":{"id":"meu-dominio-id"}}'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Resumo de Endpoints de Configuracao
|
||||
|
||||
| Endpoint | Tipo | Descricao | Verificado |
|
||||
|----------|------|-----------|:----------:|
|
||||
| `services.app.updateSourceGithub` | POST | Source GitHub (`owner`,`repo`,`ref`,`path`) | Sim |
|
||||
| `services.app.updateSourceGit` | POST | Source Git custom (`repo`,`ref`,`path` RAIZ) | Sim |
|
||||
| `services.app.updateSourceImage` | POST | Source Docker image (`image`) | Sim |
|
||||
| `services.app.updateEnv` | POST | Variaveis de ambiente (`env` string) | Sim |
|
||||
| `services.app.updateBuild` | POST | Build config (`type`,`buildCommand`,`startCommand`) | Sim |
|
||||
| `services.app.updateResources` | POST | CPU/RAM limits | Sim |
|
||||
| `services.app.updateAdvanced` | POST | Deploy avancado (replicas, command, zeroDowntime) | Sim |
|
||||
| `services.app.updateRedirects` | POST | Redireccionamentos HTTP | Sim |
|
||||
| `services.app.updateBasicAuth` | POST | Autenticacao basica | Sim |
|
||||
| `services.app.updateMaintenance` | POST | Modo manutencao | Sim |
|
||||
| `domains.listDomains` | GET | Listar dominios (`projectName`) | Sim |
|
||||
| `domains.createDomain` | POST | Criar dominio | Sim |
|
||||
| `domains.updateDomain` | POST | Actualizar dominio | Sim |
|
||||
| `domains.deleteDomain` | POST | Remover dominio | Sim |
|
||||
|
||||
**Endpoints que NAO existem na versao instalada:**
|
||||
- ~~`services.app.updateDomains`~~ — usar `domains.createDomain`
|
||||
- ~~`services.app.updateMounts`~~ — nao encontrado
|
||||
- ~~`services.app.updatePorts`~~ — nao encontrado
|
||||
- ~~`services.app.saveDomains`~~ — nao existe
|
||||
- ~~`services.app.saveGithubSource`~~ — usar `updateSourceGithub` ou `updateSourceGit`
|
||||
|
||||
---
|
||||
|
||||
*Actualizado: 12-03-2026*
|
||||
|
||||
@@ -1,10 +1,12 @@
|
||||
# EasyPanel API - Services
|
||||
|
||||
**Verificado:** 12-03-2026 (engenharia reversa do backend.js)
|
||||
|
||||
## Service Types
|
||||
|
||||
| Type | Descricao |
|
||||
|------|-----------|
|
||||
| `app` | Aplicacao (Node.js, Python, Go, etc.) |
|
||||
| `app` | Aplicacao (Node.js, Python, Go, Rust, etc.) |
|
||||
| `mysql` | MySQL database |
|
||||
| `mariadb` | MariaDB database |
|
||||
| `postgres` | PostgreSQL database |
|
||||
@@ -42,14 +44,16 @@ curl -s -X POST "http://localhost:3000/api/trpc/services.redis.createService" \
|
||||
-d '{"json":{"projectName":"descomplicar","serviceName":"cache"}}'
|
||||
```
|
||||
|
||||
## Inspeccionar Servico
|
||||
## Inspeccionar Servico (GET)
|
||||
|
||||
```bash
|
||||
curl -s "http://localhost:3000/api/trpc/services.app.inspectService?input=%7B%22json%22%3A%7B%22projectName%22%3A%22descomplicar%22%2C%22serviceName%22%3A%22dashboard_descomplicar%22%7D%7D" \
|
||||
INPUT='{"json":{"projectName":"descomplicar","serviceName":"dashboard_descomplicar"}}'
|
||||
ENCODED=$(python3 -c "import urllib.parse; print(urllib.parse.quote('$INPUT'))")
|
||||
curl -s "http://localhost:3000/api/trpc/services.app.inspectService?input=$ENCODED" \
|
||||
-H "Authorization: Bearer $TOKEN"
|
||||
```
|
||||
|
||||
Response:
|
||||
Response parcial:
|
||||
```json
|
||||
{
|
||||
"projectName": "descomplicar",
|
||||
@@ -74,22 +78,30 @@ curl -s -X POST "http://localhost:3000/api/trpc/services.app.deployService" \
|
||||
-d '{"json":{"projectName":"descomplicar","serviceName":"minha-api"}}'
|
||||
```
|
||||
|
||||
## Enable/Disable Servico
|
||||
## Stop / Start / Restart Servico
|
||||
|
||||
```bash
|
||||
# Disable
|
||||
curl -s -X POST "http://localhost:3000/api/trpc/services.app.disableService" \
|
||||
# Parar servico
|
||||
curl -s -X POST "http://localhost:3000/api/trpc/services.app.stopService" \
|
||||
-H "Authorization: Bearer $TOKEN" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"json":{"projectName":"descomplicar","serviceName":"minha-api"}}'
|
||||
|
||||
# Enable
|
||||
curl -s -X POST "http://localhost:3000/api/trpc/services.app.enableService" \
|
||||
# Iniciar servico
|
||||
curl -s -X POST "http://localhost:3000/api/trpc/services.app.startService" \
|
||||
-H "Authorization: Bearer $TOKEN" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"json":{"projectName":"descomplicar","serviceName":"minha-api"}}'
|
||||
|
||||
# Reiniciar servico
|
||||
curl -s -X POST "http://localhost:3000/api/trpc/services.app.restartService" \
|
||||
-H "Authorization: Bearer $TOKEN" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"json":{"projectName":"descomplicar","serviceName":"minha-api"}}'
|
||||
```
|
||||
|
||||
**IMPORTANTE:** `enableService` e `disableService` NAO existem na versao instalada. Usar `startService`/`stopService`.
|
||||
|
||||
## Destruir Servico
|
||||
|
||||
```bash
|
||||
@@ -98,3 +110,26 @@ curl -s -X POST "http://localhost:3000/api/trpc/services.app.destroyService" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"json":{"projectName":"descomplicar","serviceName":"minha-api"}}'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Resumo de Endpoints
|
||||
|
||||
| Endpoint | Tipo | Descricao | Verificado |
|
||||
|----------|------|-----------|:----------:|
|
||||
| `services.app.createService` | POST | Criar servico app | Sim |
|
||||
| `services.postgres.createService` | POST | Criar PostgreSQL | Sim |
|
||||
| `services.mysql.createService` | POST | Criar MySQL | Sim |
|
||||
| `services.redis.createService` | POST | Criar Redis | Sim |
|
||||
| `services.app.inspectService` | GET | Inspeccionar servico | Sim |
|
||||
| `services.app.deployService` | POST | Fazer deploy | Sim |
|
||||
| `services.app.stopService` | POST | Parar servico | Sim |
|
||||
| `services.app.startService` | POST | Iniciar servico | Sim |
|
||||
| `services.app.restartService` | POST | Reiniciar servico | Sim |
|
||||
| `services.app.destroyService` | POST | Destruir servico | Sim |
|
||||
|
||||
**Endpoints que NAO existem:** `enableService`, `disableService`, `redeployService`
|
||||
|
||||
---
|
||||
|
||||
*Actualizado: 12-03-2026*
|
||||
|
||||
Reference in New Issue
Block a user