Directories
¶
| Path | Synopsis |
|---|---|
|
Package boundaries holds a test enforcing ContentKit's package layering from the module's dependency graph (go list; no compilation or services).
|
Package boundaries holds a test enforcing ContentKit's package layering from the module's dependency graph (go list; no compilation or services). |
|
Package codes writes the content-code registry (content_codes) for the packages that own content: contenturl for host content, groups and content for ContentKit's own records.
|
Package codes writes the content-code registry (content_codes) for the packages that own content: contenturl for host content, groups and content for ContentKit's own records. |
|
Package contract renders ContentKit's route catalog (internal/httpapi) and error-code registry as the files other tools read: api/openapi.json, the Go client's methods (client_gen.go), the browser SDK's generated route table, wire types and error codes, and docs/api/routes.md.
|
Package contract renders ContentKit's route catalog (internal/httpapi) and error-code registry as the files other tools read: api/openapi.json, the Go client's methods (client_gen.go), the browser SDK's generated route table, wire types and error codes, and docs/api/routes.md. |
|
gen
command
Command gen writes the files generated from the route catalog (go generate ./internal/contract).
|
Command gen writes the files generated from the route catalog (go generate ./internal/contract). |
|
Package domainpolicy resolves and applies per-content-kind domain rules.
|
Package domainpolicy resolves and applies per-content-kind domain rules. |
|
Package edition is the one default-version rule: the version a reader of a language opens by default is the first live version by position serving that language, else the first live version (contentkit-ui defaultVersion).
|
Package edition is the one default-version rule: the version a reader of a language opens by default is the first live version by position serving that language, else the first live version (contentkit-ui defaultVersion). |
|
Package gate builds ContentKit's route gates from the host's auth.
|
Package gate builds ContentKit's route gates from the host's auth. |
|
Package httpapi is ContentKit's HTTP surface as data.
|
Package httpapi is ContentKit's HTTP surface as data. |
|
Package hub is the engine's search and signal planes for one tenant: keyword search and typeahead, and the ClickHouse signal plane.
|
Package hub is the engine's search and signal planes for one tenant: keyword search and typeahead, and the ClickHouse signal plane. |
|
Package jobhook lets ContentKit's own white-box tests work the engine's jobs on a River client they configure (a queue subset, one worker).
|
Package jobhook lets ContentKit's own white-box tests work the engine's jobs on a River client they configure (a queue subset, one worker). |
|
Package jobqueue derives stable app-owned queues for catalog-bound workers.
|
Package jobqueue derives stable app-owned queues for catalog-bound workers. |
|
media
|
|
|
image
Package image is the media worker's image producer (libvips, CGO): the Image presets' private WebP files, the Zip presets, the public presets' owned generations, editor views, and the kinds' default public images.
|
Package image is the media worker's image producer (libvips, CGO): the Image presets' private WebP files, the Zip presets, the public presets' owned generations, editor views, and the kinds' default public images. |
|
video
Package video runs an item's video-family presets with ffmpeg: HLS (a byte-range fMP4 ladder with the source's audio and text tracks and a seek sprite), MP4 (a muxed H.264 file at one rung), Audio (an HLS track and an M4A) and Subtitles (clean WebVTT), and grabs the frames of uploads that declare Upload.Frames.
|
Package video runs an item's video-family presets with ffmpeg: HLS (a byte-range fMP4 ladder with the source's audio and text tracks and a seek sprite), MP4 (a muxed H.264 file at one rung), Audio (an HLS track and an M4A) and Subtitles (clean WebVTT), and grabs the frames of uploads that declare Upload.Frames. |
|
worker
Package worker is the media worker: the one process that places uploads and runs every producer, from the host's worker River schema (Config.Schema) in its database: staged uploads hashed and placed at their blobs (media.Manifests.Place), images, zips, public presets and editor views (media/image, libvips), and HLS, MP4, subtitles and frames (media/video, ffmpeg).
|
Package worker is the media worker: the one process that places uploads and runs every producer, from the host's worker River schema (Config.Schema) in its database: staged uploads hashed and placed at their blobs (media.Manifests.Place), images, zips, public presets and editor views (media/image, libvips), and HLS, MP4, subtitles and frames (media/video, ffmpeg). |
|
workqueue
Package workqueue is the host's side of the media worker (media/worker): the River schema it drains in the host database, insert-only enqueueing and cancelling of its jobs, and processing progress for the read API.
|
Package workqueue is the host's side of the media worker (media/worker): the River schema it drains in the host database, insert-only enqueueing and cancelling of its jobs, and processing progress for the read API. |
|
Package migrations owns ContentKit's PostgreSQL and ClickHouse migrations.
|
Package migrations owns ContentKit's PostgreSQL and ClickHouse migrations. |
|
Package normalize cleans user query text before retrieval.
|
Package normalize cleans user query text before retrieval. |
|
Package pglock holds Postgres session advisory locks on dedicated connections, so the holder's work may use every connection of its pool.
|
Package pglock holds Postgres session advisory locks on dedicated connections, so the holder's work may use every connection of its pool. |
|
Package pgtest provisions disposable keyword-profile schemas on the CONTENTKIT_TEST_URL Postgres for integration tests.
|
Package pgtest provisions disposable keyword-profile schemas on the CONTENTKIT_TEST_URL Postgres for integration tests. |
|
Package popularity prepares reusable UTC-day participation counts and ranks available works by their mean daily readers/(eligible population+20).
|
Package popularity prepares reusable UTC-day participation counts and ranks available works by their mean daily readers/(eligible population+20). |
|
Package ratelimit admits events per key against one or more sliding windows ("at most Limit in any Per"), in process or shared through Redis (or Garnet).
|
Package ratelimit admits events per key against one or more sliding windows ("at most Limit in any Per"), in process or shared through Redis (or Garnet). |
|
Package readerprefs carries shared app-scoped entity preferences.
|
Package readerprefs carries shared app-scoped entity preferences. |
|
Package resolve is how ContentKit's modules ask whether content exists, is visible, opens and is edited by a viewer.
|
Package resolve is how ContentKit's modules ask whether content exists, is visible, opens and is edited by a viewer. |
|
Package search is ContentKit's keyword retrieval over content_search_documents: exact names and aliases, literal substrings, prefixes and bounded typos for every language, with eligibility applied inside every indexed route.
|
Package search is ContentKit's keyword retrieval over content_search_documents: exact names and aliases, literal substrings, prefixes and bounded typos for every language, with eligibility applied inside every indexed route. |
|
Package versionid carries a version id between Go, where a content key's is "" for the work itself (contentref.ContentKey), and Postgres, where no version is NULL.
|
Package versionid carries a version id between Go, where a content key's is "" for the work itself (contentref.ContentKey), and Postgres, where no version is NULL. |
|
Package worker maintains one tenant's keyword documents: it expands deferred marks, drains the dirty queue and runs a bounded cursor backfill, building every document from ContentKit's own records through its Sources (the catalog's content, the groups').
|
Package worker maintains one tenant's keyword documents: it expands deferred marks, drains the dirty queue and runs a bounded cursor backfill, building every document from ContentKit's own records through its Sources (the catalog's content, the groups'). |
Click to show internal directories.
Click to hide internal directories.