-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathindex.html
More file actions
304 lines (281 loc) · 21.8 KB
/
Copy pathindex.html
File metadata and controls
304 lines (281 loc) · 21.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Dotkernel Documentation</title>
<meta name="description" content="Official Dotkernel documentation covering APIs, Admin, Queue, developer tools, packages, and modern PHP application development">
<link rel="canonical" href="https://docs.dotkernel.org/">
<link rel="shortcut icon" href="https://docs.dotkernel.org/img/dk_docs_favicon_white.svg" />
<meta property="og:title" content="Dotkernel Documentation"/>
<meta property="og:description" content="Official Dotkernel documentation covering APIs, Admin, Queue, developer tools, packages, and modern PHP application development"/>
<meta property="og:image" content="https://docs.dotkernel.org/img/open-graph/twitter-card-docs.png"/>
<meta property="og:type" content="website"/>
<meta property="og:site_name" content="Dotkernel Documentation"/>
<meta property="og:url" content="https://docs.dotkernel.org/"/>
<meta property="og:locale" content="en_US"/>
<meta name="twitter:card" content="summary_large_image"/>
<meta name="twitter:site" content="@dotkernel"/>
<meta name="twitter:title" content="Dotkernel Documentation"/>
<meta name="twitter:description" content="Official Dotkernel documentation covering APIs, Admin, Queue, developer tools, packages, and modern PHP application development"/>
<meta name="twitter:image" content="https://docs.dotkernel.org/img/open-graph/twitter-card-docs.png"/>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Archivo:wght@500;600;700&family=Source+Sans+3:ital,wght@0,400;0,600;1,400&family=JetBrains+Mono:wght@400;500;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="https://docs.dotkernel.org/css/bootstrap.css" />
<link rel="stylesheet" href="https://docs.dotkernel.org/css/bootstrap-icons.min.css" />
<link rel="stylesheet" href="https://docs.dotkernel.org/css/docs.css" />
<script src="https://docs.dotkernel.org/js/bootstrap.js" defer></script>
<script src="https://docs.dotkernel.org/js/docs.js" defer></script>
</head>
<body>
<nav class="navbar navbar-expand-lg dk-docs-nav py-2" data-bs-theme="dark">
<div class="container-fluid dk-docs-nav__inner">
<a class="navbar-brand dk-docs-nav__brand" href="https://docs.dotkernel.org/">
<img alt="Dotkernel Logo" class="d-inline-block align-text-top" height="28"
src="https://docs.dotkernel.org/img/dk_logo_2024_white.svg" width="152"/>
</a>
<ul class="dk-docs-nav__projects list-unstyled d-none d-lg-flex align-items-center mb-0">
<li><a href="https://docs.dotkernel.org/api-documentation/">API</a></li>
<li><a href="https://docs.dotkernel.org/admin-documentation/">Admin</a></li>
<li><a href="https://docs.dotkernel.org/queue-documentation/">Queue</a></li>
<li><a href="https://docs.dotkernel.org/development/">Development</a></li>
<li><a href="https://docs.dotkernel.org/dotboost/">Dotboost</a></li>
<li><a href="https://docs.dotkernel.org/light-documentation/">Light</a></li>
<li><a href="https://docs.dotkernel.org/frontend-documentation/">Frontend</a></li>
<li><a href="https://docs.dotkernel.org/packages/">Packages</a></li>
</ul>
<div class="flex-grow-1"></div>
<span class="dk-docs-nav__search d-none d-md-flex align-items-center">
<i class="bi bi-search"></i>
<span>Search docs</span>
<span class="dk-docs-nav__search-key">/</span>
</span>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarText" aria-controls="navbarText" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse flex-grow-0" id="navbarText">
<ul class="navbar-nav ms-auto mb-2 mb-lg-0 dk-docs-nav__projects dk-docs-nav__projects--collapsed d-lg-none">
<li><a href="https://docs.dotkernel.org/api-documentation/">API</a></li>
<li><a href="https://docs.dotkernel.org/admin-documentation/">Admin</a></li>
<li><a href="https://docs.dotkernel.org/queue-documentation/">Queue</a></li>
<li><a href="https://docs.dotkernel.org/development/">Development</a></li>
<li><a href="https://docs.dotkernel.org/dotboost/">Dotboost</a></li>
<li><a href="https://docs.dotkernel.org/light-documentation/">Light</a></li>
<li><a href="https://docs.dotkernel.org/frontend-documentation/">Frontend</a></li>
<li><a href="https://docs.dotkernel.org/packages/">Packages</a></li>
</ul>
<ul class="navbar-nav ms-auto mb-2 mb-lg-0">
<li class="nav-item">
<a class="nav-link fw-bold text-white" href="https://github.com/dotkernel" target="_blank">
<i class="bi bi-github"></i>
GitHub
</a>
</li>
</ul>
</div>
</div>
</nav>
<div class="dk-home-shell">
<div class="dk-home-sidebar">
<div class="dk-home-sidebar__label">Documentation</div>
<nav class="dk-home-sidebar__nav">
<a href="https://docs.dotkernel.org/" class="dk-home-sidebar__item--active">Overview</a>
<div class="dk-home-sidebar__group">Headless Platform</div>
<a href="https://docs.dotkernel.org/api-documentation/">API</a>
<a href="https://docs.dotkernel.org/admin-documentation/">Admin</a>
<a href="https://docs.dotkernel.org/queue-documentation/">Queue</a>
<div class="dk-home-sidebar__group">Developer tooling</div>
<a href="https://docs.dotkernel.org/development/">Development Environment</a>
<a href="https://docs.dotkernel.org/dotboost/">Dotboost</a>
<div class="dk-home-sidebar__group">Other skeletons</div>
<a href="https://docs.dotkernel.org/light-documentation/">Light</a>
<a href="https://docs.dotkernel.org/frontend-documentation/">Frontend</a>
<div class="dk-home-sidebar__group">Packages</div>
<a href="https://docs.dotkernel.org/packages/">All packages</a>
<a href="https://www.dotkernel.com/dotkernel-packages-oss-lifecycle/">Packages Lifecycle</a>
</nav>
</div>
<div class="dk-home-main">
<div class="dk-home-eyebrow">PSR-15 · middleware-first architecture</div>
<h1>A headless platform for building modern web applications</h1>
<p class="dk-home-lede">Dotkernel is a set of open-source PHP applications - REST API, admin, and queue - that ship assembled on Mezzio and Laminas, over one shared Doctrine domain layer called Core. OAuth2, RBAC, HAL, and a generated OpenAPI spec are wired together on install, not left for you to choose.</p>
<div class="dk-home-stats">
<div class="dk-home-stats__item">
<div class="dk-home-stats__label">Runtime</div>
<div class="dk-home-stats__value">Mezzio + Laminas</div>
</div>
<div class="dk-home-stats__item">
<div class="dk-home-stats__label">Standards</div>
<div class="dk-home-stats__value">PSR-7 · PSR-11 · PSR-15</div>
</div>
<div class="dk-home-stats__item">
<div class="dk-home-stats__label">License</div>
<div class="dk-home-stats__value">MIT</div>
</div>
</div>
<h2>Headless Platform</h2>
<p>API, Admin, and Queue declare the same <code>Core</code> namespaces - the same entities, repositories, and services. Three deployables that scale independently and never disagree about the domain.</p>
<div class="dk-home-cards">
<a href="https://docs.dotkernel.org/api-documentation/" class="dk-home-card dk-home-card--featured">
<div class="dk-home-card__meta">Deployable · Shares Core</div>
<div class="dk-home-card__title">API</div>
<div class="dk-home-card__tagline">The HTTP surface of your platform, ready for any client.</div>
<div class="dk-home-card__desc">REST APIs on a readable PSR-15 middleware pipeline - no kernel, no facades, no runtime magic. OAuth2, RBAC, and OpenAPI included.</div>
</a>
<a href="https://docs.dotkernel.org/admin-documentation/" class="dk-home-card">
<div class="dk-home-card__meta">Deployable · Shares Core</div>
<div class="dk-home-card__title">Admin</div>
<div class="dk-home-card__tagline">A back office for complete control over the same data your API serves.</div>
<div class="dk-home-card__desc">A ready-to-go admin skeleton - table-based CRUD screens for your records, plus the pieces for reports and dashboards.</div>
</a>
<a href="https://docs.dotkernel.org/queue-documentation/" class="dk-home-card">
<div class="dk-home-card__meta">Deployable · Shares Core</div>
<div class="dk-home-card__title">Queue</div>
<div class="dk-home-card__tagline">Work your users should not wait for, moved off the request.</div>
<div class="dk-home-card__desc">Background job processing for the platform - dispatch work from API or Admin and run it in a separate worker. Built on Symfony Messenger.</div>
</a>
</div>
<h2>Developer tooling</h2>
<p>A production-like environment on your machine, and the context your AI tools need to write Dotkernel code - both ready before anything reaches your users.</p>
<div class="dk-home-cards">
<a href="https://docs.dotkernel.org/development/" class="dk-home-card">
<div class="dk-home-card__meta">Tooling · Local environment</div>
<div class="dk-home-card__title">Development Environment</div>
<div class="dk-home-card__tagline">A controlled local workspace for building and testing before release.</div>
<div class="dk-home-card__desc">AlmaLinux on WSL2 for a RHEL-compatible local stack. One install script configures PHP, Apache, MariaDB, Git, Composer, Node.js, and phpMyAdmin.</div>
</a>
<a href="https://docs.dotkernel.org/dotboost/" class="dk-home-card">
<div class="dk-home-card__meta">Tooling · AI context</div>
<div class="dk-home-card__title">Dotboost</div>
<div class="dk-home-card__tagline">Faster AI-assisted development, grounded in Dotkernel's own standards.</div>
<div class="dk-home-card__desc">Dotkernel context for AI coding tools - current standards, architectural patterns, and framework idioms, so generated code matches the ecosystem instead of guessing at it.</div>
</a>
</div>
<h2>Other skeletons</h2>
<p>Not every project needs the full platform. These two skeletons stand on their own, outside the Headless Platform above.</p>
<div class="dk-home-cards">
<a href="https://docs.dotkernel.org/light-documentation/" class="dk-home-card">
<div class="dk-home-card__meta">Skeleton · Minimal</div>
<div class="dk-home-card__title">Light</div>
<div class="dk-home-card__tagline">A small site or service without a platform around it.</div>
<div class="dk-home-card__desc">The smallest complete Mezzio application - PSR-15 pipeline, routing, and templating, nothing to strip out. A real starting point for a simple site.</div>
</a>
<a href="https://docs.dotkernel.org/frontend-documentation/" class="dk-home-card">
<div class="dk-home-card__meta">Skeleton · Standalone</div>
<div class="dk-home-card__title">Frontend</div>
<div class="dk-home-card__tagline">A server-rendered web application you can build on.</div>
<div class="dk-home-card__desc">A web starter skeleton for full-stack applications on Mezzio and Laminas - server-rendered Twig views, forms, sessions, and RBAC-guarded routes.</div>
</a>
</div>
<h2>Packages</h2>
<p>Small, independent dot-* packages - pull in what you need. Lifecycle status for each lives on the <a href="https://www.dotkernel.com/dotkernel-packages-oss-lifecycle/">Packages Lifecycle</a> page.</p>
<div class="dk-home-pkg-groups">
<div class="dk-home-pkg-group">
<div class="dk-home-pkg-group__title">Authentication</div>
<div class="dk-home-pkg-list">
<div class="dk-home-pkg"><a class="dk-home-pkg__name" href="https://docs.dotkernel.org/dot-authentication">dot-authentication</a><span class="dk-home-pkg__desc">core authentication interfaces</span></div>
<div class="dk-home-pkg"><a class="dk-home-pkg__name" href="https://docs.dotkernel.org/dot-auth-social">dot-auth-social</a><span class="dk-home-pkg__desc">Facebook auth via oauth2-client</span></div>
</div>
</div>
<div class="dk-home-pkg-group">
<div class="dk-home-pkg-group__title">Authorization</div>
<div class="dk-home-pkg-list">
<div class="dk-home-pkg"><a class="dk-home-pkg__name" href="https://docs.dotkernel.org/dot-authorization">dot-authorization</a><span class="dk-home-pkg__desc">core authorization interfaces</span></div>
<div class="dk-home-pkg"><a class="dk-home-pkg__name" href="https://docs.dotkernel.org/dot-rbac">dot-rbac</a><span class="dk-home-pkg__desc">RBAC implementation</span></div>
<div class="dk-home-pkg"><a class="dk-home-pkg__name" href="https://docs.dotkernel.org/dot-rbac-guard">dot-rbac-guard</a><span class="dk-home-pkg__desc">RBAC for authorizing app sections</span></div>
</div>
</div>
<div class="dk-home-pkg-group">
<div class="dk-home-pkg-group__title">Logging & error handling</div>
<div class="dk-home-pkg-list">
<div class="dk-home-pkg"><a class="dk-home-pkg__name" href="https://docs.dotkernel.org/dot-log">dot-log</a><span class="dk-home-pkg__desc">structured application logging</span></div>
<div class="dk-home-pkg"><a class="dk-home-pkg__name" href="https://docs.dotkernel.org/dot-errorhandler">dot-errorhandler</a><span class="dk-home-pkg__desc">centralized error handling</span></div>
</div>
</div>
<div class="dk-home-pkg-group">
<div class="dk-home-pkg-group__title">Session</div>
<div class="dk-home-pkg-list">
<div class="dk-home-pkg"><a class="dk-home-pkg__name" href="https://docs.dotkernel.org/dot-session">dot-session</a><span class="dk-home-pkg__desc">extends laminas-session</span></div>
<div class="dk-home-pkg"><a class="dk-home-pkg__name" href="https://docs.dotkernel.org/dot-flashmessenger">dot-flashmessenger</a><span class="dk-home-pkg__desc">short-lived session messages</span></div>
<div class="dk-home-pkg"><a class="dk-home-pkg__name" href="https://docs.dotkernel.org/dot-cache">dot-cache</a><span class="dk-home-pkg__desc">extends symfony/cache</span></div>
</div>
</div>
<div class="dk-home-pkg-group">
<div class="dk-home-pkg-group__title">Database</div>
<div class="dk-home-pkg-list">
<div class="dk-home-pkg"><a class="dk-home-pkg__name" href="https://docs.dotkernel.org/dot-data-fixtures">dot-data-fixtures</a><span class="dk-home-pkg__desc">extends doctrine/data-fixtures</span></div>
</div>
</div>
<div class="dk-home-pkg-group">
<div class="dk-home-pkg-group__title">Tools</div>
<div class="dk-home-pkg-list">
<div class="dk-home-pkg"><a class="dk-home-pkg__name" href="https://docs.dotkernel.org/dot-cli">dot-cli</a><span class="dk-home-pkg__desc">extends laminas-cli</span></div>
<div class="dk-home-pkg"><a class="dk-home-pkg__name" href="https://docs.dotkernel.org/dot-event">dot-event</a><span class="dk-home-pkg__desc">extends laminas-eventmanager</span></div>
<div class="dk-home-pkg"><a class="dk-home-pkg__name" href="https://docs.dotkernel.org/dot-helpers">dot-helpers</a><span class="dk-home-pkg__desc">shared utility helpers</span></div>
</div>
</div>
</div>
<p class="dk-home-pkg-note">Also used, without a dedicated package page: <a class="dk-home-pkg__name" href="https://www.doctrine-project.org/">doctrine/orm</a> (object-relational mapper for PHP), <a class="dk-home-pkg__name" href="https://www.doctrine-project.org/projects/dbal.html">doctrine/dbal</a> (DB abstraction, schema introspection).</p>
<h2>Contributing and Support</h2>
<div class="dk-home-info-cards">
<div class="dk-home-info-card">
<div class="dk-home-info-card__title">Contributing</div>
<p>If you wish to contribute to the project, read the <a href="https://github.com/dotkernel" target="_blank">contributing guidelines</a>.</p>
</div>
<div class="dk-home-info-card">
<div class="dk-home-info-card__title">Support</div>
<p>If you need support with the project, join us on <a href="https://dotkernel.slack.com" target="_blank">Slack</a>.</p>
</div>
<div class="dk-home-info-card">
<div class="dk-home-info-card__title">Discussions</div>
<p>For open discussions, please use <a href="https://github.com/orgs/dotkernel/discussions" target="_blank">GitHub Discussions</a>.</p>
</div>
<div class="dk-home-info-card">
<div class="dk-home-info-card__title">Security</div>
<p>For reporting security issues, please review our <a href="https://github.com/dotkernel" target="_blank">security policy</a>.</p>
</div>
</div>
</div>
</div>
<footer class="dk-home-footer">
<div class="dk-home-footer__grid">
<div class="dk-home-footer__col">
<div class="dk-home-footer__label">Products</div>
<a href="https://docs.dotkernel.org/api-documentation/">API</a>
<a href="https://docs.dotkernel.org/admin-documentation/">Admin</a>
<a href="https://docs.dotkernel.org/queue-documentation/">Queue</a>
<a href="https://docs.dotkernel.org/light-documentation/">Light</a>
</div>
<div class="dk-home-footer__col">
<div class="dk-home-footer__label">Resources</div>
<a href="https://docs.dotkernel.org/dotboost/">Dotboost</a>
<a href="https://docs.dotkernel.org/headless-documentation/">Architecture</a>
<a href="https://www.dotkernel.com/dotkernel-packages-oss-lifecycle/">Packages Lifecycle</a>
<a href="https://docs.dotkernel.org/development/">WSL2 Dev Stack</a>
</div>
<div class="dk-home-footer__col">
<div class="dk-home-footer__label">More</div>
<a href="https://www.dotkernel.com/">Categories</a>
<a href="https://www.dotkernel.com/blog/">Blog</a>
<a href="https://github.com/orgs/dotkernel/discussions">Discussion</a>
<a href="https://www.dotkernel.com/about/">About</a>
<a href="https://www.dotkernel.com/contact/">Contact us</a>
</div>
<div class="dk-home-footer__col">
<div class="dk-home-footer__label">Follow</div>
<a href="https://github.com/dotkernel" target="_blank">GitHub</a>
<a href="https://www.dotkernel.com/feed/" target="_blank">Dotkernel RSS Feed</a>
<div class="dk-home-footer__note">Open-source tooling supported by JetBrains.</div>
</div>
</div>
<div class="dk-home-footer__bottom">
<img src="https://docs.dotkernel.org/img/dk_logo_2024_white.svg" alt="Dotkernel" width="112" height="21" style="opacity:.75" />
<div class="dk-home-footer__tagline">Built with Mezzio, Laminas & Doctrine - for PHP developers, by PHP developers. The Laminas logo is copyright of the Laminas Foundation.</div>
<div class="flex-grow-1"></div>
<div class="dk-home-footer__copyright">© Copyright Dotkernel <span id="current-year"></span>. All rights reserved.</div>
</div>
</footer>
</body>
</html>