sftpgo

name	sftpgo
description	Reference skill for SFTPGo — the managed file transfer platform. Load this skill when the user is writing, debugging, or generating SFTPGo configuration, REST API payloads, or Event Action / IDP / email / ICAP / filesystem templates for either the WebAdmin UI or the REST API. Current scope: authoring guide for Go text/template strings used across Event Actions (trigger↔context mapping, action-type↔sub-config mapping, full template context, registered functions, pitfalls, ready-to-paste examples including OIDC JIT provisioning). Expected to grow over time to cover other SFTPGo aspects (REST API idioms, user/group configuration, storage backends) — check the references/ directory for what is currently covered.
user-invocable	true
license	Apache-2.0
compatibility	Claude Code and any AI coding agent that consumes Markdown-based skill manifests. Content verified against SFTPGo v2.7.x runtime behavior.
allowed-tools	Read Edit Write Glob Grep Bash
metadata	{"author":"Nicola Murino","version":"0.5.0","upstream":{"site":"https://sftpgo.com","rest_api_docs":"https://sftpgo.com/rest-api","verified_against":"v2.7.x"},"current_scope":["Event Action templates — Go text/template authoring for email / HTTP / command / IDP / IMAP / ICAP / filesystem actions, as accepted both by the REST API (`/api/v2/events/actions`, `/api/v2/events/rules`) and by the WebAdmin UI form fields.","Deployment & configuration — installation methods, `sftpgo.<ext>` config file, `SFTPGO_…` environment variable convention, `env.d/` recipes, sysadmin pitfalls.","SaaS (fully-managed offering at `sftpgo.com`) — how to detect, `default` group convention, integrated S3 (`bucket=default`, `region=default`), tier-gated features, configuration changes that trigger an automated restart, what to avoid suggesting (CLI / env vars / config files).","Editions and distribution channels — Open Source vs Enterprise, third-party redistributions (managed-hosting providers, NAS / home-lab app stores, community Linux-package archives, unofficial Docker images), what Enterprise adds, detection signals, and the rule to flag Enterprise-only features plainly when the user is on OSS."],"references":["references/user-guide.md","references/editions.md","references/deployment.md","references/saas.md","references/template-context.md","references/template-functions.md","references/action-types.md","references/trigger-types.md","references/examples.md","references/pitfalls.md"]}

SFTPGo reference skill

Generic reference skill for SFTPGo. Content is organized under references/ by topic and grows over time. The skill is the primary entry point for any SFTPGo-related task — REST API usage, WebAdmin configuration, and Event Action template authoring. The deepest current coverage is on Event Action templates; the REST API and WebAdmin topics lean heavily on the authoritative OpenAPI spec (below) plus the enum and cross-field notes in references/.

When this skill applies

Load this skill when the user is:

• Installing, deploying, or configuring an SFTPGo server — picking the install method, writing sftpgo.json / env files, composing SFTPGO_… environment variables correctly, setting up the data provider, enabling HTTPS / ACME / Defender / metrics, activating a license. See references/deployment.md.
• Calling the SFTPGo REST API — any request to /api/v2/* (users, groups, folders, event rules, event actions, shares, admins, API keys, quota, retention, etc.). The skill teaches the shape conventions (tagged unions, required fields, secret envelopes, status codes) that make payloads validate on the server.
• Configuring SFTPGo through the WebAdmin — filling the forms for users, groups, virtual folders, event rules, event actions, shares, server config. The WebAdmin fields map 1-to-1 to the REST API JSON shape, so the same knowledge applies.
• Writing Event Action templates — Body/Subject/Endpoint/Headers/Paths/args/env/template_user/template_admin on any action type (HTTP, Command, Email, IMAP, ICAP, Filesystem, IDP account check). Both the raw paste-into-WebAdmin form and the full REST API JSON payload form are covered in references/examples.md.
• Debugging a template that "renders empty", a payload that gets rejected, or a rule that fires but produces the wrong output.

Where to get the authoritative sources

This skill is deliberately thin: it indexes the rest. Three external sources carry the ground truth, and this skill tells you which to consult for which question.

OpenAPI spec — for field names, enum values, required fields, schema shape:

• https://sftpgo.com/assets/openapi.yaml — refreshed on every public release, always the latest publicly released SFTPGo version.
• openapi/openapi.yaml inside the deployed SFTPGo installation — authoritative for that server (may be older than the public copy).