kosatka

package module
v0.1.10 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 11, 2026 License: MIT Imports: 2 Imported by: 0

README

Kosatka

A content management system written in Go.
Powerful tools for building any kind of site - a blog, a news portal, a community, a company site -
in a convenient admin, without writing code.

Documentation · Quick start · Releases

Features

  • Content types and fields - your own types with your own fields, including references between items, media and repeatable groups of fields.
  • Views - lists of content built in the admin: filters, sorts, pagers, related and similar content. Each one is a page, a block or a term page.
  • Blocks, menus and taxonomy - blocks in the theme's regions with visibility rules, menus, breadcrumbs, vocabularies with term pages.
  • Users and roles - permissions per role, registration or invitations, two-factor sign-in, social login.
  • Publishing - revisions, scheduled publishing, preview links for drafts, a trash.
  • Embeds - blocks, lists and forms right inside a text, inserted from the editor.
  • Comments - moderation and spam checks.
  • Search and SEO - search with live results, URL aliases and redirects, title and description templates, schema.org markup, a sitemap, RSS.
  • Media - image styles, a media library, files on disk or, with a storage package, in S3-compatible storage or Azure Blob Storage.
  • Mail - e-mail settings and texts in the admin; sending through any SMTP server, or a mail service's API with its module (Resend).
  • Languages - a multilingual interface, the languages downloaded separately; a site in several languages with the Languages module.
  • Statistics and reports - content views and other statistics, and a status report on the site's health.
  • Security - uploads checked by their content, private files, cleaned HTML, CSRF tokens, rate limits, an action log.
  • Monitoring - a JSON log with a line for every request and request ids, Prometheus metrics (requests by route, answer time, the database pool), a ready Grafana dashboard, Alloy configuration and alert rules (deploy/monitoring).

Extending

Running

  • MySQL or PostgreSQL - the schema migrations are built into the binary (app migrate).
  • Releases - Linux archives (amd64, arm64) and a Docker image, ghcr.io/kosatka-cms/kosatka (Running in production).
  • Multisite - one engine serves any number of sites, each with its own database, files and theme; one command updates them all, site by site, with a dump and a health check.

Quick start

git clone https://github.com/kosatka-cms/kosatka.git && cd kosatka
docker compose up --build

Open http://localhost:8080: a site with demo content. Sign in as admin with the password printed once in the log:

docker compose logs app | grep password

Other options, such as a site without the demo content: Run in Docker. Without Docker: Run from source.

Documentation

https://kosatka-cms.github.io/kosatka/: getting started, building a site, themes, modules, the app commands, the configuration and, for those who change the engine, how it works.

Contributing

./scripts/check.sh       # golangci-lint (gofmt, go vet and more), unit tests
./scripts/check.sh -db   # plus the tests on MySQL and PostgreSQL and the migrations against the schema (Docker)

How changes are made: CONTRIBUTING.md. To report a vulnerability, see SECURITY.md.

License

MIT

Documentation

Overview

Package kosatka - the engine as a library, for a site's own binary: its main package imports the modules it has from outside the engine (each registers itself, modulekit.Register) and calls Main.

package main

import (
	"github.com/kosatka-cms/kosatka"

	_ "example.com/kosatka-hello"
)

func main() { kosatka.Main() }

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GenerateMigrations

func GenerateMigrations()

GenerateMigrations runs the migrations generator (-name <name> writes the next migration of each changed set, -check fails when the files are behind the ent schemas) for the modules the binary imports: a module's own repository calls it from a main package importing the module, run in its tree - its migrations go into its own schema's directory (the databases: KOSATKA_TEST_MYSQL_DSN, KOSATKA_TEST_POSTGRES_DSN).

func Main

func Main()

Main runs the engine: the server, or the command its arguments name ("app help" lists them).

Types

This section is empty.

Directories

