A loose federation of distributed, typed datasets
1<!DOCTYPE html>
2<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
3
4<meta charset="utf-8">
5<meta name="generator" content="quarto-1.7.34">
6
7<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
8
9<meta name="description" content="Production deployment for local storage and ATProto integration">
10
11<title>Deployment Guide – atdata</title>
12<style>
13code{white-space: pre-wrap;}
14span.smallcaps{font-variant: small-caps;}
15div.columns{display: flex; gap: min(4vw, 1.5em);}
16div.column{flex: auto; overflow-x: auto;}
17div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
18ul.task-list{list-style: none;}
19ul.task-list li input[type="checkbox"] {
20 width: 0.8em;
21 margin: 0 0.8em 0.2em -1em; /* quarto-specific, see https://github.com/quarto-dev/quarto-cli/issues/4556 */
22 vertical-align: middle;
23}
24/* CSS for syntax highlighting */
25html { -webkit-text-size-adjust: 100%; }
26pre > code.sourceCode { white-space: pre; position: relative; }
27pre > code.sourceCode > span { display: inline-block; line-height: 1.25; }
28pre > code.sourceCode > span:empty { height: 1.2em; }
29.sourceCode { overflow: visible; }
30code.sourceCode > span { color: inherit; text-decoration: inherit; }
31div.sourceCode { margin: 1em 0; }
32pre.sourceCode { margin: 0; }
33@media screen {
34div.sourceCode { overflow: auto; }
35}
36@media print {
37pre > code.sourceCode { white-space: pre-wrap; }
38pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }
39}
40pre.numberSource code
41 { counter-reset: source-line 0; }
42pre.numberSource code > span
43 { position: relative; left: -4em; counter-increment: source-line; }
44pre.numberSource code > span > a:first-child::before
45 { content: counter(source-line);
46 position: relative; left: -1em; text-align: right; vertical-align: baseline;
47 border: none; display: inline-block;
48 -webkit-touch-callout: none; -webkit-user-select: none;
49 -khtml-user-select: none; -moz-user-select: none;
50 -ms-user-select: none; user-select: none;
51 padding: 0 4px; width: 4em;
52 }
53pre.numberSource { margin-left: 3em; padding-left: 4px; }
54div.sourceCode
55 { }
56@media screen {
57pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
58}
59</style>
60
61
62<script src="../site_libs/quarto-nav/quarto-nav.js"></script>
63<script src="../site_libs/quarto-nav/headroom.min.js"></script>
64<script src="../site_libs/clipboard/clipboard.min.js"></script>
65<script src="../site_libs/quarto-search/autocomplete.umd.js"></script>
66<script src="../site_libs/quarto-search/fuse.min.js"></script>
67<script src="../site_libs/quarto-search/quarto-search.js"></script>
68<meta name="quarto:offset" content="../">
69<script src="../site_libs/quarto-html/quarto.js" type="module"></script>
70<script src="../site_libs/quarto-html/tabsets/tabsets.js" type="module"></script>
71<script src="../site_libs/quarto-html/popper.min.js"></script>
72<script src="../site_libs/quarto-html/tippy.umd.min.js"></script>
73<script src="../site_libs/quarto-html/anchor.min.js"></script>
74<link href="../site_libs/quarto-html/tippy.css" rel="stylesheet">
75<link href="../site_libs/quarto-html/quarto-syntax-highlighting-9582434199d49cc9e91654cdeeb4866b.css" rel="stylesheet" class="quarto-color-scheme" id="quarto-text-highlighting-styles">
76<link href="../site_libs/quarto-html/quarto-syntax-highlighting-dark-8dcd8563ea6803ab7cbb3d71ca5772e1.css" rel="stylesheet" class="quarto-color-scheme quarto-color-alternate" id="quarto-text-highlighting-styles">
77<link href="../site_libs/quarto-html/quarto-syntax-highlighting-9582434199d49cc9e91654cdeeb4866b.css" rel="stylesheet" class="quarto-color-scheme-extra" id="quarto-text-highlighting-styles">
78<script src="../site_libs/bootstrap/bootstrap.min.js"></script>
79<link href="../site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
80<link href="../site_libs/bootstrap/bootstrap-62bce24ca844314e7bb1a34dbdfe05cc.min.css" rel="stylesheet" append-hash="true" class="quarto-color-scheme" id="quarto-bootstrap" data-mode="light">
81<link href="../site_libs/bootstrap/bootstrap-dark-7964ffd8887b0991fe8d71c6c8bc75d6.min.css" rel="stylesheet" append-hash="true" class="quarto-color-scheme quarto-color-alternate" id="quarto-bootstrap" data-mode="dark">
82<link href="../site_libs/bootstrap/bootstrap-62bce24ca844314e7bb1a34dbdfe05cc.min.css" rel="stylesheet" append-hash="true" class="quarto-color-scheme-extra" id="quarto-bootstrap" data-mode="light">
83<script id="quarto-search-options" type="application/json">{
84 "location": "navbar",
85 "copy-button": false,
86 "collapse-after": 3,
87 "panel-placement": "end",
88 "type": "overlay",
89 "limit": 50,
90 "keyboard-shortcut": [
91 "f",
92 "/",
93 "s"
94 ],
95 "show-item-context": false,
96 "language": {
97 "search-no-results-text": "No results",
98 "search-matching-documents-text": "matching documents",
99 "search-copy-link-title": "Copy link to search",
100 "search-hide-matches-text": "Hide additional matches",
101 "search-more-match-text": "more match in this document",
102 "search-more-matches-text": "more matches in this document",
103 "search-clear-button-title": "Clear",
104 "search-text-placeholder": "",
105 "search-detached-cancel-button-title": "Cancel",
106 "search-submit-button-title": "Submit",
107 "search-label": "Search"
108 }
109}</script>
110
111
112<link rel="stylesheet" href="../assets/styles.css">
113</head>
114
115<body class="nav-sidebar docked nav-fixed quarto-light"><script id="quarto-html-before-body" type="application/javascript">
116 const toggleBodyColorMode = (bsSheetEl) => {
117 const mode = bsSheetEl.getAttribute("data-mode");
118 const bodyEl = window.document.querySelector("body");
119 if (mode === "dark") {
120 bodyEl.classList.add("quarto-dark");
121 bodyEl.classList.remove("quarto-light");
122 } else {
123 bodyEl.classList.add("quarto-light");
124 bodyEl.classList.remove("quarto-dark");
125 }
126 }
127 const toggleBodyColorPrimary = () => {
128 const bsSheetEl = window.document.querySelector("link#quarto-bootstrap:not([rel=disabled-stylesheet])");
129 if (bsSheetEl) {
130 toggleBodyColorMode(bsSheetEl);
131 }
132 }
133 const setColorSchemeToggle = (alternate) => {
134 const toggles = window.document.querySelectorAll('.quarto-color-scheme-toggle');
135 for (let i=0; i < toggles.length; i++) {
136 const toggle = toggles[i];
137 if (toggle) {
138 if (alternate) {
139 toggle.classList.add("alternate");
140 } else {
141 toggle.classList.remove("alternate");
142 }
143 }
144 }
145 };
146 const toggleColorMode = (alternate) => {
147 // Switch the stylesheets
148 const primaryStylesheets = window.document.querySelectorAll('link.quarto-color-scheme:not(.quarto-color-alternate)');
149 const alternateStylesheets = window.document.querySelectorAll('link.quarto-color-scheme.quarto-color-alternate');
150 manageTransitions('#quarto-margin-sidebar .nav-link', false);
151 if (alternate) {
152 // note: dark is layered on light, we don't disable primary!
153 enableStylesheet(alternateStylesheets);
154 for (const sheetNode of alternateStylesheets) {
155 if (sheetNode.id === "quarto-bootstrap") {
156 toggleBodyColorMode(sheetNode);
157 }
158 }
159 } else {
160 disableStylesheet(alternateStylesheets);
161 enableStylesheet(primaryStylesheets)
162 toggleBodyColorPrimary();
163 }
164 manageTransitions('#quarto-margin-sidebar .nav-link', true);
165 // Switch the toggles
166 setColorSchemeToggle(alternate)
167 // Hack to workaround the fact that safari doesn't
168 // properly recolor the scrollbar when toggling (#1455)
169 if (navigator.userAgent.indexOf('Safari') > 0 && navigator.userAgent.indexOf('Chrome') == -1) {
170 manageTransitions("body", false);
171 window.scrollTo(0, 1);
172 setTimeout(() => {
173 window.scrollTo(0, 0);
174 manageTransitions("body", true);
175 }, 40);
176 }
177 }
178 const disableStylesheet = (stylesheets) => {
179 for (let i=0; i < stylesheets.length; i++) {
180 const stylesheet = stylesheets[i];
181 stylesheet.rel = 'disabled-stylesheet';
182 }
183 }
184 const enableStylesheet = (stylesheets) => {
185 for (let i=0; i < stylesheets.length; i++) {
186 const stylesheet = stylesheets[i];
187 if(stylesheet.rel !== 'stylesheet') { // for Chrome, which will still FOUC without this check
188 stylesheet.rel = 'stylesheet';
189 }
190 }
191 }
192 const manageTransitions = (selector, allowTransitions) => {
193 const els = window.document.querySelectorAll(selector);
194 for (let i=0; i < els.length; i++) {
195 const el = els[i];
196 if (allowTransitions) {
197 el.classList.remove('notransition');
198 } else {
199 el.classList.add('notransition');
200 }
201 }
202 }
203 const isFileUrl = () => {
204 return window.location.protocol === 'file:';
205 }
206 const hasAlternateSentinel = () => {
207 let styleSentinel = getColorSchemeSentinel();
208 if (styleSentinel !== null) {
209 return styleSentinel === "alternate";
210 } else {
211 return false;
212 }
213 }
214 const setStyleSentinel = (alternate) => {
215 const value = alternate ? "alternate" : "default";
216 if (!isFileUrl()) {
217 window.localStorage.setItem("quarto-color-scheme", value);
218 } else {
219 localAlternateSentinel = value;
220 }
221 }
222 const getColorSchemeSentinel = () => {
223 if (!isFileUrl()) {
224 const storageValue = window.localStorage.getItem("quarto-color-scheme");
225 return storageValue != null ? storageValue : localAlternateSentinel;
226 } else {
227 return localAlternateSentinel;
228 }
229 }
230 const toggleGiscusIfUsed = (isAlternate, darkModeDefault) => {
231 const baseTheme = document.querySelector('#giscus-base-theme')?.value ?? 'light';
232 const alternateTheme = document.querySelector('#giscus-alt-theme')?.value ?? 'dark';
233 let newTheme = '';
234 if(authorPrefersDark) {
235 newTheme = isAlternate ? baseTheme : alternateTheme;
236 } else {
237 newTheme = isAlternate ? alternateTheme : baseTheme;
238 }
239 const changeGiscusTheme = () => {
240 // From: https://github.com/giscus/giscus/issues/336
241 const sendMessage = (message) => {
242 const iframe = document.querySelector('iframe.giscus-frame');
243 if (!iframe) return;
244 iframe.contentWindow.postMessage({ giscus: message }, 'https://giscus.app');
245 }
246 sendMessage({
247 setConfig: {
248 theme: newTheme
249 }
250 });
251 }
252 const isGiscussLoaded = window.document.querySelector('iframe.giscus-frame') !== null;
253 if (isGiscussLoaded) {
254 changeGiscusTheme();
255 }
256 };
257 const authorPrefersDark = false;
258 const darkModeDefault = authorPrefersDark;
259 document.querySelector('link#quarto-text-highlighting-styles.quarto-color-scheme-extra').rel = 'disabled-stylesheet';
260 document.querySelector('link#quarto-bootstrap.quarto-color-scheme-extra').rel = 'disabled-stylesheet';
261 let localAlternateSentinel = darkModeDefault ? 'alternate' : 'default';
262 // Dark / light mode switch
263 window.quartoToggleColorScheme = () => {
264 // Read the current dark / light value
265 let toAlternate = !hasAlternateSentinel();
266 toggleColorMode(toAlternate);
267 setStyleSentinel(toAlternate);
268 toggleGiscusIfUsed(toAlternate, darkModeDefault);
269 window.dispatchEvent(new Event('resize'));
270 };
271 // Switch to dark mode if need be
272 if (hasAlternateSentinel()) {
273 toggleColorMode(true);
274 } else {
275 toggleColorMode(false);
276 }
277 </script>
278
279<div id="quarto-search-results"></div>
280 <header id="quarto-header" class="headroom fixed-top">
281 <nav class="navbar navbar-expand-lg " data-bs-theme="dark">
282 <div class="navbar-container container-fluid">
283 <div class="navbar-brand-container mx-auto">
284 <a class="navbar-brand" href="../index.html">
285 <span class="navbar-title">atdata</span>
286 </a>
287 </div>
288 <div id="quarto-search" class="" title="Search"></div>
289 <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarCollapse" aria-controls="navbarCollapse" role="menu" aria-expanded="false" aria-label="Toggle navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
290 <span class="navbar-toggler-icon"></span>
291</button>
292 <div class="collapse navbar-collapse" id="navbarCollapse">
293 <ul class="navbar-nav navbar-nav-scroll me-auto">
294 <li class="nav-item">
295 <a class="nav-link active" href="../index.html" aria-current="page">
296<span class="menu-text">Guide</span></a>
297 </li>
298 <li class="nav-item dropdown ">
299 <a class="nav-link dropdown-toggle" href="#" id="nav-menu-tutorials" role="link" data-bs-toggle="dropdown" aria-expanded="false">
300 <span class="menu-text">Tutorials</span>
301 </a>
302 <ul class="dropdown-menu" aria-labelledby="nav-menu-tutorials">
303 <li>
304 <a class="dropdown-item" href="../tutorials/quickstart.html">
305 <span class="dropdown-text">Quick Start</span></a>
306 </li>
307 <li>
308 <a class="dropdown-item" href="../tutorials/local-workflow.html">
309 <span class="dropdown-text">Local Workflow</span></a>
310 </li>
311 <li>
312 <a class="dropdown-item" href="../tutorials/atmosphere.html">
313 <span class="dropdown-text">Atmosphere Publishing</span></a>
314 </li>
315 <li>
316 <a class="dropdown-item" href="../tutorials/promotion.html">
317 <span class="dropdown-text">Promotion Workflow</span></a>
318 </li>
319 </ul>
320 </li>
321 <li class="nav-item dropdown ">
322 <a class="nav-link dropdown-toggle" href="#" id="nav-menu-reference" role="link" data-bs-toggle="dropdown" aria-expanded="false">
323 <span class="menu-text">Reference</span>
324 </a>
325 <ul class="dropdown-menu" aria-labelledby="nav-menu-reference">
326 <li>
327 <a class="dropdown-item" href="../reference/architecture.html">
328 <span class="dropdown-text">Architecture Overview</span></a>
329 </li>
330 <li>
331 <a class="dropdown-item" href="../reference/packable-samples.html">
332 <span class="dropdown-text">Packable Samples</span></a>
333 </li>
334 <li>
335 <a class="dropdown-item" href="../reference/datasets.html">
336 <span class="dropdown-text">Datasets</span></a>
337 </li>
338 <li>
339 <a class="dropdown-item" href="../reference/lenses.html">
340 <span class="dropdown-text">Lenses</span></a>
341 </li>
342 <li>
343 <a class="dropdown-item" href="../reference/local-storage.html">
344 <span class="dropdown-text">Local Storage</span></a>
345 </li>
346 <li>
347 <a class="dropdown-item" href="../reference/atmosphere.html">
348 <span class="dropdown-text">Atmosphere</span></a>
349 </li>
350 <li>
351 <a class="dropdown-item" href="../reference/promotion.html">
352 <span class="dropdown-text">Promotion</span></a>
353 </li>
354 <li>
355 <a class="dropdown-item" href="../reference/load-dataset.html">
356 <span class="dropdown-text">load_dataset API</span></a>
357 </li>
358 <li>
359 <a class="dropdown-item" href="../reference/protocols.html">
360 <span class="dropdown-text">Protocols</span></a>
361 </li>
362 <li>
363 <a class="dropdown-item" href="../reference/uri-spec.html">
364 <span class="dropdown-text">URI Specification</span></a>
365 </li>
366 <li>
367 <a class="dropdown-item" href="../reference/troubleshooting.html">
368 <span class="dropdown-text">Troubleshooting & FAQ</span></a>
369 </li>
370 <li>
371 <a class="dropdown-item" href="../reference/deployment.html">
372 <span class="dropdown-text">Deployment Guide</span></a>
373 </li>
374 </ul>
375 </li>
376 <li class="nav-item">
377 <a class="nav-link" href="../api/index.html">
378<span class="menu-text">API</span></a>
379 </li>
380</ul>
381 <ul class="navbar-nav navbar-nav-scroll ms-auto">
382 <li class="nav-item compact">
383 <a class="nav-link" href="https://github.com/your-org/atdata"> <i class="bi bi-github" role="img">
384</i>
385<span class="menu-text"></span></a>
386 </li>
387</ul>
388 </div> <!-- /navcollapse -->
389 <div class="quarto-navbar-tools">
390 <a href="" class="quarto-color-scheme-toggle quarto-navigation-tool px-1" onclick="window.quartoToggleColorScheme(); return false;" title="Toggle dark mode"><i class="bi"></i></a>
391</div>
392 </div> <!-- /container-fluid -->
393 </nav>
394 <nav class="quarto-secondary-nav">
395 <div class="container-fluid d-flex">
396 <button type="button" class="quarto-btn-toggle btn" data-bs-toggle="collapse" role="button" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
397 <i class="bi bi-layout-text-sidebar-reverse"></i>
398 </button>
399 <nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="../reference/architecture.html">Reference</a></li><li class="breadcrumb-item"><a href="../reference/deployment.html">Deployment Guide</a></li></ol></nav>
400 <a class="flex-grow-1" role="navigation" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
401 </a>
402 </div>
403 </nav>
404</header>
405<!-- content -->
406<div id="quarto-content" class="quarto-container page-columns page-rows-contents page-layout-article page-navbar">
407<!-- sidebar -->
408 <nav id="quarto-sidebar" class="sidebar collapse collapse-horizontal quarto-sidebar-collapse-item sidebar-navigation docked overflow-auto">
409 <div class="sidebar-menu-container">
410 <ul class="list-unstyled mt-1">
411 <li class="sidebar-item">
412 <div class="sidebar-item-container">
413 <a href="../index.html" class="sidebar-item-text sidebar-link">
414 <span class="menu-text">atdata</span></a>
415 </div>
416</li>
417 <li class="sidebar-item sidebar-item-section">
418 <div class="sidebar-item-container">
419 <a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" role="navigation" aria-expanded="true">
420 <span class="menu-text">Getting Started</span></a>
421 <a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" role="navigation" aria-expanded="true" aria-label="Toggle section">
422 <i class="bi bi-chevron-right ms-2"></i>
423 </a>
424 </div>
425 <ul id="quarto-sidebar-section-1" class="collapse list-unstyled sidebar-section depth1 show">
426 <li class="sidebar-item">
427 <div class="sidebar-item-container">
428 <a href="../tutorials/quickstart.html" class="sidebar-item-text sidebar-link">
429 <span class="menu-text">Quick Start</span></a>
430 </div>
431</li>
432 <li class="sidebar-item">
433 <div class="sidebar-item-container">
434 <a href="../tutorials/local-workflow.html" class="sidebar-item-text sidebar-link">
435 <span class="menu-text">Local Workflow</span></a>
436 </div>
437</li>
438 <li class="sidebar-item">
439 <div class="sidebar-item-container">
440 <a href="../tutorials/atmosphere.html" class="sidebar-item-text sidebar-link">
441 <span class="menu-text">Atmosphere Publishing</span></a>
442 </div>
443</li>
444 <li class="sidebar-item">
445 <div class="sidebar-item-container">
446 <a href="../tutorials/promotion.html" class="sidebar-item-text sidebar-link">
447 <span class="menu-text">Promotion Workflow</span></a>
448 </div>
449</li>
450 </ul>
451 </li>
452 <li class="sidebar-item sidebar-item-section">
453 <div class="sidebar-item-container">
454 <a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" role="navigation" aria-expanded="true">
455 <span class="menu-text">Reference</span></a>
456 <a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" role="navigation" aria-expanded="true" aria-label="Toggle section">
457 <i class="bi bi-chevron-right ms-2"></i>
458 </a>
459 </div>
460 <ul id="quarto-sidebar-section-2" class="collapse list-unstyled sidebar-section depth1 show">
461 <li class="sidebar-item">
462 <div class="sidebar-item-container">
463 <a href="../reference/architecture.html" class="sidebar-item-text sidebar-link">
464 <span class="menu-text">Architecture Overview</span></a>
465 </div>
466</li>
467 <li class="sidebar-item">
468 <div class="sidebar-item-container">
469 <a href="../reference/packable-samples.html" class="sidebar-item-text sidebar-link">
470 <span class="menu-text">Packable Samples</span></a>
471 </div>
472</li>
473 <li class="sidebar-item">
474 <div class="sidebar-item-container">
475 <a href="../reference/datasets.html" class="sidebar-item-text sidebar-link">
476 <span class="menu-text">Datasets</span></a>
477 </div>
478</li>
479 <li class="sidebar-item">
480 <div class="sidebar-item-container">
481 <a href="../reference/lenses.html" class="sidebar-item-text sidebar-link">
482 <span class="menu-text">Lenses</span></a>
483 </div>
484</li>
485 <li class="sidebar-item">
486 <div class="sidebar-item-container">
487 <a href="../reference/local-storage.html" class="sidebar-item-text sidebar-link">
488 <span class="menu-text">Local Storage</span></a>
489 </div>
490</li>
491 <li class="sidebar-item">
492 <div class="sidebar-item-container">
493 <a href="../reference/atmosphere.html" class="sidebar-item-text sidebar-link">
494 <span class="menu-text">Atmosphere (ATProto Integration)</span></a>
495 </div>
496</li>
497 <li class="sidebar-item">
498 <div class="sidebar-item-container">
499 <a href="../reference/promotion.html" class="sidebar-item-text sidebar-link">
500 <span class="menu-text">Promotion Workflow</span></a>
501 </div>
502</li>
503 <li class="sidebar-item">
504 <div class="sidebar-item-container">
505 <a href="../reference/load-dataset.html" class="sidebar-item-text sidebar-link">
506 <span class="menu-text">load_dataset API</span></a>
507 </div>
508</li>
509 <li class="sidebar-item">
510 <div class="sidebar-item-container">
511 <a href="../reference/protocols.html" class="sidebar-item-text sidebar-link">
512 <span class="menu-text">Protocols</span></a>
513 </div>
514</li>
515 <li class="sidebar-item">
516 <div class="sidebar-item-container">
517 <a href="../reference/uri-spec.html" class="sidebar-item-text sidebar-link">
518 <span class="menu-text">URI Specification</span></a>
519 </div>
520</li>
521 <li class="sidebar-item">
522 <div class="sidebar-item-container">
523 <a href="../reference/troubleshooting.html" class="sidebar-item-text sidebar-link">
524 <span class="menu-text">Troubleshooting & FAQ</span></a>
525 </div>
526</li>
527 <li class="sidebar-item">
528 <div class="sidebar-item-container">
529 <a href="../reference/deployment.html" class="sidebar-item-text sidebar-link active">
530 <span class="menu-text">Deployment Guide</span></a>
531 </div>
532</li>
533 </ul>
534 </li>
535 </ul>
536 </div>
537</nav>
538<div id="quarto-sidebar-glass" class="quarto-sidebar-collapse-item" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item"></div>
539<!-- margin-sidebar -->
540 <div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
541 <nav id="TOC" role="doc-toc" class="toc-active">
542 <h2 id="toc-title">On this page</h2>
543
544 <ul>
545 <li><a href="#local-storage-deployment" id="toc-local-storage-deployment" class="nav-link active" data-scroll-target="#local-storage-deployment">Local Storage Deployment</a>
546 <ul class="collapse">
547 <li><a href="#redis-setup" id="toc-redis-setup" class="nav-link" data-scroll-target="#redis-setup">Redis Setup</a></li>
548 <li><a href="#s3-storage-setup" id="toc-s3-storage-setup" class="nav-link" data-scroll-target="#s3-storage-setup">S3 Storage Setup</a></li>
549 <li><a href="#production-checklist" id="toc-production-checklist" class="nav-link" data-scroll-target="#production-checklist">Production Checklist</a></li>
550 </ul></li>
551 <li><a href="#atproto-deployment" id="toc-atproto-deployment" class="nav-link" data-scroll-target="#atproto-deployment">ATProto Deployment</a>
552 <ul class="collapse">
553 <li><a href="#account-setup" id="toc-account-setup" class="nav-link" data-scroll-target="#account-setup">Account Setup</a></li>
554 <li><a href="#authentication-patterns" id="toc-authentication-patterns" class="nav-link" data-scroll-target="#authentication-patterns">Authentication Patterns</a></li>
555 <li><a href="#custom-pds-deployment" id="toc-custom-pds-deployment" class="nav-link" data-scroll-target="#custom-pds-deployment">Custom PDS Deployment</a></li>
556 <li><a href="#rate-limiting-considerations" id="toc-rate-limiting-considerations" class="nav-link" data-scroll-target="#rate-limiting-considerations">Rate Limiting Considerations</a></li>
557 </ul></li>
558 <li><a href="#docker-compose-example" id="toc-docker-compose-example" class="nav-link" data-scroll-target="#docker-compose-example">Docker Compose Example</a></li>
559 <li><a href="#monitoring" id="toc-monitoring" class="nav-link" data-scroll-target="#monitoring">Monitoring</a>
560 <ul class="collapse">
561 <li><a href="#redis-metrics" id="toc-redis-metrics" class="nav-link" data-scroll-target="#redis-metrics">Redis Metrics</a></li>
562 <li><a href="#s3-metrics" id="toc-s3-metrics" class="nav-link" data-scroll-target="#s3-metrics">S3 Metrics</a></li>
563 </ul></li>
564 <li><a href="#security-best-practices" id="toc-security-best-practices" class="nav-link" data-scroll-target="#security-best-practices">Security Best Practices</a>
565 <ul class="collapse">
566 <li><a href="#s3-iam-policy-example" id="toc-s3-iam-policy-example" class="nav-link" data-scroll-target="#s3-iam-policy-example">S3 IAM Policy Example</a></li>
567 </ul></li>
568 </ul>
569<div class="toc-actions"><ul><li><a href="https://github.com/your-org/atdata/edit/main/reference/deployment.qmd" class="toc-action"><i class="bi bi-github"></i>Edit this page</a></li><li><a href="https://github.com/your-org/atdata/issues/new" class="toc-action"><i class="bi empty"></i>Report an issue</a></li></ul></div></nav>
570 </div>
571<!-- main -->
572<main class="content" id="quarto-document-content">
573
574
575<header id="title-block-header" class="quarto-title-block default"><nav class="quarto-page-breadcrumbs quarto-title-breadcrumbs d-none d-lg-block" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="../reference/architecture.html">Reference</a></li><li class="breadcrumb-item"><a href="../reference/deployment.html">Deployment Guide</a></li></ol></nav>
576<div class="quarto-title">
577<h1 class="title">Deployment Guide</h1>
578</div>
579
580<div>
581 <div class="description">
582 Production deployment for local storage and ATProto integration
583 </div>
584</div>
585
586
587<div class="quarto-title-meta">
588
589
590
591
592 </div>
593
594
595
596</header>
597
598
599<p>This guide covers deploying atdata in production environments, including Redis setup for LocalIndex, S3 storage configuration, and ATProto publishing considerations.</p>
600<section id="local-storage-deployment" class="level2">
601<h2 class="anchored" data-anchor-id="local-storage-deployment">Local Storage Deployment</h2>
602<p>The local storage backend uses Redis for metadata indexing and S3-compatible storage for dataset files.</p>
603<section id="redis-setup" class="level3">
604<h3 class="anchored" data-anchor-id="redis-setup">Redis Setup</h3>
605<section id="requirements" class="level4">
606<h4 class="anchored" data-anchor-id="requirements">Requirements</h4>
607<ul>
608<li>Redis 6.0+ (for Redis-OM compatibility)</li>
609<li>Sufficient memory for index metadata (typically < 100MB for most deployments)</li>
610</ul>
611</section>
612<section id="docker-deployment" class="level4">
613<h4 class="anchored" data-anchor-id="docker-deployment">Docker Deployment</h4>
614<div class="sourceCode" id="cb1"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="co"># Basic Redis</span></span>
615<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> run <span class="at">-d</span> <span class="dt">\</span></span>
616<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a> <span class="at">--name</span> atdata-redis <span class="dt">\</span></span>
617<span id="cb1-4"><a href="#cb1-4" aria-hidden="true" tabindex="-1"></a> <span class="at">-p</span> 6379:6379 <span class="dt">\</span></span>
618<span id="cb1-5"><a href="#cb1-5" aria-hidden="true" tabindex="-1"></a> <span class="at">-v</span> redis-data:/data <span class="dt">\</span></span>
619<span id="cb1-6"><a href="#cb1-6" aria-hidden="true" tabindex="-1"></a> redis:7-alpine <span class="dt">\</span></span>
620<span id="cb1-7"><a href="#cb1-7" aria-hidden="true" tabindex="-1"></a> redis-server <span class="at">--appendonly</span> yes</span>
621<span id="cb1-8"><a href="#cb1-8" aria-hidden="true" tabindex="-1"></a></span>
622<span id="cb1-9"><a href="#cb1-9" aria-hidden="true" tabindex="-1"></a><span class="co"># With password</span></span>
623<span id="cb1-10"><a href="#cb1-10" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> run <span class="at">-d</span> <span class="dt">\</span></span>
624<span id="cb1-11"><a href="#cb1-11" aria-hidden="true" tabindex="-1"></a> <span class="at">--name</span> atdata-redis <span class="dt">\</span></span>
625<span id="cb1-12"><a href="#cb1-12" aria-hidden="true" tabindex="-1"></a> <span class="at">-p</span> 6379:6379 <span class="dt">\</span></span>
626<span id="cb1-13"><a href="#cb1-13" aria-hidden="true" tabindex="-1"></a> <span class="at">-v</span> redis-data:/data <span class="dt">\</span></span>
627<span id="cb1-14"><a href="#cb1-14" aria-hidden="true" tabindex="-1"></a> redis:7-alpine <span class="dt">\</span></span>
628<span id="cb1-15"><a href="#cb1-15" aria-hidden="true" tabindex="-1"></a> redis-server <span class="at">--appendonly</span> yes <span class="at">--requirepass</span> yourpassword</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
629</section>
630<section id="configuration" class="level4">
631<h4 class="anchored" data-anchor-id="configuration">Configuration</h4>
632<div class="sourceCode" id="cb2"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> redis <span class="im">import</span> Redis</span>
633<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> atdata.local <span class="im">import</span> LocalIndex</span>
634<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a></span>
635<span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a><span class="co"># Basic connection</span></span>
636<span id="cb2-5"><a href="#cb2-5" aria-hidden="true" tabindex="-1"></a>redis <span class="op">=</span> Redis(host<span class="op">=</span><span class="st">"localhost"</span>, port<span class="op">=</span><span class="dv">6379</span>)</span>
637<span id="cb2-6"><a href="#cb2-6" aria-hidden="true" tabindex="-1"></a>index <span class="op">=</span> LocalIndex(redis<span class="op">=</span>redis)</span>
638<span id="cb2-7"><a href="#cb2-7" aria-hidden="true" tabindex="-1"></a></span>
639<span id="cb2-8"><a href="#cb2-8" aria-hidden="true" tabindex="-1"></a><span class="co"># With authentication</span></span>
640<span id="cb2-9"><a href="#cb2-9" aria-hidden="true" tabindex="-1"></a>redis <span class="op">=</span> Redis(</span>
641<span id="cb2-10"><a href="#cb2-10" aria-hidden="true" tabindex="-1"></a> host<span class="op">=</span><span class="st">"redis.example.com"</span>,</span>
642<span id="cb2-11"><a href="#cb2-11" aria-hidden="true" tabindex="-1"></a> port<span class="op">=</span><span class="dv">6379</span>,</span>
643<span id="cb2-12"><a href="#cb2-12" aria-hidden="true" tabindex="-1"></a> password<span class="op">=</span><span class="st">"yourpassword"</span>,</span>
644<span id="cb2-13"><a href="#cb2-13" aria-hidden="true" tabindex="-1"></a> ssl<span class="op">=</span><span class="va">True</span>, <span class="co"># For production</span></span>
645<span id="cb2-14"><a href="#cb2-14" aria-hidden="true" tabindex="-1"></a>)</span>
646<span id="cb2-15"><a href="#cb2-15" aria-hidden="true" tabindex="-1"></a>index <span class="op">=</span> LocalIndex(redis<span class="op">=</span>redis)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
647</section>
648<section id="redis-clustering" class="level4">
649<h4 class="anchored" data-anchor-id="redis-clustering">Redis Clustering</h4>
650<p>For high-availability deployments:</p>
651<div class="sourceCode" id="cb3"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> redis.cluster <span class="im">import</span> RedisCluster</span>
652<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a></span>
653<span id="cb3-3"><a href="#cb3-3" aria-hidden="true" tabindex="-1"></a><span class="co"># Redis Cluster connection</span></span>
654<span id="cb3-4"><a href="#cb3-4" aria-hidden="true" tabindex="-1"></a>redis <span class="op">=</span> RedisCluster(</span>
655<span id="cb3-5"><a href="#cb3-5" aria-hidden="true" tabindex="-1"></a> host<span class="op">=</span><span class="st">"redis-cluster.example.com"</span>,</span>
656<span id="cb3-6"><a href="#cb3-6" aria-hidden="true" tabindex="-1"></a> port<span class="op">=</span><span class="dv">6379</span>,</span>
657<span id="cb3-7"><a href="#cb3-7" aria-hidden="true" tabindex="-1"></a> password<span class="op">=</span><span class="st">"yourpassword"</span>,</span>
658<span id="cb3-8"><a href="#cb3-8" aria-hidden="true" tabindex="-1"></a>)</span>
659<span id="cb3-9"><a href="#cb3-9" aria-hidden="true" tabindex="-1"></a>index <span class="op">=</span> LocalIndex(redis<span class="op">=</span>redis)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
660<div class="callout callout-style-default callout-note callout-titled">
661<div class="callout-header d-flex align-content-center">
662<div class="callout-icon-container">
663<i class="callout-icon"></i>
664</div>
665<div class="callout-title-container flex-fill">
666Note
667</div>
668</div>
669<div class="callout-body-container callout-body">
670<p>Redis-OM (used internally) supports Redis Cluster mode. Ensure all nodes have the same configuration.</p>
671</div>
672</div>
673</section>
674</section>
675<section id="s3-storage-setup" class="level3">
676<h3 class="anchored" data-anchor-id="s3-storage-setup">S3 Storage Setup</h3>
677<section id="aws-s3" class="level4">
678<h4 class="anchored" data-anchor-id="aws-s3">AWS S3</h4>
679<div class="sourceCode" id="cb4"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> atdata.local <span class="im">import</span> S3DataStore</span>
680<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a></span>
681<span id="cb4-3"><a href="#cb4-3" aria-hidden="true" tabindex="-1"></a><span class="co"># Using environment credentials (recommended for AWS)</span></span>
682<span id="cb4-4"><a href="#cb4-4" aria-hidden="true" tabindex="-1"></a><span class="co"># Set AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY</span></span>
683<span id="cb4-5"><a href="#cb4-5" aria-hidden="true" tabindex="-1"></a>store <span class="op">=</span> S3DataStore(</span>
684<span id="cb4-6"><a href="#cb4-6" aria-hidden="true" tabindex="-1"></a> bucket<span class="op">=</span><span class="st">"my-atdata-bucket"</span>,</span>
685<span id="cb4-7"><a href="#cb4-7" aria-hidden="true" tabindex="-1"></a> prefix<span class="op">=</span><span class="st">"datasets/"</span>,</span>
686<span id="cb4-8"><a href="#cb4-8" aria-hidden="true" tabindex="-1"></a>)</span>
687<span id="cb4-9"><a href="#cb4-9" aria-hidden="true" tabindex="-1"></a></span>
688<span id="cb4-10"><a href="#cb4-10" aria-hidden="true" tabindex="-1"></a><span class="co"># Explicit credentials</span></span>
689<span id="cb4-11"><a href="#cb4-11" aria-hidden="true" tabindex="-1"></a>store <span class="op">=</span> S3DataStore(</span>
690<span id="cb4-12"><a href="#cb4-12" aria-hidden="true" tabindex="-1"></a> bucket<span class="op">=</span><span class="st">"my-atdata-bucket"</span>,</span>
691<span id="cb4-13"><a href="#cb4-13" aria-hidden="true" tabindex="-1"></a> prefix<span class="op">=</span><span class="st">"datasets/"</span>,</span>
692<span id="cb4-14"><a href="#cb4-14" aria-hidden="true" tabindex="-1"></a> credentials<span class="op">=</span>{</span>
693<span id="cb4-15"><a href="#cb4-15" aria-hidden="true" tabindex="-1"></a> <span class="st">"AWS_ACCESS_KEY_ID"</span>: <span class="st">"..."</span>,</span>
694<span id="cb4-16"><a href="#cb4-16" aria-hidden="true" tabindex="-1"></a> <span class="st">"AWS_SECRET_ACCESS_KEY"</span>: <span class="st">"..."</span>,</span>
695<span id="cb4-17"><a href="#cb4-17" aria-hidden="true" tabindex="-1"></a> <span class="st">"AWS_DEFAULT_REGION"</span>: <span class="st">"us-west-2"</span>,</span>
696<span id="cb4-18"><a href="#cb4-18" aria-hidden="true" tabindex="-1"></a> },</span>
697<span id="cb4-19"><a href="#cb4-19" aria-hidden="true" tabindex="-1"></a>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
698</section>
699<section id="s3-compatible-storage-minio-cloudflare-r2-etc." class="level4">
700<h4 class="anchored" data-anchor-id="s3-compatible-storage-minio-cloudflare-r2-etc.">S3-Compatible Storage (MinIO, Cloudflare R2, etc.)</h4>
701<div class="sourceCode" id="cb5"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a>store <span class="op">=</span> S3DataStore(</span>
702<span id="cb5-2"><a href="#cb5-2" aria-hidden="true" tabindex="-1"></a> bucket<span class="op">=</span><span class="st">"my-bucket"</span>,</span>
703<span id="cb5-3"><a href="#cb5-3" aria-hidden="true" tabindex="-1"></a> prefix<span class="op">=</span><span class="st">"datasets/"</span>,</span>
704<span id="cb5-4"><a href="#cb5-4" aria-hidden="true" tabindex="-1"></a> endpoint_url<span class="op">=</span><span class="st">"https://s3.example.com"</span>,</span>
705<span id="cb5-5"><a href="#cb5-5" aria-hidden="true" tabindex="-1"></a> credentials<span class="op">=</span>{</span>
706<span id="cb5-6"><a href="#cb5-6" aria-hidden="true" tabindex="-1"></a> <span class="st">"AWS_ACCESS_KEY_ID"</span>: <span class="st">"..."</span>,</span>
707<span id="cb5-7"><a href="#cb5-7" aria-hidden="true" tabindex="-1"></a> <span class="st">"AWS_SECRET_ACCESS_KEY"</span>: <span class="st">"..."</span>,</span>
708<span id="cb5-8"><a href="#cb5-8" aria-hidden="true" tabindex="-1"></a> },</span>
709<span id="cb5-9"><a href="#cb5-9" aria-hidden="true" tabindex="-1"></a>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
710</section>
711<section id="minio-deployment" class="level4">
712<h4 class="anchored" data-anchor-id="minio-deployment">MinIO Deployment</h4>
713<div class="sourceCode" id="cb6"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a><span class="co"># Docker deployment</span></span>
714<span id="cb6-2"><a href="#cb6-2" aria-hidden="true" tabindex="-1"></a><span class="ex">docker</span> run <span class="at">-d</span> <span class="dt">\</span></span>
715<span id="cb6-3"><a href="#cb6-3" aria-hidden="true" tabindex="-1"></a> <span class="at">--name</span> minio <span class="dt">\</span></span>
716<span id="cb6-4"><a href="#cb6-4" aria-hidden="true" tabindex="-1"></a> <span class="at">-p</span> 9000:9000 <span class="dt">\</span></span>
717<span id="cb6-5"><a href="#cb6-5" aria-hidden="true" tabindex="-1"></a> <span class="at">-p</span> 9001:9001 <span class="dt">\</span></span>
718<span id="cb6-6"><a href="#cb6-6" aria-hidden="true" tabindex="-1"></a> <span class="at">-v</span> minio-data:/data <span class="dt">\</span></span>
719<span id="cb6-7"><a href="#cb6-7" aria-hidden="true" tabindex="-1"></a> <span class="at">-e</span> MINIO_ROOT_USER=minioadmin <span class="dt">\</span></span>
720<span id="cb6-8"><a href="#cb6-8" aria-hidden="true" tabindex="-1"></a> <span class="at">-e</span> MINIO_ROOT_PASSWORD=minioadmin <span class="dt">\</span></span>
721<span id="cb6-9"><a href="#cb6-9" aria-hidden="true" tabindex="-1"></a> minio/minio server /data <span class="at">--console-address</span> <span class="st">":9001"</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
722<div class="sourceCode" id="cb7"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a>store <span class="op">=</span> S3DataStore(</span>
723<span id="cb7-2"><a href="#cb7-2" aria-hidden="true" tabindex="-1"></a> bucket<span class="op">=</span><span class="st">"atdata"</span>,</span>
724<span id="cb7-3"><a href="#cb7-3" aria-hidden="true" tabindex="-1"></a> endpoint_url<span class="op">=</span><span class="st">"http://localhost:9000"</span>,</span>
725<span id="cb7-4"><a href="#cb7-4" aria-hidden="true" tabindex="-1"></a> credentials<span class="op">=</span>{</span>
726<span id="cb7-5"><a href="#cb7-5" aria-hidden="true" tabindex="-1"></a> <span class="st">"AWS_ACCESS_KEY_ID"</span>: <span class="st">"minioadmin"</span>,</span>
727<span id="cb7-6"><a href="#cb7-6" aria-hidden="true" tabindex="-1"></a> <span class="st">"AWS_SECRET_ACCESS_KEY"</span>: <span class="st">"minioadmin"</span>,</span>
728<span id="cb7-7"><a href="#cb7-7" aria-hidden="true" tabindex="-1"></a> },</span>
729<span id="cb7-8"><a href="#cb7-8" aria-hidden="true" tabindex="-1"></a>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
730</section>
731</section>
732<section id="production-checklist" class="level3">
733<h3 class="anchored" data-anchor-id="production-checklist">Production Checklist</h3>
734<ul class="task-list">
735<li><label><input type="checkbox">Redis persistence enabled (<code>appendonly yes</code>)</label></li>
736<li><label><input type="checkbox">Redis password authentication configured</label></li>
737<li><label><input type="checkbox">Redis TLS enabled for remote connections</label></li>
738<li><label><input type="checkbox">S3 bucket access policies configured (least privilege)</label></li>
739<li><label><input type="checkbox">S3 bucket versioning enabled (for data recovery)</label></li>
740<li><label><input type="checkbox">Monitoring for Redis memory usage</label></li>
741<li><label><input type="checkbox">Backup strategy for Redis data</label></li>
742</ul>
743</section>
744</section>
745<section id="atproto-deployment" class="level2">
746<h2 class="anchored" data-anchor-id="atproto-deployment">ATProto Deployment</h2>
747<section id="account-setup" class="level3">
748<h3 class="anchored" data-anchor-id="account-setup">Account Setup</h3>
749<ol type="1">
750<li>Create a Bluesky account or use your existing account</li>
751<li>Generate an app-specific password at <a href="https://bsky.app/settings/app-passwords">bsky.app/settings/app-passwords</a></li>
752<li>Never use your main account password in code</li>
753</ol>
754<div class="callout callout-style-default callout-warning callout-titled">
755<div class="callout-header d-flex align-content-center">
756<div class="callout-icon-container">
757<i class="callout-icon"></i>
758</div>
759<div class="callout-title-container flex-fill">
760Warning
761</div>
762</div>
763<div class="callout-body-container callout-body">
764<p><strong>Security</strong>: Always use app passwords, never your main password. App passwords can be revoked without affecting your account.</p>
765</div>
766</div>
767</section>
768<section id="authentication-patterns" class="level3">
769<h3 class="anchored" data-anchor-id="authentication-patterns">Authentication Patterns</h3>
770<section id="environment-variables-recommended" class="level4">
771<h4 class="anchored" data-anchor-id="environment-variables-recommended">Environment Variables (Recommended)</h4>
772<div class="sourceCode" id="cb8"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb8-1"><a href="#cb8-1" aria-hidden="true" tabindex="-1"></a><span class="im">import</span> os</span>
773<span id="cb8-2"><a href="#cb8-2" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> atdata.atmosphere <span class="im">import</span> AtmosphereClient</span>
774<span id="cb8-3"><a href="#cb8-3" aria-hidden="true" tabindex="-1"></a></span>
775<span id="cb8-4"><a href="#cb8-4" aria-hidden="true" tabindex="-1"></a>client <span class="op">=</span> AtmosphereClient()</span>
776<span id="cb8-5"><a href="#cb8-5" aria-hidden="true" tabindex="-1"></a>client.login(</span>
777<span id="cb8-6"><a href="#cb8-6" aria-hidden="true" tabindex="-1"></a> os.environ[<span class="st">"ATPROTO_HANDLE"</span>],</span>
778<span id="cb8-7"><a href="#cb8-7" aria-hidden="true" tabindex="-1"></a> os.environ[<span class="st">"ATPROTO_APP_PASSWORD"</span>],</span>
779<span id="cb8-8"><a href="#cb8-8" aria-hidden="true" tabindex="-1"></a>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
780</section>
781<section id="session-persistence" class="level4">
782<h4 class="anchored" data-anchor-id="session-persistence">Session Persistence</h4>
783<p>For long-running services, persist and reuse sessions:</p>
784<div class="sourceCode" id="cb9"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb9-1"><a href="#cb9-1" aria-hidden="true" tabindex="-1"></a><span class="im">import</span> os</span>
785<span id="cb9-2"><a href="#cb9-2" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> pathlib <span class="im">import</span> Path</span>
786<span id="cb9-3"><a href="#cb9-3" aria-hidden="true" tabindex="-1"></a></span>
787<span id="cb9-4"><a href="#cb9-4" aria-hidden="true" tabindex="-1"></a>SESSION_FILE <span class="op">=</span> Path(<span class="st">"~/.atdata/session"</span>).expanduser()</span>
788<span id="cb9-5"><a href="#cb9-5" aria-hidden="true" tabindex="-1"></a></span>
789<span id="cb9-6"><a href="#cb9-6" aria-hidden="true" tabindex="-1"></a>client <span class="op">=</span> AtmosphereClient()</span>
790<span id="cb9-7"><a href="#cb9-7" aria-hidden="true" tabindex="-1"></a></span>
791<span id="cb9-8"><a href="#cb9-8" aria-hidden="true" tabindex="-1"></a><span class="cf">if</span> SESSION_FILE.exists():</span>
792<span id="cb9-9"><a href="#cb9-9" aria-hidden="true" tabindex="-1"></a> <span class="co"># Restore existing session</span></span>
793<span id="cb9-10"><a href="#cb9-10" aria-hidden="true" tabindex="-1"></a> session_string <span class="op">=</span> SESSION_FILE.read_text()</span>
794<span id="cb9-11"><a href="#cb9-11" aria-hidden="true" tabindex="-1"></a> <span class="cf">try</span>:</span>
795<span id="cb9-12"><a href="#cb9-12" aria-hidden="true" tabindex="-1"></a> client.login_with_session(session_string)</span>
796<span id="cb9-13"><a href="#cb9-13" aria-hidden="true" tabindex="-1"></a> <span class="cf">except</span> <span class="pp">Exception</span>:</span>
797<span id="cb9-14"><a href="#cb9-14" aria-hidden="true" tabindex="-1"></a> <span class="co"># Session expired, re-authenticate</span></span>
798<span id="cb9-15"><a href="#cb9-15" aria-hidden="true" tabindex="-1"></a> client.login(handle, app_password)</span>
799<span id="cb9-16"><a href="#cb9-16" aria-hidden="true" tabindex="-1"></a> SESSION_FILE.parent.mkdir(parents<span class="op">=</span><span class="va">True</span>, exist_ok<span class="op">=</span><span class="va">True</span>)</span>
800<span id="cb9-17"><a href="#cb9-17" aria-hidden="true" tabindex="-1"></a> SESSION_FILE.write_text(client.export_session())</span>
801<span id="cb9-18"><a href="#cb9-18" aria-hidden="true" tabindex="-1"></a><span class="cf">else</span>:</span>
802<span id="cb9-19"><a href="#cb9-19" aria-hidden="true" tabindex="-1"></a> <span class="co"># Initial login</span></span>
803<span id="cb9-20"><a href="#cb9-20" aria-hidden="true" tabindex="-1"></a> client.login(handle, app_password)</span>
804<span id="cb9-21"><a href="#cb9-21" aria-hidden="true" tabindex="-1"></a> SESSION_FILE.parent.mkdir(parents<span class="op">=</span><span class="va">True</span>, exist_ok<span class="op">=</span><span class="va">True</span>)</span>
805<span id="cb9-22"><a href="#cb9-22" aria-hidden="true" tabindex="-1"></a> SESSION_FILE.write_text(client.export_session())</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
806</section>
807</section>
808<section id="custom-pds-deployment" class="level3">
809<h3 class="anchored" data-anchor-id="custom-pds-deployment">Custom PDS Deployment</h3>
810<p>For self-hosted ATProto infrastructure:</p>
811<div class="sourceCode" id="cb10"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb10-1"><a href="#cb10-1" aria-hidden="true" tabindex="-1"></a>client <span class="op">=</span> AtmosphereClient(base_url<span class="op">=</span><span class="st">"https://pds.example.com"</span>)</span>
812<span id="cb10-2"><a href="#cb10-2" aria-hidden="true" tabindex="-1"></a>client.login(<span class="st">"handle.example.com"</span>, <span class="st">"app-password"</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
813<p>See <a href="https://github.com/bluesky-social/pds">ATProto PDS documentation</a> for self-hosting setup.</p>
814</section>
815<section id="rate-limiting-considerations" class="level3">
816<h3 class="anchored" data-anchor-id="rate-limiting-considerations">Rate Limiting Considerations</h3>
817<p>ATProto has rate limits. For bulk operations:</p>
818<ul>
819<li>Space out record creation (1-2 per second for bulk uploads)</li>
820<li>Use batch operations where available</li>
821<li>Implement exponential backoff for retries</li>
822<li>Consider blob storage limits (~50MB per blob)</li>
823</ul>
824<div class="sourceCode" id="cb11"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb11-1"><a href="#cb11-1" aria-hidden="true" tabindex="-1"></a><span class="im">import</span> time</span>
825<span id="cb11-2"><a href="#cb11-2" aria-hidden="true" tabindex="-1"></a></span>
826<span id="cb11-3"><a href="#cb11-3" aria-hidden="true" tabindex="-1"></a><span class="cf">for</span> i, dataset <span class="kw">in</span> <span class="bu">enumerate</span>(datasets_to_publish):</span>
827<span id="cb11-4"><a href="#cb11-4" aria-hidden="true" tabindex="-1"></a> index.insert_dataset(dataset, name<span class="op">=</span><span class="ss">f"dataset-</span><span class="sc">{</span>i<span class="sc">}</span><span class="ss">"</span>, ...)</span>
828<span id="cb11-5"><a href="#cb11-5" aria-hidden="true" tabindex="-1"></a> time.sleep(<span class="dv">1</span>) <span class="co"># Rate limiting</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
829</section>
830</section>
831<section id="docker-compose-example" class="level2">
832<h2 class="anchored" data-anchor-id="docker-compose-example">Docker Compose Example</h2>
833<p>Complete local deployment with Redis and MinIO:</p>
834<div class="sourceCode" id="cb12"><pre class="sourceCode yaml code-with-copy"><code class="sourceCode yaml"><span id="cb12-1"><a href="#cb12-1" aria-hidden="true" tabindex="-1"></a><span class="co"># docker-compose.yml</span></span>
835<span id="cb12-2"><a href="#cb12-2" aria-hidden="true" tabindex="-1"></a><span class="fu">version</span><span class="kw">:</span><span class="at"> </span><span class="st">'3.8'</span></span>
836<span id="cb12-3"><a href="#cb12-3" aria-hidden="true" tabindex="-1"></a></span>
837<span id="cb12-4"><a href="#cb12-4" aria-hidden="true" tabindex="-1"></a><span class="fu">services</span><span class="kw">:</span></span>
838<span id="cb12-5"><a href="#cb12-5" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">redis</span><span class="kw">:</span></span>
839<span id="cb12-6"><a href="#cb12-6" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">image</span><span class="kw">:</span><span class="at"> redis:7-alpine</span></span>
840<span id="cb12-7"><a href="#cb12-7" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">command</span><span class="kw">:</span><span class="at"> redis-server --appendonly yes --requirepass ${REDIS_PASSWORD}</span></span>
841<span id="cb12-8"><a href="#cb12-8" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">ports</span><span class="kw">:</span></span>
842<span id="cb12-9"><a href="#cb12-9" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="st">"6379:6379"</span></span>
843<span id="cb12-10"><a href="#cb12-10" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">volumes</span><span class="kw">:</span></span>
844<span id="cb12-11"><a href="#cb12-11" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> redis-data:/data</span></span>
845<span id="cb12-12"><a href="#cb12-12" aria-hidden="true" tabindex="-1"></a></span>
846<span id="cb12-13"><a href="#cb12-13" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">minio</span><span class="kw">:</span></span>
847<span id="cb12-14"><a href="#cb12-14" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">image</span><span class="kw">:</span><span class="at"> minio/minio</span></span>
848<span id="cb12-15"><a href="#cb12-15" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">command</span><span class="kw">:</span><span class="at"> server /data --console-address ":9001"</span></span>
849<span id="cb12-16"><a href="#cb12-16" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">ports</span><span class="kw">:</span></span>
850<span id="cb12-17"><a href="#cb12-17" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="st">"9000:9000"</span></span>
851<span id="cb12-18"><a href="#cb12-18" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="st">"9001:9001"</span></span>
852<span id="cb12-19"><a href="#cb12-19" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">environment</span><span class="kw">:</span></span>
853<span id="cb12-20"><a href="#cb12-20" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">MINIO_ROOT_USER</span><span class="kw">:</span><span class="at"> ${MINIO_USER}</span></span>
854<span id="cb12-21"><a href="#cb12-21" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">MINIO_ROOT_PASSWORD</span><span class="kw">:</span><span class="at"> ${MINIO_PASSWORD}</span></span>
855<span id="cb12-22"><a href="#cb12-22" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">volumes</span><span class="kw">:</span></span>
856<span id="cb12-23"><a href="#cb12-23" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> minio-data:/data</span></span>
857<span id="cb12-24"><a href="#cb12-24" aria-hidden="true" tabindex="-1"></a></span>
858<span id="cb12-25"><a href="#cb12-25" aria-hidden="true" tabindex="-1"></a><span class="fu">volumes</span><span class="kw">:</span></span>
859<span id="cb12-26"><a href="#cb12-26" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">redis-data</span><span class="kw">:</span></span>
860<span id="cb12-27"><a href="#cb12-27" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">minio-data</span><span class="kw">:</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
861<div class="sourceCode" id="cb13"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb13-1"><a href="#cb13-1" aria-hidden="true" tabindex="-1"></a><span class="co"># .env</span></span>
862<span id="cb13-2"><a href="#cb13-2" aria-hidden="true" tabindex="-1"></a><span class="va">REDIS_PASSWORD</span><span class="op">=</span>your-redis-password</span>
863<span id="cb13-3"><a href="#cb13-3" aria-hidden="true" tabindex="-1"></a><span class="va">MINIO_USER</span><span class="op">=</span>minioadmin</span>
864<span id="cb13-4"><a href="#cb13-4" aria-hidden="true" tabindex="-1"></a><span class="va">MINIO_PASSWORD</span><span class="op">=</span>your-minio-password</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
865</section>
866<section id="monitoring" class="level2">
867<h2 class="anchored" data-anchor-id="monitoring">Monitoring</h2>
868<section id="redis-metrics" class="level3">
869<h3 class="anchored" data-anchor-id="redis-metrics">Redis Metrics</h3>
870<p>Key metrics to monitor:</p>
871<ul>
872<li><code>used_memory</code>: Memory usage</li>
873<li><code>connected_clients</code>: Active connections</li>
874<li><code>keyspace_hits/misses</code>: Cache efficiency</li>
875<li><code>aof_last_write_status</code>: Persistence health</li>
876</ul>
877<div class="sourceCode" id="cb14"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb14-1"><a href="#cb14-1" aria-hidden="true" tabindex="-1"></a><span class="ex">redis-cli</span> INFO <span class="kw">|</span> <span class="fu">grep</span> <span class="at">-E</span> <span class="st">"used_memory|connected_clients|keyspace"</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
878</section>
879<section id="s3-metrics" class="level3">
880<h3 class="anchored" data-anchor-id="s3-metrics">S3 Metrics</h3>
881<ul>
882<li>Request counts and latency</li>
883<li>Error rates (4xx, 5xx)</li>
884<li>Storage usage by prefix</li>
885<li>Data transfer costs</li>
886</ul>
887</section>
888</section>
889<section id="security-best-practices" class="level2">
890<h2 class="anchored" data-anchor-id="security-best-practices">Security Best Practices</h2>
891<ol type="1">
892<li><strong>Network Isolation</strong>: Run Redis and S3 in private networks</li>
893<li><strong>TLS Everywhere</strong>: Encrypt connections to Redis and S3</li>
894<li><strong>Credential Rotation</strong>: Rotate API keys and passwords regularly</li>
895<li><strong>Access Logging</strong>: Enable S3 access logging for audit trails</li>
896<li><strong>Least Privilege</strong>: Use minimal IAM permissions for S3 access</li>
897</ol>
898<section id="s3-iam-policy-example" class="level3">
899<h3 class="anchored" data-anchor-id="s3-iam-policy-example">S3 IAM Policy Example</h3>
900<div class="sourceCode" id="cb15"><pre class="sourceCode json code-with-copy"><code class="sourceCode json"><span id="cb15-1"><a href="#cb15-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
901<span id="cb15-2"><a href="#cb15-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">"Version"</span><span class="fu">:</span> <span class="st">"2012-10-17"</span><span class="fu">,</span></span>
902<span id="cb15-3"><a href="#cb15-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">"Statement"</span><span class="fu">:</span> <span class="ot">[</span></span>
903<span id="cb15-4"><a href="#cb15-4" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
904<span id="cb15-5"><a href="#cb15-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">"Effect"</span><span class="fu">:</span> <span class="st">"Allow"</span><span class="fu">,</span></span>
905<span id="cb15-6"><a href="#cb15-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">"Action"</span><span class="fu">:</span> <span class="ot">[</span></span>
906<span id="cb15-7"><a href="#cb15-7" aria-hidden="true" tabindex="-1"></a> <span class="st">"s3:GetObject"</span><span class="ot">,</span></span>
907<span id="cb15-8"><a href="#cb15-8" aria-hidden="true" tabindex="-1"></a> <span class="st">"s3:PutObject"</span><span class="ot">,</span></span>
908<span id="cb15-9"><a href="#cb15-9" aria-hidden="true" tabindex="-1"></a> <span class="st">"s3:ListBucket"</span></span>
909<span id="cb15-10"><a href="#cb15-10" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span><span class="fu">,</span></span>
910<span id="cb15-11"><a href="#cb15-11" aria-hidden="true" tabindex="-1"></a> <span class="dt">"Resource"</span><span class="fu">:</span> <span class="ot">[</span></span>
911<span id="cb15-12"><a href="#cb15-12" aria-hidden="true" tabindex="-1"></a> <span class="st">"arn:aws:s3:::my-atdata-bucket"</span><span class="ot">,</span></span>
912<span id="cb15-13"><a href="#cb15-13" aria-hidden="true" tabindex="-1"></a> <span class="st">"arn:aws:s3:::my-atdata-bucket/*"</span></span>
913<span id="cb15-14"><a href="#cb15-14" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span></span>
914<span id="cb15-15"><a href="#cb15-15" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
915<span id="cb15-16"><a href="#cb15-16" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span></span>
916<span id="cb15-17"><a href="#cb15-17" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
917
918
919</section>
920</section>
921
922</main> <!-- /main -->
923<script id="quarto-html-after-body" type="application/javascript">
924 window.document.addEventListener("DOMContentLoaded", function (event) {
925 // Ensure there is a toggle, if there isn't float one in the top right
926 if (window.document.querySelector('.quarto-color-scheme-toggle') === null) {
927 const a = window.document.createElement('a');
928 a.classList.add('top-right');
929 a.classList.add('quarto-color-scheme-toggle');
930 a.href = "";
931 a.onclick = function() { try { window.quartoToggleColorScheme(); } catch {} return false; };
932 const i = window.document.createElement("i");
933 i.classList.add('bi');
934 a.appendChild(i);
935 window.document.body.appendChild(a);
936 }
937 setColorSchemeToggle(hasAlternateSentinel())
938 const icon = "";
939 const anchorJS = new window.AnchorJS();
940 anchorJS.options = {
941 placement: 'right',
942 icon: icon
943 };
944 anchorJS.add('.anchored');
945 const isCodeAnnotation = (el) => {
946 for (const clz of el.classList) {
947 if (clz.startsWith('code-annotation-')) {
948 return true;
949 }
950 }
951 return false;
952 }
953 const onCopySuccess = function(e) {
954 // button target
955 const button = e.trigger;
956 // don't keep focus
957 button.blur();
958 // flash "checked"
959 button.classList.add('code-copy-button-checked');
960 var currentTitle = button.getAttribute("title");
961 button.setAttribute("title", "Copied!");
962 let tooltip;
963 if (window.bootstrap) {
964 button.setAttribute("data-bs-toggle", "tooltip");
965 button.setAttribute("data-bs-placement", "left");
966 button.setAttribute("data-bs-title", "Copied!");
967 tooltip = new bootstrap.Tooltip(button,
968 { trigger: "manual",
969 customClass: "code-copy-button-tooltip",
970 offset: [0, -8]});
971 tooltip.show();
972 }
973 setTimeout(function() {
974 if (tooltip) {
975 tooltip.hide();
976 button.removeAttribute("data-bs-title");
977 button.removeAttribute("data-bs-toggle");
978 button.removeAttribute("data-bs-placement");
979 }
980 button.setAttribute("title", currentTitle);
981 button.classList.remove('code-copy-button-checked');
982 }, 1000);
983 // clear code selection
984 e.clearSelection();
985 }
986 const getTextToCopy = function(trigger) {
987 const codeEl = trigger.previousElementSibling.cloneNode(true);
988 for (const childEl of codeEl.children) {
989 if (isCodeAnnotation(childEl)) {
990 childEl.remove();
991 }
992 }
993 return codeEl.innerText;
994 }
995 const clipboard = new window.ClipboardJS('.code-copy-button:not([data-in-quarto-modal])', {
996 text: getTextToCopy
997 });
998 clipboard.on('success', onCopySuccess);
999 if (window.document.getElementById('quarto-embedded-source-code-modal')) {
1000 const clipboardModal = new window.ClipboardJS('.code-copy-button[data-in-quarto-modal]', {
1001 text: getTextToCopy,
1002 container: window.document.getElementById('quarto-embedded-source-code-modal')
1003 });
1004 clipboardModal.on('success', onCopySuccess);
1005 }
1006 var localhostRegex = new RegExp(/^(?:http|https):\/\/localhost\:?[0-9]*\//);
1007 var mailtoRegex = new RegExp(/^mailto:/);
1008 var filterRegex = new RegExp("https:\/\/github\.com\/your-org\/atdata");
1009 var isInternal = (href) => {
1010 return filterRegex.test(href) || localhostRegex.test(href) || mailtoRegex.test(href);
1011 }
1012 // Inspect non-navigation links and adorn them if external
1013 var links = window.document.querySelectorAll('a[href]:not(.nav-link):not(.navbar-brand):not(.toc-action):not(.sidebar-link):not(.sidebar-item-toggle):not(.pagination-link):not(.no-external):not([aria-hidden]):not(.dropdown-item):not(.quarto-navigation-tool):not(.about-link)');
1014 for (var i=0; i<links.length; i++) {
1015 const link = links[i];
1016 if (!isInternal(link.href)) {
1017 // undo the damage that might have been done by quarto-nav.js in the case of
1018 // links that we want to consider external
1019 if (link.dataset.originalHref !== undefined) {
1020 link.href = link.dataset.originalHref;
1021 }
1022 }
1023 }
1024 function tippyHover(el, contentFn, onTriggerFn, onUntriggerFn) {
1025 const config = {
1026 allowHTML: true,
1027 maxWidth: 500,
1028 delay: 100,
1029 arrow: false,
1030 appendTo: function(el) {
1031 return el.parentElement;
1032 },
1033 interactive: true,
1034 interactiveBorder: 10,
1035 theme: 'quarto',
1036 placement: 'bottom-start',
1037 };
1038 if (contentFn) {
1039 config.content = contentFn;
1040 }
1041 if (onTriggerFn) {
1042 config.onTrigger = onTriggerFn;
1043 }
1044 if (onUntriggerFn) {
1045 config.onUntrigger = onUntriggerFn;
1046 }
1047 window.tippy(el, config);
1048 }
1049 const noterefs = window.document.querySelectorAll('a[role="doc-noteref"]');
1050 for (var i=0; i<noterefs.length; i++) {
1051 const ref = noterefs[i];
1052 tippyHover(ref, function() {
1053 // use id or data attribute instead here
1054 let href = ref.getAttribute('data-footnote-href') || ref.getAttribute('href');
1055 try { href = new URL(href).hash; } catch {}
1056 const id = href.replace(/^#\/?/, "");
1057 const note = window.document.getElementById(id);
1058 if (note) {
1059 return note.innerHTML;
1060 } else {
1061 return "";
1062 }
1063 });
1064 }
1065 const xrefs = window.document.querySelectorAll('a.quarto-xref');
1066 const processXRef = (id, note) => {
1067 // Strip column container classes
1068 const stripColumnClz = (el) => {
1069 el.classList.remove("page-full", "page-columns");
1070 if (el.children) {
1071 for (const child of el.children) {
1072 stripColumnClz(child);
1073 }
1074 }
1075 }
1076 stripColumnClz(note)
1077 if (id === null || id.startsWith('sec-')) {
1078 // Special case sections, only their first couple elements
1079 const container = document.createElement("div");
1080 if (note.children && note.children.length > 2) {
1081 container.appendChild(note.children[0].cloneNode(true));
1082 for (let i = 1; i < note.children.length; i++) {
1083 const child = note.children[i];
1084 if (child.tagName === "P" && child.innerText === "") {
1085 continue;
1086 } else {
1087 container.appendChild(child.cloneNode(true));
1088 break;
1089 }
1090 }
1091 if (window.Quarto?.typesetMath) {
1092 window.Quarto.typesetMath(container);
1093 }
1094 return container.innerHTML
1095 } else {
1096 if (window.Quarto?.typesetMath) {
1097 window.Quarto.typesetMath(note);
1098 }
1099 return note.innerHTML;
1100 }
1101 } else {
1102 // Remove any anchor links if they are present
1103 const anchorLink = note.querySelector('a.anchorjs-link');
1104 if (anchorLink) {
1105 anchorLink.remove();
1106 }
1107 if (window.Quarto?.typesetMath) {
1108 window.Quarto.typesetMath(note);
1109 }
1110 if (note.classList.contains("callout")) {
1111 return note.outerHTML;
1112 } else {
1113 return note.innerHTML;
1114 }
1115 }
1116 }
1117 for (var i=0; i<xrefs.length; i++) {
1118 const xref = xrefs[i];
1119 tippyHover(xref, undefined, function(instance) {
1120 instance.disable();
1121 let url = xref.getAttribute('href');
1122 let hash = undefined;
1123 if (url.startsWith('#')) {
1124 hash = url;
1125 } else {
1126 try { hash = new URL(url).hash; } catch {}
1127 }
1128 if (hash) {
1129 const id = hash.replace(/^#\/?/, "");
1130 const note = window.document.getElementById(id);
1131 if (note !== null) {
1132 try {
1133 const html = processXRef(id, note.cloneNode(true));
1134 instance.setContent(html);
1135 } finally {
1136 instance.enable();
1137 instance.show();
1138 }
1139 } else {
1140 // See if we can fetch this
1141 fetch(url.split('#')[0])
1142 .then(res => res.text())
1143 .then(html => {
1144 const parser = new DOMParser();
1145 const htmlDoc = parser.parseFromString(html, "text/html");
1146 const note = htmlDoc.getElementById(id);
1147 if (note !== null) {
1148 const html = processXRef(id, note);
1149 instance.setContent(html);
1150 }
1151 }).finally(() => {
1152 instance.enable();
1153 instance.show();
1154 });
1155 }
1156 } else {
1157 // See if we can fetch a full url (with no hash to target)
1158 // This is a special case and we should probably do some content thinning / targeting
1159 fetch(url)
1160 .then(res => res.text())
1161 .then(html => {
1162 const parser = new DOMParser();
1163 const htmlDoc = parser.parseFromString(html, "text/html");
1164 const note = htmlDoc.querySelector('main.content');
1165 if (note !== null) {
1166 // This should only happen for chapter cross references
1167 // (since there is no id in the URL)
1168 // remove the first header
1169 if (note.children.length > 0 && note.children[0].tagName === "HEADER") {
1170 note.children[0].remove();
1171 }
1172 const html = processXRef(null, note);
1173 instance.setContent(html);
1174 }
1175 }).finally(() => {
1176 instance.enable();
1177 instance.show();
1178 });
1179 }
1180 }, function(instance) {
1181 });
1182 }
1183 let selectedAnnoteEl;
1184 const selectorForAnnotation = ( cell, annotation) => {
1185 let cellAttr = 'data-code-cell="' + cell + '"';
1186 let lineAttr = 'data-code-annotation="' + annotation + '"';
1187 const selector = 'span[' + cellAttr + '][' + lineAttr + ']';
1188 return selector;
1189 }
1190 const selectCodeLines = (annoteEl) => {
1191 const doc = window.document;
1192 const targetCell = annoteEl.getAttribute("data-target-cell");
1193 const targetAnnotation = annoteEl.getAttribute("data-target-annotation");
1194 const annoteSpan = window.document.querySelector(selectorForAnnotation(targetCell, targetAnnotation));
1195 const lines = annoteSpan.getAttribute("data-code-lines").split(",");
1196 const lineIds = lines.map((line) => {
1197 return targetCell + "-" + line;
1198 })
1199 let top = null;
1200 let height = null;
1201 let parent = null;
1202 if (lineIds.length > 0) {
1203 //compute the position of the single el (top and bottom and make a div)
1204 const el = window.document.getElementById(lineIds[0]);
1205 top = el.offsetTop;
1206 height = el.offsetHeight;
1207 parent = el.parentElement.parentElement;
1208 if (lineIds.length > 1) {
1209 const lastEl = window.document.getElementById(lineIds[lineIds.length - 1]);
1210 const bottom = lastEl.offsetTop + lastEl.offsetHeight;
1211 height = bottom - top;
1212 }
1213 if (top !== null && height !== null && parent !== null) {
1214 // cook up a div (if necessary) and position it
1215 let div = window.document.getElementById("code-annotation-line-highlight");
1216 if (div === null) {
1217 div = window.document.createElement("div");
1218 div.setAttribute("id", "code-annotation-line-highlight");
1219 div.style.position = 'absolute';
1220 parent.appendChild(div);
1221 }
1222 div.style.top = top - 2 + "px";
1223 div.style.height = height + 4 + "px";
1224 div.style.left = 0;
1225 let gutterDiv = window.document.getElementById("code-annotation-line-highlight-gutter");
1226 if (gutterDiv === null) {
1227 gutterDiv = window.document.createElement("div");
1228 gutterDiv.setAttribute("id", "code-annotation-line-highlight-gutter");
1229 gutterDiv.style.position = 'absolute';
1230 const codeCell = window.document.getElementById(targetCell);
1231 const gutter = codeCell.querySelector('.code-annotation-gutter');
1232 gutter.appendChild(gutterDiv);
1233 }
1234 gutterDiv.style.top = top - 2 + "px";
1235 gutterDiv.style.height = height + 4 + "px";
1236 }
1237 selectedAnnoteEl = annoteEl;
1238 }
1239 };
1240 const unselectCodeLines = () => {
1241 const elementsIds = ["code-annotation-line-highlight", "code-annotation-line-highlight-gutter"];
1242 elementsIds.forEach((elId) => {
1243 const div = window.document.getElementById(elId);
1244 if (div) {
1245 div.remove();
1246 }
1247 });
1248 selectedAnnoteEl = undefined;
1249 };
1250 // Handle positioning of the toggle
1251 window.addEventListener(
1252 "resize",
1253 throttle(() => {
1254 elRect = undefined;
1255 if (selectedAnnoteEl) {
1256 selectCodeLines(selectedAnnoteEl);
1257 }
1258 }, 10)
1259 );
1260 function throttle(fn, ms) {
1261 let throttle = false;
1262 let timer;
1263 return (...args) => {
1264 if(!throttle) { // first call gets through
1265 fn.apply(this, args);
1266 throttle = true;
1267 } else { // all the others get throttled
1268 if(timer) clearTimeout(timer); // cancel #2
1269 timer = setTimeout(() => {
1270 fn.apply(this, args);
1271 timer = throttle = false;
1272 }, ms);
1273 }
1274 };
1275 }
1276 // Attach click handler to the DT
1277 const annoteDls = window.document.querySelectorAll('dt[data-target-cell]');
1278 for (const annoteDlNode of annoteDls) {
1279 annoteDlNode.addEventListener('click', (event) => {
1280 const clickedEl = event.target;
1281 if (clickedEl !== selectedAnnoteEl) {
1282 unselectCodeLines();
1283 const activeEl = window.document.querySelector('dt[data-target-cell].code-annotation-active');
1284 if (activeEl) {
1285 activeEl.classList.remove('code-annotation-active');
1286 }
1287 selectCodeLines(clickedEl);
1288 clickedEl.classList.add('code-annotation-active');
1289 } else {
1290 // Unselect the line
1291 unselectCodeLines();
1292 clickedEl.classList.remove('code-annotation-active');
1293 }
1294 });
1295 }
1296 const findCites = (el) => {
1297 const parentEl = el.parentElement;
1298 if (parentEl) {
1299 const cites = parentEl.dataset.cites;
1300 if (cites) {
1301 return {
1302 el,
1303 cites: cites.split(' ')
1304 };
1305 } else {
1306 return findCites(el.parentElement)
1307 }
1308 } else {
1309 return undefined;
1310 }
1311 };
1312 var bibliorefs = window.document.querySelectorAll('a[role="doc-biblioref"]');
1313 for (var i=0; i<bibliorefs.length; i++) {
1314 const ref = bibliorefs[i];
1315 const citeInfo = findCites(ref);
1316 if (citeInfo) {
1317 tippyHover(citeInfo.el, function() {
1318 var popup = window.document.createElement('div');
1319 citeInfo.cites.forEach(function(cite) {
1320 var citeDiv = window.document.createElement('div');
1321 citeDiv.classList.add('hanging-indent');
1322 citeDiv.classList.add('csl-entry');
1323 var biblioDiv = window.document.getElementById('ref-' + cite);
1324 if (biblioDiv) {
1325 citeDiv.innerHTML = biblioDiv.innerHTML;
1326 }
1327 popup.appendChild(citeDiv);
1328 });
1329 return popup.innerHTML;
1330 });
1331 }
1332 }
1333 });
1334 </script>
1335</div> <!-- /content -->
1336<footer class="footer">
1337 <div class="nav-footer">
1338 <div class="nav-footer-left">
1339<p>Built with <a href="https://quarto.org/">Quarto</a></p>
1340</div>
1341 <div class="nav-footer-center">
1342
1343 <div class="toc-actions d-sm-block d-md-none"><ul><li><a href="https://github.com/your-org/atdata/edit/main/reference/deployment.qmd" class="toc-action"><i class="bi bi-github"></i>Edit this page</a></li><li><a href="https://github.com/your-org/atdata/issues/new" class="toc-action"><i class="bi empty"></i>Report an issue</a></li></ul></div></div>
1344 <div class="nav-footer-right">
1345<p>MIT License</p>
1346</div>
1347 </div>
1348</footer>
1349
1350
1351
1352
1353</body></html>