Files
summercms/docs/index.md
Jakub Zych f3e8a984b0 docs(quick-261015-w7f): docs since v0.1.14 and the Upgrading to 0.2 notes
- new setup/upgrading.md: version rule, the two 0.2 boot refusals with
  their fixes, behaviour changes, and what 0.2 adds since 0.1
- architecture module table lists all 28 modules
- WinterCMS map: cache and reorder are provided; rows for field types,
  sanitizing, singletons, API tokens, CORS, Turnstile, menu item types
- configuration keys for CORS profiles, api_docs, auth.cookie, turnstile
- index, setup intro and frontend page link the new topics
2026-10-15 23:24:56 +02:00

2.2 KiB

title, description, section, order
title description section order
SummerCMS documentation SummerCMS is a content management framework for Go, inspired by WinterCMS. index 0

SummerCMS documentation

SummerCMS keeps what makes WinterCMS productive (plugins that extend each other, YAML-driven admin forms and lists, console scaffolding) and compiles an application into a single Go binary. The framework modules, the application's plugins, the embedded admin SPA and the console commands all ship as one executable.

Start with Installation to set up the toolchain and the summer CLI. If you know WinterCMS, read Coming from WinterCMS for a map of its concepts to SummerCMS. Then follow Porting a plugin, which moves a WinterCMS plugin to SummerCMS step by step. The API reference section has one page per framework module.

Where to start

  • Setup: what SummerCMS is, installation, configuration, the move from WinterCMS, a plugin porting walkthrough and Upgrading to a newer release, with what to check before 0.2.
  • Architecture: the single binary, Go modules, the application lifecycle, the request lifecycle and performance and scaling compared with PHP-FPM.
  • Plugins: registering a plugin, scheduling, extending other plugins, menu item types and testing.
  • Backend: admin controllers, forms, lists, relations, plugin field types, users and API tokens, settings and the admin SPA.
  • Database: models, migrations, queries, relations, casts, attachments and transactions.
  • Services: configuration, events, routing, authentication, caching, mail, jobs, realtime, search and the other services, plus what SummerCMS does not provide for the frontend.
  • Console: the summer tool, the application binary's commands and writing your own.