Path Synopsis
cmd
app command
Command app - the engine's binary: the site's server and its commands (kosatka.Main).
Command app - the engine's binary: the site's server and its commands (kosatka.Main).
i18n-extract command
Command i18n-extract writes the list of the code's interface strings (translations/sources/strings.json, embedded: the admin's interface strings page, the checks of a downloaded language):
Command i18n-extract writes the list of the code's interface strings (translations/sources/strings.json, embedded: the admin's interface strings page, the checks of a downloaded language):
migrations-gen command
Command migrations-gen writes the next schema migration of every set whose ent tables changed (internal/migrationsgen; scripts/ migrations_gen.sh starts the databases it needs).
Command migrations-gen writes the next schema migration of every set whose ent tables changed (internal/migrationsgen; scripts/ migrations_gen.sh starts the databases it needs).
internal
app
Package app - the engine's program: the server and its commands (install, migrate, theme…), run by Main.
Package app - the engine's program: the server and its commands (install, migrate, theme…), run by Main.
app/demoset
Package demoset - the demo sets of "app install -demo-set <name>": a whole demo site as data, sets/<name>/<lang>.yaml (or a theme's own, <theme>/demo/<lang>.yaml) - its theme, users, vocabularies, fields, content types, Views, blocks, menus and content (nodes with their field values, comments, view counts), in one language.
Package demoset - the demo sets of "app install -demo-set <name>": a whole demo site as data, sets/<name>/<lang>.yaml (or a theme's own, <theme>/demo/<lang>.yaml) - its theme, users, vocabularies, fields, content types, Views, blocks, menus and content (nodes with their field values, comments, view counts), in one language.
app/starter
Package starter - what a new site starts with (app install), as data: starter.yaml describes the site's look, image styles, fields, content types, Views and menus; Apply creates them.
Package starter - what a new site starts with (app install), as data: starter.yaml describes the site's look, image styles, fields, content types, Views and menus; Apply creates them.
buildinfo
Package buildinfo - what the running binary is: the engine's release, the commit and time it was built from (recorded by the Go toolchain from git, debug.ReadBuildInfo), the Go version; for a site's own binary (its main calls kosatka.Main) - the engine as its dependency and the site's module.
Package buildinfo - what the running binary is: the engine's release, the commit and time it was built from (recorded by the Go toolchain from git, debug.ReadBuildInfo), the Go version; for a site's own binary (its main calls kosatka.Main) - the engine as its dependency and the site's module.
domain/assets
Package assets - the versioned URLs of the minified static files: the engine's (/static/css, /static/js), a theme's (/static/themes/<theme>, the first theme of its chain with the file) and a module's (/static/modules/<module>).
Package assets - the versioned URLs of the minified static files: the engine's (/static/css, /static/js), a theme's (/static/themes/<theme>, the first theme of its chain with the file) and a module's (/static/modules/<module>).
domain/audit
Package audit - the actions done on the site that an action log keeps (who deleted content, changed a role's permissions, signed in): the core and the modules Record them, a listener (the action log module, OnAction) stores them.
Package audit - the actions done on the site that an action log keeps (who deleted content, changed a role's permissions, signed in): the core and the modules Record them, a listener (the action log module, OnAction) stores them.
domain/fallback
Package fallback - logging an error that the code handles itself by falling back to something (a default value, an empty list) instead of returning it.
Package fallback - logging an error that the code handles itself by falling back to something (a default value, an empty list) instead of returning it.
domain/imageurl
Package imageurl builds the web paths of public files (public:// URIs) and of their image-style derivatives.
Package imageurl builds the web paths of public files (public:// URIs) and of their image-style derivatives.
domain/themes
Package themes - the themes: their manifests (theme.yaml, InfoFile; a subtheme's merged with its base's, LoadInfoFor), the list the Appearance page shows (Available, Invalid), their settings (SettingsService), the blocks a theme comes with (PlaceBlocks), the catalog of themes kept in their own repositories (Catalog) and themes/themes.lock (ReadLock).
Package themes - the themes: their manifests (theme.yaml, InfoFile; a subtheme's merged with its base's, LoadInfoFor), the list the Appearance page shows (Available, Invalid), their settings (SettingsService), the blocks a theme comes with (PlaceBlocks), the catalog of themes kept in their own repositories (Catalog) and themes/themes.lock (ReadLock).
domain/twofactor
Package twofactor - two-factor sign-in: time-based codes of an authenticator app (TOTP, RFC 6238: HMAC-SHA1, 6 digits, 30 seconds), one-time recovery codes, and the service turning it on and off and checking a code at sign-in.
Package twofactor - two-factor sign-in: time-based codes of an authenticator app (TOTP, RFC 6238: HMAC-SHA1, 6 digits, 30 seconds), one-time recovery codes, and the service turning it on and off and checking a code at sign-in.
domain/views
Package views - Views: lists of content or comments configured in the admin (filters, sorts, fields; displays: a page, a block, an attachment, a term's page, a profile tab), published as snapshots and run against the database.
Package views - Views: lists of content or comments configured in the admin (filters, sorts, fields; displays: a page, a block, an attachment, a term's page, a profile tab), published as snapshots and run against the database.
i18nextract
Package i18nextract finds the interface strings of the code so the catalogs can be checked for missing translations (cmd/i18n-extract and the completeness test): t, tc, plural and tjs in templates; Kosatka.t, Kosatka.tc and Kosatka.formatPlural in JavaScript (static files and inline scripts); i18n.T, i18n.TC, i18n.Plural, i18n.N, i18n.NC and i18n.Errorf in Go.
Package i18nextract finds the interface strings of the code so the catalogs can be checked for missing translations (cmd/i18n-extract and the completeness test): t, tc, plural and tjs in templates; Kosatka.t, Kosatka.tc and Kosatka.formatPlural in JavaScript (static files and inline scripts); i18n.T, i18n.TC, i18n.Plural, i18n.N, i18n.NC and i18n.Errorf in Go.
i18npack
Package i18npack builds a translations catalog - the index.json the sites download languages by (service.TranslationsCatalog) and a catalog file per language next to it - from a translations repository:
Package i18npack builds a translations catalog - the index.json the sites download languages by (service.TranslationsCatalog) and a catalog file per language next to it - from a translations repository:
i18ntest
Package i18ntest holds a small Russian catalog for the engine's tests (pkg/i18n's format): the strings tests check in a language other than English - month names, number separators, plural forms, a few labels.
Package i18ntest holds a small Russian catalog for the engine's tests (pkg/i18n's format): the strings tests check in a language other than English - month names, number separators, plural forms, a few labels.
infrastructure/demo
Package demo - the demo content of "app install -demo" beyond the core's (internal/app): the steps the modules register (Register, like migrations.RegisterInstall) and what every demo step shares - its texts by language, the sea pictures, image files, nodes, comments, block placements and menu links.
Package demo - the demo content of "app install -demo" beyond the core's (internal/app): the steps the modules register (Register, like migrations.RegisterInstall) and what every demo step shares - its texts by language, the sea pictures, image files, nodes, comments, block placements and menu links.
infrastructure/ent/database/viewquery
Package viewquery runs Views on the ent schema (entity.ViewQuery): a display's filters, sorts and pager over nodes or comments, its glossary bar and the "similar content" ranking.
Package viewquery runs Views on the ent schema (entity.ViewQuery): a display's filters, sorts and pager over nodes or comments, its glossary bar and the "similar content" ranking.
infrastructure/filestorage
Package filestorage - the storages a site's files can be kept in besides its directories (files.storage, files.private_storage): drivers that packages outside the engine register (modulekit.AddFileStorage), like database/sql's drivers.
Package filestorage - the storages a site's files can be kept in besides its directories (files.storage, files.private_storage): drivers that packages outside the engine register (modulekit.AddFileStorage), like database/sql's drivers.
infrastructure/migrations
Package migrations versions the database schema, generated: the ent schemas describe the tables, and for every change scripts/migrations_gen.sh writes a migration file per database (MySQL, PostgreSQL) into files/<dialect>/<set>/ (embedded in the binary) - or, for a module with its own ent schema (RegisterSchema), into that module's migration files.
Package migrations versions the database schema, generated: the ent schemas describe the tables, and for every change scripts/migrations_gen.sh writes a migration file per database (MySQL, PostgreSQL) into files/<dialect>/<set>/ (embedded in the binary) - or, for a module with its own ent schema (RegisterSchema), into that module's migration files.
infrastructure/oauth
Package oauth - the site's OAuth providers (internal/lib/oauth) built from the config and the admin settings, with the engine's callback route.
Package oauth - the site's OAuth providers (internal/lib/oauth) built from the config and the admin settings, with the engine's callback route.
infrastructure/sqldialect
Package sqldialect keeps hand-written SQL portable between MySQL and PostgreSQL: the few constructs that differ (placeholders, upsert, the id of an inserted row, random order, today's date) go through these helpers instead of being written for one database.
Package sqldialect keeps hand-written SQL portable between MySQL and PostgreSQL: the few constructs that differ (placeholders, upsert, the id of an inserted row, random order, today's date) go through these helpers instead of being written for one database.
lib/dateformat
Package dateformat formats dates by PHP date()-style patterns (entity.DateFormat).
Package dateformat formats dates by PHP date()-style patterns (entity.DateFormat).
lib/debounce
Package debounce coalesces bursts of calls into one.
Package debounce coalesces bursts of calls into one.
lib/htmlimages
Package htmlimages rewrites <img> tags in HTML content into resized-preview links (with PhotoSwipe captions), using an imagestyle.ResizeService.
Package htmlimages rewrites <img> tags in HTML content into resized-preview links (with PhotoSwipe captions), using an imagestyle.ResizeService.
lib/mailsender
Package mailsender sends transactional email via SMTP.
Package mailsender sends transactional email via SMTP.
lib/metrics
Package metrics - the service's metrics in the Prometheus text format (version 0.0.4), the one Prometheus, Grafana Alloy, VictoriaMetrics and the Elastic Agent read: counters, histograms and values read when the metrics are asked for.
Package metrics - the service's metrics in the Prometheus text format (version 0.0.4), the one Prometheus, Grafana Alloy, VictoriaMetrics and the Elastic Agent read: counters, histograms and values read when the metrics are asked for.
lib/numberformat
Package numberformat shows numbers by a language's separators: the decimal one and the one between thousands, each a translation of its own (message contexts ContextDecimal, ContextThousands: "." and "," in English).
Package numberformat shows numbers by a language's separators: the decimal one and the one between thousands, each a translation of its own (message contexts ContextDecimal, ContextThousands: "." and "," in English).
lib/oauth
Package oauth - OAuth 2.0 sign-in with Google, VK ID and Yandex: the authorization URL, the code exchange and the user's profile normalized to Profile.
Package oauth - OAuth 2.0 sign-in with Google, VK ID and Yandex: the authorization URL, the code exchange and the user's profile normalized to Profile.
lib/photoswipe
Package photoswipe builds markup for the PhotoSwipe gallery viewer.
Package photoswipe builds markup for the PhotoSwipe gallery viewer.
lib/requestid
Package requestid - the request's id: in its context, in the X-Request-Id response header and in the log lines written with the context (Handler), so a page's answer and its log lines can be matched.
Package requestid - the request's id: in its context, in the X-Request-Id response header and in the log lines written with the context (Handler), so a page's answer and its log lines can be matched.
lib/searchtext
Package searchtext turns text into the words a search index keeps and a query into the words it looks for: folded (lowercase, "ё" as "е") and stemmed in a language (Snowball), so "cats" finds "cat".
Package searchtext turns text into the words a search index keeps and a query into the words it looks for: folded (lowercase, "ё" as "е") and stemmed in a language (Snowball), so "cats" finds "cat".
lib/secretbox
Package secretbox seals the secrets a site keeps in its database (the keys and passwords of outside services, the two-factor secrets) with a key from its environment, so a dump of the database doesn't give them away: AES-256-GCM, the key derived from the given one with HKDF-SHA256.
Package secretbox seals the secrets a site keeps in its database (the keys and passwords of outside services, the two-factor secrets) with a key from its environment, so a dump of the database doesn't give them away: AES-256-GCM, the key derived from the given one with HKDF-SHA256.
lib/slogquiet
Package slogquiet keeps errors that aren't the server's fault out of the ERROR level: a request the client cancelled or a connection it closed (context canceled, broken pipe, connection reset) is logged at DEBUG.
Package slogquiet keeps errors that aren't the server's fault out of the ERROR level: a request the client cancelled or a connection it closed (context canceled, broken pipe, connection reset) is logged at DEBUG.
lib/textdiff
Package textdiff compares two texts for a side-by-side view: by paragraphs, then by words inside the paragraphs that changed.
Package textdiff compares two texts for a side-by-side view: by paragraphs, then by words inside the paragraphs that changed.
migrationsgen
Package migrationsgen writes the next schema migration of every set whose ent tables changed, for MySQL and PostgreSQL (scripts/ migrations_gen.sh starts the databases it needs).
Package migrationsgen writes the next schema migration of every set whose ent tables changed, for MySQL and PostgreSQL (scripts/ migrations_gen.sh starts the databases it needs).
modules
Package modules lists what the modules (internal/modules/<name>) give the core at startup: their Wire and their files - one entry per module here, besides its manifest in manifests.All() (TestEveryModuleListed checks both lists agree); a module from outside the engine gives the same with modulekit.Register, and its interface catalogs too (the engine's modules are translated by the downloaded languages).
Package modules lists what the modules (internal/modules/<name>) give the core at startup: their Wire and their files - one entry per module here, besides its manifest in manifests.All() (TestEveryModuleListed checks both lists agree); a module from outside the engine gives the same with modulekit.Register, and its interface catalogs too (the engine's modules are translated by the downloaded languages).
modules/action_log/ent
Package ent - the action log module's own ent schema (schema/), its generated client (generated/, go generate) and migration files (migrations/<dialect>/, scripts/migrations_gen.sh writes them), apart from the core's: the module's set of migrations (Schema).
Package ent - the action log module's own ent schema (schema/), its generated client (generated/, go generate) and migration files (migrations/<dialect>/, scripts/migrations_gen.sh writes them), apart from the core's: the module's set of migrations (Schema).
modules/action_log/ent/schema
Package schema - the action log module's own ent schema: the recorded actions and the module's settings.
Package schema - the action log module's own ent schema: the recorded actions and the module's settings.
modules/action_log/manifest
Package manifest declares the action log module (its registry entry): who did what on the site - content deleted, a role's permissions changed, settings saved, sign-ins.
Package manifest declares the action log module (its registry entry): who did what on the site - content deleted, a role's permissions changed, settings saved, sign-ins.
modules/complaints
Package complaints - the complaints module: signed-in visitors report a content item or a comment (a reason, a note), moderators decide in the queue (Content → Complaints); enough complaints of different visitors hide the item until they do.
Package complaints - the complaints module: signed-in visitors report a content item or a comment (a reason, a note), moderators decide in the queue (Content → Complaints); enough complaints of different visitors hide the item until they do.
modules/complaints/ent
Package ent - the complaints module's own ent schema (schema/), its generated client (generated/, go generate) and migration files (migrations/<dialect>/, scripts/migrations_gen.sh writes them), apart from the core's: the module's set of migrations (Schema).
Package ent - the complaints module's own ent schema (schema/), its generated client (generated/, go generate) and migration files (migrations/<dialect>/, scripts/migrations_gen.sh writes them), apart from the core's: the module's set of migrations (Schema).
modules/complaints/ent/schema
Package schema - the complaints module's own ent schema: its tables, apart from the core's (internal/infrastructure/ent/schema).
Package schema - the complaints module's own ent schema: its tables, apart from the core's (internal/infrastructure/ent/schema).
modules/complaints/manifest
Package manifest declares the complaints module (its registry entry).
Package manifest declares the complaints module (its registry entry).
modules/error_reports/ent
Package ent - the error reports module's own ent schema (schema/), its generated client (generated/, go generate) and migration files (migrations/<dialect>/, scripts/migrations_gen.sh writes them), apart from the core's: the module's set of migrations (Schema).
Package ent - the error reports module's own ent schema (schema/), its generated client (generated/, go generate) and migration files (migrations/<dialect>/, scripts/migrations_gen.sh writes them), apart from the core's: the module's set of migrations (Schema).
modules/error_reports/ent/schema
Package schema - the error reports module's own ent schema: its tables, apart from the core's (internal/infrastructure/ent/schema).
Package schema - the error reports module's own ent schema: its tables, apart from the core's (internal/infrastructure/ent/schema).
modules/error_reports/manifest
Package manifest declares the error reports module (its registry entry).
Package manifest declares the error reports module (its registry entry).
modules/feeds/ent
Package ent - the feeds module's own ent schema (schema/), its generated client (generated/, go generate) and migration files (migrations/<dialect>/, scripts/migrations_gen.sh writes them), apart from the core's: the module's set of migrations (Schema).
Package ent - the feeds module's own ent schema (schema/), its generated client (generated/, go generate) and migration files (migrations/<dialect>/, scripts/migrations_gen.sh writes them), apart from the core's: the module's set of migrations (Schema).
modules/feeds/ent/schema
Package schema - the feeds module's own ent schema: its tables, apart from the core's.
Package schema - the feeds module's own ent schema: its tables, apart from the core's.
modules/feeds/manifest
Package manifest declares the feeds module (its registry entry).
Package manifest declares the feeds module (its registry entry).
modules/forms/ent
Package ent - the forms module's own ent schema (schema/), its generated client (generated/, go generate) and migration files (migrations/<dialect>/, scripts/migrations_gen.sh writes them), apart from the core's: the module's set of migrations (Schema).
Package ent - the forms module's own ent schema (schema/), its generated client (generated/, go generate) and migration files (migrations/<dialect>/, scripts/migrations_gen.sh writes them), apart from the core's: the module's set of migrations (Schema).
modules/forms/ent/schema
Package schema - the forms module's ent schema, apart from the core's.
Package schema - the forms module's ent schema, apart from the core's.
modules/forms/manifest
Package manifest declares the forms module (its registry entry): a "form" content type whose items have their own elements and collect submissions.
Package manifest declares the forms module (its registry entry): a "form" content type whose items have their own elements and collect submissions.
modules/galleries/ent
Package ent - the galleries module's own ent schema (schema/), its generated client (generated/, go generate) and migration files (migrations/<dialect>/, scripts/migrations_gen.sh writes them), apart from the core's: the module's set of migrations (Schema).
Package ent - the galleries module's own ent schema (schema/), its generated client (generated/, go generate) and migration files (migrations/<dialect>/, scripts/migrations_gen.sh writes them), apart from the core's: the module's set of migrations (Schema).
modules/galleries/ent/schema
Package schema - the galleries module's own ent schema: its tables, apart from the core's.
Package schema - the galleries module's own ent schema: its tables, apart from the core's.
modules/galleries/manifest
Package manifest declares the galleries module (its registry entry).
Package manifest declares the galleries module (its registry entry).
modules/languages/ent
Package ent - the languages module's own ent schema (schema/), its generated client (generated/, go generate) and migration files (migrations/<dialect>/, scripts/migrations_gen.sh writes them), apart from the core's: the module's set of migrations (Schema).
Package ent - the languages module's own ent schema (schema/), its generated client (generated/, go generate) and migration files (migrations/<dialect>/, scripts/migrations_gen.sh writes them), apart from the core's: the module's set of migrations (Schema).
modules/languages/ent/schema
Package schema - the languages module's own ent schema: which content items translate which, and the module's settings.
Package schema - the languages module's own ent schema: which content items translate which, and the module's settings.
modules/languages/manifest
Package manifest declares the languages module (its registry entry): the site's languages besides its default one, each at its own address prefix (/en/…), the language switcher and the pages' addresses in the other languages for search engines.
Package manifest declares the languages module (its registry entry): the site's languages besides its default one, each at its own address prefix (/en/…), the language switcher and the pages' addresses in the other languages for search engines.
modules/manifests
Package manifests registers every module of the engine (its manifest: entity.Module and install steps), then those from outside it (modulekit.Register) - the one list of the modules the binary carries.
Package manifests registers every module of the engine (its manifest: entity.Module and install steps), then those from outside it (modulekit.Register) - the one list of the modules the binary carries.
modules/not_found_log/ent
Package ent - the 404 log module's own ent schema (schema/), its generated client (generated/, go generate) and migration files (migrations/<dialect>/, scripts/migrations_gen.sh writes them), apart from the core's: the module's set of migrations (Schema).
Package ent - the 404 log module's own ent schema (schema/), its generated client (generated/, go generate) and migration files (migrations/<dialect>/, scripts/migrations_gen.sh writes them), apart from the core's: the module's set of migrations (Schema).
modules/not_found_log/ent/schema
Package schema - the 404 log module's own ent schema: the paths asked for and not found, and the module's settings.
Package schema - the 404 log module's own ent schema: the paths asked for and not found, and the module's settings.
modules/not_found_log/manifest
Package manifest declares the 404 log module (its registry entry): the paths visitors asked for and the site didn't find, with a redirect made from any of them in a click.
Package manifest declares the 404 log module (its registry entry): the paths visitors asked for and the site didn't find, with a redirect made from any of them in a click.
modules/polls/ent
Package ent - the polls module's own ent schema (schema/), its generated client (generated/, go generate) and migration files (migrations/<dialect>/, scripts/migrations_gen.sh writes them), apart from the core's: the module's set of migrations (Schema).
Package ent - the polls module's own ent schema (schema/), its generated client (generated/, go generate) and migration files (migrations/<dialect>/, scripts/migrations_gen.sh writes them), apart from the core's: the module's set of migrations (Schema).
modules/polls/ent/schema
Package schema - the polls module's own ent schema: its tables, apart from the core's.
Package schema - the polls module's own ent schema: its tables, apart from the core's.
modules/polls/manifest
Package manifest declares the polls module (its registry entry).
Package manifest declares the polls module (its registry entry).
modules/private_messages
Package privatemessages - the private messages module: conversations (threads) between users, their members and messages; the profile's messages tab, the thread and new message pages, the e-mail of a new message, the unread count in the user menu.
Package privatemessages - the private messages module: conversations (threads) between users, their members and messages; the profile's messages tab, the thread and new message pages, the e-mail of a new message, the unread count in the user menu.
modules/private_messages/ent
Package ent - the private messages module's own ent schema (schema/), its generated client (generated/, go generate) and migration files (migrations/<dialect>/, scripts/migrations_gen.sh writes them), apart from the core's: the module's set of migrations (Schema).
Package ent - the private messages module's own ent schema (schema/), its generated client (generated/, go generate) and migration files (migrations/<dialect>/, scripts/migrations_gen.sh writes them), apart from the core's: the module's set of migrations (Schema).
modules/private_messages/ent/schema
Package schema - the private messages module's own ent schema: its tables (pm_threads, pm_thread_members, pm_messages), apart from the core's.
Package schema - the private messages module's own ent schema: its tables (pm_threads, pm_thread_members, pm_messages), apart from the core's.
modules/private_messages/manifest
Package manifest declares the private messages module (its registry entry): conversations between users, the messages tab of the profile.
Package manifest declares the private messages module (its registry entry): conversations between users, the messages tab of the profile.
modules/ratings
Package ratings - star ratings of content: a voter's vote for a content item, its average and count on the item's page (the node_rating block) and in Views (the module's sorts, filters and field).
Package ratings - star ratings of content: a voter's vote for a content item, its average and count on the item's page (the node_rating block) and in Views (the module's sorts, filters and field).
modules/ratings/ent
Package ent - the ratings module's own ent schema (schema/), its generated client (generated/, go generate) and migration files (migrations/<dialect>/, scripts/migrations_gen.sh writes them), apart from the core's: the module's set of migrations (Schema).
Package ent - the ratings module's own ent schema (schema/), its generated client (generated/, go generate) and migration files (migrations/<dialect>/, scripts/migrations_gen.sh writes them), apart from the core's: the module's set of migrations (Schema).
modules/ratings/manifest
Package manifest declares the ratings module (its registry entry).
Package manifest declares the ratings module (its registry entry).
modules/subscriptions
Package subscriptions - the subscriptions module: users follow a content item's comments or a term's new content; what happens there becomes their notifications, on the site (the profile's Notifications tab, the user menu) and by e-mail (at once, a daily digest or never).
Package subscriptions - the subscriptions module: users follow a content item's comments or a term's new content; what happens there becomes their notifications, on the site (the profile's Notifications tab, the user menu) and by e-mail (at once, a daily digest or never).
modules/subscriptions/ent
Package ent - the subscriptions module's own ent schema (schema/), its generated client (generated/, go generate) and migration files (migrations/<dialect>/, scripts/migrations_gen.sh writes them), apart from the core's: the module's set of migrations (Schema).
Package ent - the subscriptions module's own ent schema (schema/), its generated client (generated/, go generate) and migration files (migrations/<dialect>/, scripts/migrations_gen.sh writes them), apart from the core's: the module's set of migrations (Schema).
modules/subscriptions/ent/schema
Package schema - the subscriptions module's own ent schema: its tables, apart from the core's.
Package schema - the subscriptions module's own ent schema: its tables, apart from the core's.
modules/subscriptions/manifest
Package manifest declares the subscriptions module (its registry entry): subscriptions to content's comments and to terms, the notifications of them on the site and by e-mail.
Package manifest declares the subscriptions module (its registry entry): subscriptions to content's comments and to terms, the notifications of them on the site and by e-mail.
modules/video_embed/ent
Package ent - the video embed module's own ent schema (schema/), its generated client (generated/, go generate) and migration files (migrations/<dialect>/, scripts/migrations_gen.sh writes them), apart from the core's: the module's set of migrations (Schema).
Package ent - the video embed module's own ent schema (schema/), its generated client (generated/, go generate) and migration files (migrations/<dialect>/, scripts/migrations_gen.sh writes them), apart from the core's: the module's set of migrations (Schema).
modules/video_embed/ent/schema
Package schema - the video embed module's own ent schema: what the video services say about the videos linked in texts, and the module's settings.
Package schema - the video embed module's own ent schema: what the video services say about the videos linked in texts, and the module's settings.
modules/video_embed/manifest
Package manifest declares the video embed module (its registry entry): a link to a video on its own line in a text shows as the video's player.
Package manifest declares the video embed module (its registry entry): a link to a video on its own line in a text shows as the video's player.
themeinstall
Package themeinstall installs, updates and removes the themes kept in their own git repositories (app theme …, internal/app/theme.go): a theme's repository is its directory (theme.yaml at its root), its releases are its tags (v1.2.0).
Package themeinstall installs, updates and removes the themes kept in their own git repositories (app theme …, internal/app/theme.go): a theme's repository is its directory (theme.yaml at its root), its releases are its tags (v1.2.0).
Package modulekit - the module SDK: what the engine hands a module at startup (Deps) and what the module hands back (Parts), and everything else a module uses of the core: its controllers' base, the hooks, the core's types and helpers.
Package modulekit - the module SDK: what the engine hands a module at startup (Deps) and what the module hands back (Parts), and everything else a module uses of the core: its controllers' base, the hooks, the core's types and helpers.
demokit
Package demokit - the part of the module SDK a module's demo step uses (app install -demo, docs/modules/write-a-module.md): the step's registration, its texts by language, a block and a menu link of the core's, and the install transaction for the module's own ent client.
Package demokit - the part of the module SDK a module's demo step uses (app install -demo, docs/modules/write-a-module.md): the step's registration, its texts by language, a block and a menu link of the core's, and the install transaction for the module's own ent client.
manifestkit
Package manifestkit - the part of the module SDK (modulekit) a module's manifest and own ent schema use: the module's description and its schema's registration.
Package manifestkit - the part of the module SDK (modulekit) a module's manifest and own ent schema use: the module's description and its schema's registration.
schemakit
Package schemakit - the engine's conventions for ent schemas, shared by the core's schema and a module's own (its ent/schema): the same table options and column types, so a module's tables look as the core's do.
Package schemakit - the engine's conventions for ent schemas, shared by the core's schema and a module's own (its ent/schema): the same table options and column types, so a module's tables look as the core's do.
testkit
Package testkit - the part of the module SDK a module's tests use, as a module from its own repository can:
Package testkit - the part of the module SDK a module's tests use, as a module from its own repository can:
pkg
embedtag
Package embedtag reads the embed tags of a text: [[<kind>:<name>]] stands for something embedded in its place when the text is shown (a block, a View's list), and is left out of the text's excerpts.
Package embedtag reads the embed tags of a text: [[<kind>:<name>]] stands for something embedded in its place when the text is shown (a block, a View's list), and is left out of the text's excerpts.
filestore
Package filestore keeps files under keys - slash-separated paths relative to the store's root ("content/images/a.jpg") - whatever holds them: a directory on disk (Local) or a bucket of an object storage.
Package filestore keeps files under keys - slash-separated paths relative to the store's root ("content/images/a.jpg") - whatever holds them: a directory on disk (Local) or a bucket of an object storage.
filestore/filestoretest
Package filestoretest checks that a filestore.Store keeps the package's contract: every store runs the same tests (Run).
Package filestoretest checks that a filestore.Store keeps the package's contract: every store runs the same tests (Run).
fsname
Package fsname sanitizes arbitrary (including Cyrillic) strings into safe filesystem path segments and file name stems.
Package fsname sanitizes arbitrary (including Cyrillic) strings into safe filesystem path segments and file name stems.
htmlsanitize
Package htmlsanitize sanitizes user-submitted HTML (comments, forum posts, private messages, profile signatures) before it is stored, stripping dangerous markup (<script>, event handlers, javascript: URLs, <iframe>, etc.) while keeping the common safe formatting tags a rich-text editor produces: bold/italic/underline, links, images, lists, and so on.
Package htmlsanitize sanitizes user-submitted HTML (comments, forum posts, private messages, profile signatures) before it is stored, stripping dangerous markup (<script>, event handlers, javascript: URLs, <iframe>, etc.) while keeping the common safe formatting tags a rich-text editor produces: bold/italic/underline, links, images, lists, and so on.
i18n
Package i18n translates the interface (t()/formatPlural()): source strings are English, catalogs give their translations per language.
Package i18n translates the interface (t()/formatPlural()): source strings are English, catalogs give their translations per language.
mailtemplate
Package mailtemplate substitutes [site:...]/[user:...] placeholders, and a module's own (TokenData.Extra), in email subject/body templates.
Package mailtemplate substitutes [site:...]/[user:...] placeholders, and a module's own (TokenData.Extra), in email subject/body templates.
metadescription
Package metadescription builds a plain-text meta description from HTML content.
Package metadescription builds a plain-text meta description from HTML content.
panicsafe
Package panicsafe recovers panics in goroutines that run outside Go's per-request HTTP panic recovery.
Package panicsafe recovers panics in goroutines that run outside Go's per-request HTTP panic recovery.
randtoken
Package randtoken generates cryptographically random, hex-encoded tokens.
Package randtoken generates cryptographically random, hex-encoded tokens.
sitetime
Package sitetime holds the site's time zone (entity.SiteInformation.Timezone): dates are stored in UTC and shown in this zone.
Package sitetime holds the site's time zone (entity.SiteInformation.Timezone): dates are stored in UTC and shown in this zone.
sitetime/internal/zonesgen command
Command zonesgen writes pkg/sitetime/zones_gen.go - the canonical IANA time zones (the tz database's Zone entries, not its Link aliases) of the world's regions, from a tzdata.zi file (default /usr/share/zoneinfo/tzdata.zi).
Command zonesgen writes pkg/sitetime/zones_gen.go - the canonical IANA time zones (the tz database's Zone entries, not its Link aliases) of the world's regions, from a tzdata.zi file (default /usr/share/zoneinfo/tzdata.zi).
textcut
Package textcut cuts text to a length in characters (runes): a letter is never split, whatever its script.
Package textcut cuts text to a length in characters (runes): a letter is never split, whatever its script.
translit
Package translit writes Cyrillic letters in Latin: the one table the slugs and the file names use.
Package translit writes Cyrillic letters in Latin: the one table the slugs and the file names use.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL