PlanOpticon

planopticon / getting-started / configuration / index.html
Source Rendered
Blame History Raw 2261 lines
1
2
<!doctype html>
3
<html lang="en" class="no-js">
4
<head>
5
6
<meta charset="utf-8">
7
<meta name="viewport" content="width=device-width,initial-scale=1">
8
9
<meta name="description" content="AI-powered video analysis and knowledge extraction">
10
11
12
<meta name="author" content="CONFLICT LLC">
13
14
15
<link rel="canonical" href="https://planopticon.dev/getting-started/configuration/">
16
17
18
<link rel="prev" href="../quickstart/">
19
20
21
<link rel="next" href="../../guide/single-video/">
22
23
24
25
26
27
<link rel="icon" href="../../assets/images/favicon.png">
28
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.4">
29
30
31
32
<title>Configuration - PlanOpticon</title>
33
34
35
36
<link rel="stylesheet" href="../../assets/stylesheets/main.484c7ddc.min.css">
37
38
39
<link rel="stylesheet" href="../../assets/stylesheets/palette.ab4e12ef.min.css">
40
41
42
43
44
45
46
47
48
49
50
51
52
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
53
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
54
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
55
56
57
58
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
59
60
<link rel="stylesheet" href="../../assets/css/custom.css">
61
62
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
63
64
65
66
67
68
</head>
69
70
71
72
73
74
75
76
77
78
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="custom" data-md-color-accent="custom">
79
80
81
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
82
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
83
<label class="md-overlay" for="__drawer"></label>
84
<div data-md-component="skip">
85
86
87
<a href="#configuration" class="md-skip">
88
Skip to content
89
</a>
90
91
</div>
92
<div data-md-component="announce">
93
94
</div>
95
96
97
98
99
<header class="md-header" data-md-component="header">
100
<nav class="md-header__inner md-grid" aria-label="Header">
101
<a href="../.." title="PlanOpticon" class="md-header__button md-logo" aria-label="PlanOpticon" data-md-component="logo">
102
103
<img src="../../assets/images/conflict-logo.svg" alt="logo">
104
105
</a>
106
<label class="md-header__button md-icon" for="__drawer">
107
108
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
109
</label>
110
<div class="md-header__title" data-md-component="header-title">
111
<div class="md-header__ellipsis">
112
<div class="md-header__topic">
113
<span class="md-ellipsis">
114
PlanOpticon
115
</span>
116
</div>
117
<div class="md-header__topic" data-md-component="header-topic">
118
<span class="md-ellipsis">
119
120
Configuration
121
122
</span>
123
</div>
124
</div>
125
</div>
126
127
128
<form class="md-header__option" data-md-component="palette">
129
130
131
132
133
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="custom" data-md-color-accent="custom" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_0">
134
135
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
136
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
137
</label>
138
139
140
141
142
143
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="custom" data-md-color-accent="custom" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
144
145
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_0" hidden>
146
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
147
</label>
148
149
150
</form>
151
152
153
154
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
155
156
157
158
159
160
<label class="md-header__button md-icon" for="__search">
161
162
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
163
</label>
164
<div class="md-search" data-md-component="search" role="dialog">
165
<label class="md-search__overlay" for="__search"></label>
166
<div class="md-search__inner" role="search">
167
<form class="md-search__form" name="search">
168
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
169
<label class="md-search__icon md-icon" for="__search">
170
171
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
172
173
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
174
</label>
175
<nav class="md-search__options" aria-label="Search">
176
177
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
178
179
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
180
</button>
181
</nav>
182
183
<div class="md-search__suggest" data-md-component="search-suggest"></div>
184
185
</form>
186
<div class="md-search__output">
187
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
188
<div class="md-search-result" data-md-component="search-result">
189
<div class="md-search-result__meta">
190
Initializing search
191
</div>
192
<ol class="md-search-result__list" role="presentation"></ol>
193
</div>
194
</div>
195
</div>
196
</div>
197
</div>
198
199
200
201
<div class="md-header__source">
202
<a href="https://github.com/ConflictHQ/PlanOpticon" title="Go to repository" class="md-source" data-md-component="source">
203
<div class="md-source__icon md-icon">
204
205
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
206
</div>
207
<div class="md-source__repository">
208
ConflictHQ/PlanOpticon
209
</div>
210
</a>
211
</div>
212
213
</nav>
214
215
</header>
216
217
<div class="md-container" data-md-component="container">
218
219
220
221
222
223
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
224
<div class="md-grid">
225
<ul class="md-tabs__list">
226
227
228
229
230
231
232
<li class="md-tabs__item">
233
<a href="../.." class="md-tabs__link">
234
235
236
237
238
239
Home
240
241
</a>
242
</li>
243
244
245
246
247
248
249
250
251
252
253
254
255
<li class="md-tabs__item md-tabs__item--active">
256
<a href="../installation/" class="md-tabs__link">
257
258
259
260
Getting Started
261
262
</a>
263
</li>
264
265
266
267
268
269
270
271
272
273
274
275
<li class="md-tabs__item">
276
<a href="../../guide/single-video/" class="md-tabs__link">
277
278
279
280
User Guide
281
282
</a>
283
</li>
284
285
286
287
288
289
290
291
292
293
<li class="md-tabs__item">
294
<a href="../../use-cases/" class="md-tabs__link">
295
296
297
298
299
300
Use Cases
301
302
</a>
303
</li>
304
305
306
307
308
309
310
311
312
<li class="md-tabs__item">
313
<a href="../../cli-reference/" class="md-tabs__link">
314
315
316
317
318
319
CLI Reference
320
321
</a>
322
</li>
323
324
325
326
327
328
329
330
331
332
333
<li class="md-tabs__item">
334
<a href="../../architecture/overview/" class="md-tabs__link">
335
336
337
338
Architecture
339
340
</a>
341
</li>
342
343
344
345
346
347
348
349
350
351
352
353
<li class="md-tabs__item">
354
<a href="../../api/models/" class="md-tabs__link">
355
356
357
358
API Reference
359
360
</a>
361
</li>
362
363
364
365
366
367
368
369
370
371
<li class="md-tabs__item">
372
<a href="../../faq/" class="md-tabs__link">
373
374
375
376
377
378
FAQ & Troubleshooting
379
380
</a>
381
</li>
382
383
384
385
386
387
388
389
390
<li class="md-tabs__item">
391
<a href="../../contributing/" class="md-tabs__link">
392
393
394
395
396
397
Contributing
398
399
</a>
400
</li>
401
402
403
404
</ul>
405
</div>
406
</nav>
407
408
409
410
<main class="md-main" data-md-component="main">
411
<div class="md-main__inner md-grid">
412
413
414
415
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
416
<div class="md-sidebar__scrollwrap">
417
<div class="md-sidebar__inner">
418
419
420
421
422
423
424
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
425
<label class="md-nav__title" for="__drawer">
426
<a href="../.." title="PlanOpticon" class="md-nav__button md-logo" aria-label="PlanOpticon" data-md-component="logo">
427
428
<img src="../../assets/images/conflict-logo.svg" alt="logo">
429
430
</a>
431
PlanOpticon
432
</label>
433
434
<div class="md-nav__source">
435
<a href="https://github.com/ConflictHQ/PlanOpticon" title="Go to repository" class="md-source" data-md-component="source">
436
<div class="md-source__icon md-icon">
437
438
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
439
</div>
440
<div class="md-source__repository">
441
ConflictHQ/PlanOpticon
442
</div>
443
</a>
444
</div>
445
446
<ul class="md-nav__list" data-md-scrollfix>
447
448
449
450
451
452
453
454
<li class="md-nav__item">
455
<a href="../.." class="md-nav__link">
456
457
458
459
<span class="md-ellipsis">
460
461
462
Home
463
464
465
466
</span>
467
468
469
470
</a>
471
</li>
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
497
498
499
500
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
501
502
503
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
504
505
506
507
<span class="md-ellipsis">
508
509
510
Getting Started
511
512
513
514
</span>
515
516
517
518
<span class="md-nav__icon md-icon"></span>
519
</label>
520
521
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
522
<label class="md-nav__title" for="__nav_2">
523
<span class="md-nav__icon md-icon"></span>
524
525
526
Getting Started
527
528
529
</label>
530
<ul class="md-nav__list" data-md-scrollfix>
531
532
533
534
535
536
537
538
<li class="md-nav__item">
539
<a href="../installation/" class="md-nav__link">
540
541
542
543
<span class="md-ellipsis">
544
545
546
Installation
547
548
549
550
</span>
551
552
553
554
</a>
555
</li>
556
557
558
559
560
561
562
563
564
565
566
<li class="md-nav__item">
567
<a href="../quickstart/" class="md-nav__link">
568
569
570
571
<span class="md-ellipsis">
572
573
574
Quick Start
575
576
577
578
</span>
579
580
581
582
</a>
583
</li>
584
585
586
587
588
589
590
591
592
593
594
595
596
<li class="md-nav__item md-nav__item--active">
597
598
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
599
600
601
602
603
604
<label class="md-nav__link md-nav__link--active" for="__toc">
605
606
607
608
<span class="md-ellipsis">
609
610
611
Configuration
612
613
614
615
</span>
616
617
618
619
<span class="md-nav__icon md-icon"></span>
620
</label>
621
622
<a href="./" class="md-nav__link md-nav__link--active">
623
624
625
626
<span class="md-ellipsis">
627
628
629
Configuration
630
631
632
633
</span>
634
635
636
637
</a>
638
639
640
641
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
642
643
644
645
646
647
648
<label class="md-nav__title" for="__toc">
649
<span class="md-nav__icon md-icon"></span>
650
Table of contents
651
</label>
652
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
653
654
<li class="md-nav__item">
655
<a href="#example-env-file" class="md-nav__link">
656
<span class="md-ellipsis">
657
658
Example .env file
659
660
</span>
661
</a>
662
663
</li>
664
665
<li class="md-nav__item">
666
<a href="#environment-variables-reference" class="md-nav__link">
667
<span class="md-ellipsis">
668
669
Environment variables reference
670
671
</span>
672
</a>
673
674
<nav class="md-nav" aria-label="Environment variables reference">
675
<ul class="md-nav__list">
676
677
<li class="md-nav__item">
678
<a href="#ai-providers" class="md-nav__link">
679
<span class="md-ellipsis">
680
681
AI providers
682
683
</span>
684
</a>
685
686
</li>
687
688
<li class="md-nav__item">
689
<a href="#cloud-services" class="md-nav__link">
690
<span class="md-ellipsis">
691
692
Cloud services
693
694
</span>
695
</a>
696
697
</li>
698
699
<li class="md-nav__item">
700
<a href="#general" class="md-nav__link">
701
<span class="md-ellipsis">
702
703
General
704
705
</span>
706
</a>
707
708
</li>
709
710
</ul>
711
</nav>
712
713
</li>
714
715
<li class="md-nav__item">
716
<a href="#authentication" class="md-nav__link">
717
<span class="md-ellipsis">
718
719
Authentication
720
721
</span>
722
</a>
723
724
<nav class="md-nav" aria-label="Authentication">
725
<ul class="md-nav__list">
726
727
<li class="md-nav__item">
728
<a href="#what-each-service-needs" class="md-nav__link">
729
<span class="md-ellipsis">
730
731
What each service needs
732
733
</span>
734
</a>
735
736
</li>
737
738
</ul>
739
</nav>
740
741
</li>
742
743
<li class="md-nav__item">
744
<a href="#provider-routing" class="md-nav__link">
745
<span class="md-ellipsis">
746
747
Provider routing
748
749
</span>
750
</a>
751
752
</li>
753
754
<li class="md-nav__item">
755
<a href="#frame-sampling" class="md-nav__link">
756
<span class="md-ellipsis">
757
758
Frame sampling
759
760
</span>
761
</a>
762
763
</li>
764
765
<li class="md-nav__item">
766
<a href="#focus-areas" class="md-nav__link">
767
<span class="md-ellipsis">
768
769
Focus areas
770
771
</span>
772
</a>
773
774
</li>
775
776
<li class="md-nav__item">
777
<a href="#gpu-acceleration" class="md-nav__link">
778
<span class="md-ellipsis">
779
780
GPU acceleration
781
782
</span>
783
</a>
784
785
</li>
786
787
</ul>
788
789
</nav>
790
791
</li>
792
793
794
795
796
</ul>
797
</nav>
798
799
</li>
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
<li class="md-nav__item md-nav__item--nested">
820
821
822
823
824
825
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
826
827
828
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
829
830
831
832
<span class="md-ellipsis">
833
834
835
User Guide
836
837
838
839
</span>
840
841
842
843
<span class="md-nav__icon md-icon"></span>
844
</label>
845
846
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
847
<label class="md-nav__title" for="__nav_3">
848
<span class="md-nav__icon md-icon"></span>
849
850
851
User Guide
852
853
854
</label>
855
<ul class="md-nav__list" data-md-scrollfix>
856
857
858
859
860
861
862
863
<li class="md-nav__item">
864
<a href="../../guide/single-video/" class="md-nav__link">
865
866
867
868
<span class="md-ellipsis">
869
870
871
Single Video Analysis
872
873
874
875
</span>
876
877
878
879
</a>
880
</li>
881
882
883
884
885
886
887
888
889
890
891
<li class="md-nav__item">
892
<a href="../../guide/batch/" class="md-nav__link">
893
894
895
896
<span class="md-ellipsis">
897
898
899
Batch Processing
900
901
902
903
</span>
904
905
906
907
</a>
908
</li>
909
910
911
912
913
914
915
916
917
918
919
<li class="md-nav__item">
920
<a href="../../guide/document-ingestion/" class="md-nav__link">
921
922
923
924
<span class="md-ellipsis">
925
926
927
Document Ingestion
928
929
930
931
</span>
932
933
934
935
</a>
936
</li>
937
938
939
940
941
942
943
944
945
946
947
<li class="md-nav__item">
948
<a href="../../guide/cloud-sources/" class="md-nav__link">
949
950
951
952
<span class="md-ellipsis">
953
954
955
Cloud Sources
956
957
958
959
</span>
960
961
962
963
</a>
964
</li>
965
966
967
968
969
970
971
972
973
974
975
<li class="md-nav__item">
976
<a href="../../guide/knowledge-graphs/" class="md-nav__link">
977
978
979
980
<span class="md-ellipsis">
981
982
983
Knowledge Graphs
984
985
986
987
</span>
988
989
990
991
</a>
992
</li>
993
994
995
996
997
998
999
1000
1001
1002
1003
<li class="md-nav__item">
1004
<a href="../../guide/companion/" class="md-nav__link">
1005
1006
1007
1008
<span class="md-ellipsis">
1009
1010
1011
Interactive Companion
1012
1013
1014
1015
</span>
1016
1017
1018
1019
</a>
1020
</li>
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
<li class="md-nav__item">
1032
<a href="../../guide/planning-agent/" class="md-nav__link">
1033
1034
1035
1036
<span class="md-ellipsis">
1037
1038
1039
Planning Agent
1040
1041
1042
1043
</span>
1044
1045
1046
1047
</a>
1048
</li>
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
<li class="md-nav__item">
1060
<a href="../../guide/authentication/" class="md-nav__link">
1061
1062
1063
1064
<span class="md-ellipsis">
1065
1066
1067
Authentication
1068
1069
1070
1071
</span>
1072
1073
1074
1075
</a>
1076
</li>
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
<li class="md-nav__item">
1088
<a href="../../guide/export/" class="md-nav__link">
1089
1090
1091
1092
<span class="md-ellipsis">
1093
1094
1095
Export & Documents
1096
1097
1098
1099
</span>
1100
1101
1102
1103
</a>
1104
</li>
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
<li class="md-nav__item">
1116
<a href="../../guide/output-formats/" class="md-nav__link">
1117
1118
1119
1120
<span class="md-ellipsis">
1121
1122
1123
Output Formats
1124
1125
1126
1127
</span>
1128
1129
1130
1131
</a>
1132
</li>
1133
1134
1135
1136
1137
</ul>
1138
</nav>
1139
1140
</li>
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
<li class="md-nav__item">
1151
<a href="../../use-cases/" class="md-nav__link">
1152
1153
1154
1155
<span class="md-ellipsis">
1156
1157
1158
Use Cases
1159
1160
1161
1162
</span>
1163
1164
1165
1166
</a>
1167
</li>
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
<li class="md-nav__item">
1178
<a href="../../cli-reference/" class="md-nav__link">
1179
1180
1181
1182
<span class="md-ellipsis">
1183
1184
1185
CLI Reference
1186
1187
1188
1189
</span>
1190
1191
1192
1193
</a>
1194
</li>
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
<li class="md-nav__item md-nav__item--nested">
1215
1216
1217
1218
1219
1220
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
1221
1222
1223
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
1224
1225
1226
1227
<span class="md-ellipsis">
1228
1229
1230
Architecture
1231
1232
1233
1234
</span>
1235
1236
1237
1238
<span class="md-nav__icon md-icon"></span>
1239
</label>
1240
1241
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
1242
<label class="md-nav__title" for="__nav_6">
1243
<span class="md-nav__icon md-icon"></span>
1244
1245
1246
Architecture
1247
1248
1249
</label>
1250
<ul class="md-nav__list" data-md-scrollfix>
1251
1252
1253
1254
1255
1256
1257
1258
<li class="md-nav__item">
1259
<a href="../../architecture/overview/" class="md-nav__link">
1260
1261
1262
1263
<span class="md-ellipsis">
1264
1265
1266
Overview
1267
1268
1269
1270
</span>
1271
1272
1273
1274
</a>
1275
</li>
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
<li class="md-nav__item">
1287
<a href="../../architecture/providers/" class="md-nav__link">
1288
1289
1290
1291
<span class="md-ellipsis">
1292
1293
1294
Provider System
1295
1296
1297
1298
</span>
1299
1300
1301
1302
</a>
1303
</li>
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
<li class="md-nav__item">
1315
<a href="../../architecture/pipeline/" class="md-nav__link">
1316
1317
1318
1319
<span class="md-ellipsis">
1320
1321
1322
Processing Pipeline
1323
1324
1325
1326
</span>
1327
1328
1329
1330
</a>
1331
</li>
1332
1333
1334
1335
1336
</ul>
1337
</nav>
1338
1339
</li>
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
<li class="md-nav__item md-nav__item--nested">
1360
1361
1362
1363
1364
1365
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
1366
1367
1368
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
1369
1370
1371
1372
<span class="md-ellipsis">
1373
1374
1375
API Reference
1376
1377
1378
1379
</span>
1380
1381
1382
1383
<span class="md-nav__icon md-icon"></span>
1384
</label>
1385
1386
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
1387
<label class="md-nav__title" for="__nav_7">
1388
<span class="md-nav__icon md-icon"></span>
1389
1390
1391
API Reference
1392
1393
1394
</label>
1395
<ul class="md-nav__list" data-md-scrollfix>
1396
1397
1398
1399
1400
1401
1402
1403
<li class="md-nav__item">
1404
<a href="../../api/models/" class="md-nav__link">
1405
1406
1407
1408
<span class="md-ellipsis">
1409
1410
1411
Models
1412
1413
1414
1415
</span>
1416
1417
1418
1419
</a>
1420
</li>
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
<li class="md-nav__item">
1432
<a href="../../api/providers/" class="md-nav__link">
1433
1434
1435
1436
<span class="md-ellipsis">
1437
1438
1439
Providers
1440
1441
1442
1443
</span>
1444
1445
1446
1447
</a>
1448
</li>
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
<li class="md-nav__item">
1460
<a href="../../api/analyzers/" class="md-nav__link">
1461
1462
1463
1464
<span class="md-ellipsis">
1465
1466
1467
Analyzers
1468
1469
1470
1471
</span>
1472
1473
1474
1475
</a>
1476
</li>
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
<li class="md-nav__item">
1488
<a href="../../api/agent/" class="md-nav__link">
1489
1490
1491
1492
<span class="md-ellipsis">
1493
1494
1495
Agent & Skills
1496
1497
1498
1499
</span>
1500
1501
1502
1503
</a>
1504
</li>
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
<li class="md-nav__item">
1516
<a href="../../api/sources/" class="md-nav__link">
1517
1518
1519
1520
<span class="md-ellipsis">
1521
1522
1523
Sources
1524
1525
1526
1527
</span>
1528
1529
1530
1531
</a>
1532
</li>
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
<li class="md-nav__item">
1544
<a href="../../api/auth/" class="md-nav__link">
1545
1546
1547
1548
<span class="md-ellipsis">
1549
1550
1551
Authentication
1552
1553
1554
1555
</span>
1556
1557
1558
1559
</a>
1560
</li>
1561
1562
1563
1564
1565
</ul>
1566
</nav>
1567
1568
</li>
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
<li class="md-nav__item">
1579
<a href="../../faq/" class="md-nav__link">
1580
1581
1582
1583
<span class="md-ellipsis">
1584
1585
1586
FAQ & Troubleshooting
1587
1588
1589
1590
</span>
1591
1592
1593
1594
</a>
1595
</li>
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
<li class="md-nav__item">
1606
<a href="../../contributing/" class="md-nav__link">
1607
1608
1609
1610
<span class="md-ellipsis">
1611
1612
1613
Contributing
1614
1615
1616
1617
</span>
1618
1619
1620
1621
</a>
1622
</li>
1623
1624
1625
1626
</ul>
1627
</nav>
1628
</div>
1629
</div>
1630
</div>
1631
1632
1633
1634
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1635
<div class="md-sidebar__scrollwrap">
1636
<div class="md-sidebar__inner">
1637
1638
1639
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1640
1641
1642
1643
1644
1645
1646
<label class="md-nav__title" for="__toc">
1647
<span class="md-nav__icon md-icon"></span>
1648
Table of contents
1649
</label>
1650
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1651
1652
<li class="md-nav__item">
1653
<a href="#example-env-file" class="md-nav__link">
1654
<span class="md-ellipsis">
1655
1656
Example .env file
1657
1658
</span>
1659
</a>
1660
1661
</li>
1662
1663
<li class="md-nav__item">
1664
<a href="#environment-variables-reference" class="md-nav__link">
1665
<span class="md-ellipsis">
1666
1667
Environment variables reference
1668
1669
</span>
1670
</a>
1671
1672
<nav class="md-nav" aria-label="Environment variables reference">
1673
<ul class="md-nav__list">
1674
1675
<li class="md-nav__item">
1676
<a href="#ai-providers" class="md-nav__link">
1677
<span class="md-ellipsis">
1678
1679
AI providers
1680
1681
</span>
1682
</a>
1683
1684
</li>
1685
1686
<li class="md-nav__item">
1687
<a href="#cloud-services" class="md-nav__link">
1688
<span class="md-ellipsis">
1689
1690
Cloud services
1691
1692
</span>
1693
</a>
1694
1695
</li>
1696
1697
<li class="md-nav__item">
1698
<a href="#general" class="md-nav__link">
1699
<span class="md-ellipsis">
1700
1701
General
1702
1703
</span>
1704
</a>
1705
1706
</li>
1707
1708
</ul>
1709
</nav>
1710
1711
</li>
1712
1713
<li class="md-nav__item">
1714
<a href="#authentication" class="md-nav__link">
1715
<span class="md-ellipsis">
1716
1717
Authentication
1718
1719
</span>
1720
</a>
1721
1722
<nav class="md-nav" aria-label="Authentication">
1723
<ul class="md-nav__list">
1724
1725
<li class="md-nav__item">
1726
<a href="#what-each-service-needs" class="md-nav__link">
1727
<span class="md-ellipsis">
1728
1729
What each service needs
1730
1731
</span>
1732
</a>
1733
1734
</li>
1735
1736
</ul>
1737
</nav>
1738
1739
</li>
1740
1741
<li class="md-nav__item">
1742
<a href="#provider-routing" class="md-nav__link">
1743
<span class="md-ellipsis">
1744
1745
Provider routing
1746
1747
</span>
1748
</a>
1749
1750
</li>
1751
1752
<li class="md-nav__item">
1753
<a href="#frame-sampling" class="md-nav__link">
1754
<span class="md-ellipsis">
1755
1756
Frame sampling
1757
1758
</span>
1759
</a>
1760
1761
</li>
1762
1763
<li class="md-nav__item">
1764
<a href="#focus-areas" class="md-nav__link">
1765
<span class="md-ellipsis">
1766
1767
Focus areas
1768
1769
</span>
1770
</a>
1771
1772
</li>
1773
1774
<li class="md-nav__item">
1775
<a href="#gpu-acceleration" class="md-nav__link">
1776
<span class="md-ellipsis">
1777
1778
GPU acceleration
1779
1780
</span>
1781
</a>
1782
1783
</li>
1784
1785
</ul>
1786
1787
</nav>
1788
</div>
1789
</div>
1790
</div>
1791
1792
1793
1794
<div class="md-content" data-md-component="content">
1795
1796
<article class="md-content__inner md-typeset">
1797
1798
1799
1800
1801
1802
1803
1804
1805
<h1 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">&para;</a></h1>
1806
<h2 id="example-env-file">Example <code>.env</code> file<a class="headerlink" href="#example-env-file" title="Permanent link">&para;</a></h2>
1807
<p>Create a <code>.env</code> file in your project directory. PlanOpticon loads it automatically.</p>
1808
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="c1"># =============================================================================</span>
1809
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="c1"># PlanOpticon Configuration</span>
1810
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="c1"># =============================================================================</span>
1811
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="c1"># Copy this file to .env and fill in the values you need.</span>
1812
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="c1"># You only need ONE AI provider — PlanOpticon auto-detects which are available.</span>
1813
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a>
1814
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="c1"># --- AI Providers (set at least one) ----------------------------------------</span>
1815
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a>
1816
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="c1"># OpenAI — get your key at https://platform.openai.com/api-keys</span>
1817
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="nv">OPENAI_API_KEY</span><span class="o">=</span>sk-...
1818
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a>
1819
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a><span class="c1"># Anthropic — get your key at https://console.anthropic.com/settings/keys</span>
1820
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a><span class="nv">ANTHROPIC_API_KEY</span><span class="o">=</span>sk-ant-...
1821
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a>
1822
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a><span class="c1"># Google Gemini — get your key at https://aistudio.google.com/apikey</span>
1823
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a><span class="nv">GEMINI_API_KEY</span><span class="o">=</span>AI...
1824
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a>
1825
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a><span class="c1"># Azure OpenAI — from your Azure portal deployment</span>
1826
<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a><span class="c1"># AZURE_OPENAI_API_KEY=...</span>
1827
<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a><span class="c1"># AZURE_OPENAI_ENDPOINT=https://your-resource.openai.azure.com/</span>
1828
<a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a>
1829
<a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a><span class="c1"># Together AI — https://api.together.xyz/settings/api-keys</span>
1830
<a id="__codelineno-0-23" name="__codelineno-0-23" href="#__codelineno-0-23"></a><span class="c1"># TOGETHER_API_KEY=...</span>
1831
<a id="__codelineno-0-24" name="__codelineno-0-24" href="#__codelineno-0-24"></a>
1832
<a id="__codelineno-0-25" name="__codelineno-0-25" href="#__codelineno-0-25"></a><span class="c1"># Fireworks AI — https://fireworks.ai/account/api-keys</span>
1833
<a id="__codelineno-0-26" name="__codelineno-0-26" href="#__codelineno-0-26"></a><span class="c1"># FIREWORKS_API_KEY=...</span>
1834
<a id="__codelineno-0-27" name="__codelineno-0-27" href="#__codelineno-0-27"></a>
1835
<a id="__codelineno-0-28" name="__codelineno-0-28" href="#__codelineno-0-28"></a><span class="c1"># Cerebras — https://cloud.cerebras.ai/</span>
1836
<a id="__codelineno-0-29" name="__codelineno-0-29" href="#__codelineno-0-29"></a><span class="c1"># CEREBRAS_API_KEY=...</span>
1837
<a id="__codelineno-0-30" name="__codelineno-0-30" href="#__codelineno-0-30"></a>
1838
<a id="__codelineno-0-31" name="__codelineno-0-31" href="#__codelineno-0-31"></a><span class="c1"># xAI (Grok) — https://console.x.ai/</span>
1839
<a id="__codelineno-0-32" name="__codelineno-0-32" href="#__codelineno-0-32"></a><span class="c1"># XAI_API_KEY=...</span>
1840
<a id="__codelineno-0-33" name="__codelineno-0-33" href="#__codelineno-0-33"></a>
1841
<a id="__codelineno-0-34" name="__codelineno-0-34" href="#__codelineno-0-34"></a><span class="c1"># Ollama (local, no key needed) — just run: ollama serve</span>
1842
<a id="__codelineno-0-35" name="__codelineno-0-35" href="#__codelineno-0-35"></a><span class="c1"># OLLAMA_HOST=http://localhost:11434</span>
1843
<a id="__codelineno-0-36" name="__codelineno-0-36" href="#__codelineno-0-36"></a>
1844
<a id="__codelineno-0-37" name="__codelineno-0-37" href="#__codelineno-0-37"></a><span class="c1"># --- Google (Drive, Docs, Sheets, Meet, YouTube) ----------------------------</span>
1845
<a id="__codelineno-0-38" name="__codelineno-0-38" href="#__codelineno-0-38"></a><span class="c1"># Option A: OAuth (interactive, recommended for personal use)</span>
1846
<a id="__codelineno-0-39" name="__codelineno-0-39" href="#__codelineno-0-39"></a><span class="c1"># Create credentials at https://console.cloud.google.com/apis/credentials</span>
1847
<a id="__codelineno-0-40" name="__codelineno-0-40" href="#__codelineno-0-40"></a><span class="c1"># 1. Create an OAuth 2.0 Client ID (Desktop application)</span>
1848
<a id="__codelineno-0-41" name="__codelineno-0-41" href="#__codelineno-0-41"></a><span class="c1"># 2. Enable these APIs: Google Drive API, Google Docs API</span>
1849
<a id="__codelineno-0-42" name="__codelineno-0-42" href="#__codelineno-0-42"></a><span class="nv">GOOGLE_CLIENT_ID</span><span class="o">=</span><span class="m">123456789</span>-abc.apps.googleusercontent.com
1850
<a id="__codelineno-0-43" name="__codelineno-0-43" href="#__codelineno-0-43"></a><span class="nv">GOOGLE_CLIENT_SECRET</span><span class="o">=</span>GOCSPX-...
1851
<a id="__codelineno-0-44" name="__codelineno-0-44" href="#__codelineno-0-44"></a>
1852
<a id="__codelineno-0-45" name="__codelineno-0-45" href="#__codelineno-0-45"></a><span class="c1"># Option B: Service Account (automated/server-side)</span>
1853
<a id="__codelineno-0-46" name="__codelineno-0-46" href="#__codelineno-0-46"></a><span class="c1"># GOOGLE_APPLICATION_CREDENTIALS=/path/to/service-account.json</span>
1854
<a id="__codelineno-0-47" name="__codelineno-0-47" href="#__codelineno-0-47"></a>
1855
<a id="__codelineno-0-48" name="__codelineno-0-48" href="#__codelineno-0-48"></a><span class="c1"># --- Zoom (recordings) ------------------------------------------------------</span>
1856
<a id="__codelineno-0-49" name="__codelineno-0-49" href="#__codelineno-0-49"></a><span class="c1"># Create an OAuth app at https://marketplace.zoom.us/develop/create</span>
1857
<a id="__codelineno-0-50" name="__codelineno-0-50" href="#__codelineno-0-50"></a><span class="c1"># App type: &quot;General App&quot; with OAuth</span>
1858
<a id="__codelineno-0-51" name="__codelineno-0-51" href="#__codelineno-0-51"></a><span class="c1"># Scopes: cloud_recording:read:list_user_recordings, cloud_recording:read:recording</span>
1859
<a id="__codelineno-0-52" name="__codelineno-0-52" href="#__codelineno-0-52"></a><span class="nv">ZOOM_CLIENT_ID</span><span class="o">=</span>...
1860
<a id="__codelineno-0-53" name="__codelineno-0-53" href="#__codelineno-0-53"></a><span class="nv">ZOOM_CLIENT_SECRET</span><span class="o">=</span>...
1861
<a id="__codelineno-0-54" name="__codelineno-0-54" href="#__codelineno-0-54"></a><span class="c1"># For Server-to-Server (no browser needed):</span>
1862
<a id="__codelineno-0-55" name="__codelineno-0-55" href="#__codelineno-0-55"></a><span class="c1"># ZOOM_ACCOUNT_ID=...</span>
1863
<a id="__codelineno-0-56" name="__codelineno-0-56" href="#__codelineno-0-56"></a>
1864
<a id="__codelineno-0-57" name="__codelineno-0-57" href="#__codelineno-0-57"></a><span class="c1"># --- Microsoft 365 (OneDrive, SharePoint, Teams) ----------------------------</span>
1865
<a id="__codelineno-0-58" name="__codelineno-0-58" href="#__codelineno-0-58"></a><span class="c1"># Register an app at https://portal.azure.com/#view/Microsoft_AAD_RegisteredApps</span>
1866
<a id="__codelineno-0-59" name="__codelineno-0-59" href="#__codelineno-0-59"></a><span class="c1"># API permissions: OnlineMeetings.Read, Files.Read (delegated)</span>
1867
<a id="__codelineno-0-60" name="__codelineno-0-60" href="#__codelineno-0-60"></a><span class="nv">MICROSOFT_CLIENT_ID</span><span class="o">=</span>...
1868
<a id="__codelineno-0-61" name="__codelineno-0-61" href="#__codelineno-0-61"></a><span class="nv">MICROSOFT_CLIENT_SECRET</span><span class="o">=</span>...
1869
<a id="__codelineno-0-62" name="__codelineno-0-62" href="#__codelineno-0-62"></a>
1870
<a id="__codelineno-0-63" name="__codelineno-0-63" href="#__codelineno-0-63"></a><span class="c1"># --- Notion ------------------------------------------------------------------</span>
1871
<a id="__codelineno-0-64" name="__codelineno-0-64" href="#__codelineno-0-64"></a><span class="c1"># Option A: OAuth (create integration at https://www.notion.so/my-integrations)</span>
1872
<a id="__codelineno-0-65" name="__codelineno-0-65" href="#__codelineno-0-65"></a><span class="c1"># NOTION_CLIENT_ID=...</span>
1873
<a id="__codelineno-0-66" name="__codelineno-0-66" href="#__codelineno-0-66"></a><span class="c1"># NOTION_CLIENT_SECRET=...</span>
1874
<a id="__codelineno-0-67" name="__codelineno-0-67" href="#__codelineno-0-67"></a>
1875
<a id="__codelineno-0-68" name="__codelineno-0-68" href="#__codelineno-0-68"></a><span class="c1"># Option B: API key (simpler, from the same integrations page)</span>
1876
<a id="__codelineno-0-69" name="__codelineno-0-69" href="#__codelineno-0-69"></a><span class="nv">NOTION_API_KEY</span><span class="o">=</span>secret_...
1877
<a id="__codelineno-0-70" name="__codelineno-0-70" href="#__codelineno-0-70"></a>
1878
<a id="__codelineno-0-71" name="__codelineno-0-71" href="#__codelineno-0-71"></a><span class="c1"># --- GitHub ------------------------------------------------------------------</span>
1879
<a id="__codelineno-0-72" name="__codelineno-0-72" href="#__codelineno-0-72"></a><span class="c1"># Option A: Personal Access Token (simplest)</span>
1880
<a id="__codelineno-0-73" name="__codelineno-0-73" href="#__codelineno-0-73"></a><span class="c1"># Create at https://github.com/settings/tokens — needs &#39;repo&#39; scope</span>
1881
<a id="__codelineno-0-74" name="__codelineno-0-74" href="#__codelineno-0-74"></a><span class="nv">GITHUB_TOKEN</span><span class="o">=</span>ghp_...
1882
<a id="__codelineno-0-75" name="__codelineno-0-75" href="#__codelineno-0-75"></a>
1883
<a id="__codelineno-0-76" name="__codelineno-0-76" href="#__codelineno-0-76"></a><span class="c1"># Option B: OAuth App (for CI/automation)</span>
1884
<a id="__codelineno-0-77" name="__codelineno-0-77" href="#__codelineno-0-77"></a><span class="c1"># GITHUB_CLIENT_ID=...</span>
1885
<a id="__codelineno-0-78" name="__codelineno-0-78" href="#__codelineno-0-78"></a><span class="c1"># GITHUB_CLIENT_SECRET=...</span>
1886
<a id="__codelineno-0-79" name="__codelineno-0-79" href="#__codelineno-0-79"></a>
1887
<a id="__codelineno-0-80" name="__codelineno-0-80" href="#__codelineno-0-80"></a><span class="c1"># --- Dropbox -----------------------------------------------------------------</span>
1888
<a id="__codelineno-0-81" name="__codelineno-0-81" href="#__codelineno-0-81"></a><span class="c1"># Create an app at https://www.dropbox.com/developers/apps</span>
1889
<a id="__codelineno-0-82" name="__codelineno-0-82" href="#__codelineno-0-82"></a><span class="c1"># DROPBOX_APP_KEY=...</span>
1890
<a id="__codelineno-0-83" name="__codelineno-0-83" href="#__codelineno-0-83"></a><span class="c1"># DROPBOX_APP_SECRET=...</span>
1891
<a id="__codelineno-0-84" name="__codelineno-0-84" href="#__codelineno-0-84"></a><span class="c1"># Or use a long-lived access token:</span>
1892
<a id="__codelineno-0-85" name="__codelineno-0-85" href="#__codelineno-0-85"></a><span class="c1"># DROPBOX_ACCESS_TOKEN=...</span>
1893
<a id="__codelineno-0-86" name="__codelineno-0-86" href="#__codelineno-0-86"></a>
1894
<a id="__codelineno-0-87" name="__codelineno-0-87" href="#__codelineno-0-87"></a><span class="c1"># --- General -----------------------------------------------------------------</span>
1895
<a id="__codelineno-0-88" name="__codelineno-0-88" href="#__codelineno-0-88"></a><span class="c1"># CACHE_DIR=~/.cache/planopticon</span>
1896
</code></pre></div>
1897
<h2 id="environment-variables-reference">Environment variables reference<a class="headerlink" href="#environment-variables-reference" title="Permanent link">&para;</a></h2>
1898
<h3 id="ai-providers">AI providers<a class="headerlink" href="#ai-providers" title="Permanent link">&para;</a></h3>
1899
<table>
1900
<thead>
1901
<tr>
1902
<th>Variable</th>
1903
<th>Required</th>
1904
<th>Where to get it</th>
1905
</tr>
1906
</thead>
1907
<tbody>
1908
<tr>
1909
<td><code>OPENAI_API_KEY</code></td>
1910
<td>At least one provider</td>
1911
<td><a href="https://platform.openai.com/api-keys">platform.openai.com/api-keys</a></td>
1912
</tr>
1913
<tr>
1914
<td><code>ANTHROPIC_API_KEY</code></td>
1915
<td>At least one provider</td>
1916
<td><a href="https://console.anthropic.com/settings/keys">console.anthropic.com</a></td>
1917
</tr>
1918
<tr>
1919
<td><code>GEMINI_API_KEY</code></td>
1920
<td>At least one provider</td>
1921
<td><a href="https://aistudio.google.com/apikey">aistudio.google.com/apikey</a></td>
1922
</tr>
1923
<tr>
1924
<td><code>AZURE_OPENAI_API_KEY</code></td>
1925
<td>Optional</td>
1926
<td>Azure portal &gt; your OpenAI resource</td>
1927
</tr>
1928
<tr>
1929
<td><code>AZURE_OPENAI_ENDPOINT</code></td>
1930
<td>With Azure</td>
1931
<td>Azure portal &gt; your OpenAI resource</td>
1932
</tr>
1933
<tr>
1934
<td><code>TOGETHER_API_KEY</code></td>
1935
<td>Optional</td>
1936
<td><a href="https://api.together.xyz/settings/api-keys">api.together.xyz</a></td>
1937
</tr>
1938
<tr>
1939
<td><code>FIREWORKS_API_KEY</code></td>
1940
<td>Optional</td>
1941
<td><a href="https://fireworks.ai/account/api-keys">fireworks.ai</a></td>
1942
</tr>
1943
<tr>
1944
<td><code>CEREBRAS_API_KEY</code></td>
1945
<td>Optional</td>
1946
<td><a href="https://cloud.cerebras.ai/">cloud.cerebras.ai</a></td>
1947
</tr>
1948
<tr>
1949
<td><code>XAI_API_KEY</code></td>
1950
<td>Optional</td>
1951
<td><a href="https://console.x.ai/">console.x.ai</a></td>
1952
</tr>
1953
<tr>
1954
<td><code>OLLAMA_HOST</code></td>
1955
<td>Optional</td>
1956
<td>Default: <code>http://localhost:11434</code></td>
1957
</tr>
1958
</tbody>
1959
</table>
1960
<h3 id="cloud-services">Cloud services<a class="headerlink" href="#cloud-services" title="Permanent link">&para;</a></h3>
1961
<table>
1962
<thead>
1963
<tr>
1964
<th>Variable</th>
1965
<th>Service</th>
1966
<th>Auth method</th>
1967
</tr>
1968
</thead>
1969
<tbody>
1970
<tr>
1971
<td><code>GOOGLE_CLIENT_ID</code></td>
1972
<td>Google (Drive, Docs, Meet)</td>
1973
<td>OAuth</td>
1974
</tr>
1975
<tr>
1976
<td><code>GOOGLE_CLIENT_SECRET</code></td>
1977
<td>Google</td>
1978
<td>OAuth</td>
1979
</tr>
1980
<tr>
1981
<td><code>GOOGLE_APPLICATION_CREDENTIALS</code></td>
1982
<td>Google</td>
1983
<td>Service account</td>
1984
</tr>
1985
<tr>
1986
<td><code>ZOOM_CLIENT_ID</code></td>
1987
<td>Zoom</td>
1988
<td>OAuth</td>
1989
</tr>
1990
<tr>
1991
<td><code>ZOOM_CLIENT_SECRET</code></td>
1992
<td>Zoom</td>
1993
<td>OAuth</td>
1994
</tr>
1995
<tr>
1996
<td><code>ZOOM_ACCOUNT_ID</code></td>
1997
<td>Zoom</td>
1998
<td>Server-to-Server</td>
1999
</tr>
2000
<tr>
2001
<td><code>MICROSOFT_CLIENT_ID</code></td>
2002
<td>Microsoft 365</td>
2003
<td>OAuth</td>
2004
</tr>
2005
<tr>
2006
<td><code>MICROSOFT_CLIENT_SECRET</code></td>
2007
<td>Microsoft 365</td>
2008
<td>OAuth</td>
2009
</tr>
2010
<tr>
2011
<td><code>NOTION_CLIENT_ID</code></td>
2012
<td>Notion</td>
2013
<td>OAuth</td>
2014
</tr>
2015
<tr>
2016
<td><code>NOTION_CLIENT_SECRET</code></td>
2017
<td>Notion</td>
2018
<td>OAuth</td>
2019
</tr>
2020
<tr>
2021
<td><code>NOTION_API_KEY</code></td>
2022
<td>Notion</td>
2023
<td>API key</td>
2024
</tr>
2025
<tr>
2026
<td><code>GITHUB_CLIENT_ID</code></td>
2027
<td>GitHub</td>
2028
<td>OAuth</td>
2029
</tr>
2030
<tr>
2031
<td><code>GITHUB_CLIENT_SECRET</code></td>
2032
<td>GitHub</td>
2033
<td>OAuth</td>
2034
</tr>
2035
<tr>
2036
<td><code>GITHUB_TOKEN</code></td>
2037
<td>GitHub</td>
2038
<td>API key</td>
2039
</tr>
2040
<tr>
2041
<td><code>DROPBOX_APP_KEY</code></td>
2042
<td>Dropbox</td>
2043
<td>OAuth</td>
2044
</tr>
2045
<tr>
2046
<td><code>DROPBOX_APP_SECRET</code></td>
2047
<td>Dropbox</td>
2048
<td>OAuth</td>
2049
</tr>
2050
<tr>
2051
<td><code>DROPBOX_ACCESS_TOKEN</code></td>
2052
<td>Dropbox</td>
2053
<td>API key</td>
2054
</tr>
2055
</tbody>
2056
</table>
2057
<h3 id="general">General<a class="headerlink" href="#general" title="Permanent link">&para;</a></h3>
2058
<table>
2059
<thead>
2060
<tr>
2061
<th>Variable</th>
2062
<th>Description</th>
2063
</tr>
2064
</thead>
2065
<tbody>
2066
<tr>
2067
<td><code>CACHE_DIR</code></td>
2068
<td>Directory for API response caching</td>
2069
</tr>
2070
</tbody>
2071
</table>
2072
<h2 id="authentication">Authentication<a class="headerlink" href="#authentication" title="Permanent link">&para;</a></h2>
2073
<p>PlanOpticon uses OAuth for cloud services. Run <code>planopticon auth</code> once per service — tokens are saved locally and refreshed automatically.</p>
2074
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>planopticon<span class="w"> </span>auth<span class="w"> </span>google<span class="w"> </span><span class="c1"># Google Drive, Docs, Meet, YouTube</span>
2075
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>planopticon<span class="w"> </span>auth<span class="w"> </span>dropbox<span class="w"> </span><span class="c1"># Dropbox</span>
2076
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>planopticon<span class="w"> </span>auth<span class="w"> </span>zoom<span class="w"> </span><span class="c1"># Zoom recordings</span>
2077
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a>planopticon<span class="w"> </span>auth<span class="w"> </span>notion<span class="w"> </span><span class="c1"># Notion pages</span>
2078
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a>planopticon<span class="w"> </span>auth<span class="w"> </span>github<span class="w"> </span><span class="c1"># GitHub repos and wikis</span>
2079
<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a>planopticon<span class="w"> </span>auth<span class="w"> </span>microsoft<span class="w"> </span><span class="c1"># OneDrive, SharePoint, Teams</span>
2080
</code></pre></div>
2081
<p>Credentials are stored in <code>~/.planopticon/</code>. Use <code>planopticon auth SERVICE --logout</code> to remove them.</p>
2082
<h3 id="what-each-service-needs">What each service needs<a class="headerlink" href="#what-each-service-needs" title="Permanent link">&para;</a></h3>
2083
<table>
2084
<thead>
2085
<tr>
2086
<th>Service</th>
2087
<th>Minimum setup</th>
2088
<th>Full OAuth setup</th>
2089
</tr>
2090
</thead>
2091
<tbody>
2092
<tr>
2093
<td>Google</td>
2094
<td><code>GOOGLE_CLIENT_ID</code> + <code>GOOGLE_CLIENT_SECRET</code></td>
2095
<td>Create OAuth credentials in <a href="https://console.cloud.google.com/apis/credentials">Google Cloud Console</a></td>
2096
</tr>
2097
<tr>
2098
<td>Zoom</td>
2099
<td><code>ZOOM_CLIENT_ID</code> + <code>ZOOM_CLIENT_SECRET</code></td>
2100
<td>Create a General App at <a href="https://marketplace.zoom.us/develop/create">marketplace.zoom.us</a></td>
2101
</tr>
2102
<tr>
2103
<td>Microsoft</td>
2104
<td><code>MICROSOFT_CLIENT_ID</code> + <code>MICROSOFT_CLIENT_SECRET</code></td>
2105
<td>Register app in <a href="https://portal.azure.com/#view/Microsoft_AAD_RegisteredApps">Azure AD</a></td>
2106
</tr>
2107
<tr>
2108
<td>Notion</td>
2109
<td><code>NOTION_API_KEY</code> (simplest)</td>
2110
<td>Create integration at <a href="https://www.notion.so/my-integrations">notion.so/my-integrations</a></td>
2111
</tr>
2112
<tr>
2113
<td>GitHub</td>
2114
<td><code>GITHUB_TOKEN</code> (simplest)</td>
2115
<td>Create token at <a href="https://github.com/settings/tokens">github.com/settings/tokens</a></td>
2116
</tr>
2117
<tr>
2118
<td>Dropbox</td>
2119
<td><code>DROPBOX_APP_KEY</code> + <code>DROPBOX_APP_SECRET</code></td>
2120
<td>Create app at <a href="https://www.dropbox.com/developers/apps">dropbox.com/developers</a></td>
2121
</tr>
2122
</tbody>
2123
</table>
2124
<p>For detailed OAuth app creation walkthroughs, see the <a href="../../guide/authentication/">Authentication guide</a>.</p>
2125
<h2 id="provider-routing">Provider routing<a class="headerlink" href="#provider-routing" title="Permanent link">&para;</a></h2>
2126
<p>PlanOpticon auto-discovers available models and routes each task to the cheapest capable option:</p>
2127
<table>
2128
<thead>
2129
<tr>
2130
<th>Task</th>
2131
<th>Default preference</th>
2132
</tr>
2133
</thead>
2134
<tbody>
2135
<tr>
2136
<td>Vision (diagrams)</td>
2137
<td>Gemini Flash &gt; GPT-4o-mini &gt; Claude Haiku &gt; Ollama</td>
2138
</tr>
2139
<tr>
2140
<td>Chat (analysis)</td>
2141
<td>Claude Haiku &gt; GPT-4o-mini &gt; Gemini Flash &gt; Ollama</td>
2142
</tr>
2143
<tr>
2144
<td>Transcription</td>
2145
<td>Local Whisper &gt; Whisper-1 &gt; Gemini Flash</td>
2146
</tr>
2147
</tbody>
2148
</table>
2149
<p>Default models prioritize cost efficiency. For complex or high-stakes analysis, override with more capable models using <code>--chat-model</code> or <code>--vision-model</code>.</p>
2150
<p>If no cloud API keys are configured, PlanOpticon automatically falls back to Ollama when a local server is running. This enables fully offline operation when paired with local Whisper for transcription.</p>
2151
<p>Override with <code>--provider</code>, <code>--vision-model</code>, or <code>--chat-model</code> flags.</p>
2152
<h2 id="frame-sampling">Frame sampling<a class="headerlink" href="#frame-sampling" title="Permanent link">&para;</a></h2>
2153
<p>Control how frames are extracted:</p>
2154
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="c1"># Sample rate: frames per second (default: 0.5)</span>
2155
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a>planopticon<span class="w"> </span>analyze<span class="w"> </span>-i<span class="w"> </span>video.mp4<span class="w"> </span>-o<span class="w"> </span>./out<span class="w"> </span>--sampling-rate<span class="w"> </span><span class="m">1</span>.0
2156
<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a>
2157
<a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a><span class="c1"># Change threshold: visual difference needed to keep a frame (default: 0.15)</span>
2158
<a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a>planopticon<span class="w"> </span>analyze<span class="w"> </span>-i<span class="w"> </span>video.mp4<span class="w"> </span>-o<span class="w"> </span>./out<span class="w"> </span>--change-threshold<span class="w"> </span><span class="m">0</span>.1
2159
<a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a>
2160
<a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></a><span class="c1"># Periodic capture: capture a frame every N seconds regardless of change (default: 30)</span>
2161
<a id="__codelineno-2-8" name="__codelineno-2-8" href="#__codelineno-2-8"></a><span class="c1"># Useful for slow-evolving content like document scrolling</span>
2162
<a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a>planopticon<span class="w"> </span>analyze<span class="w"> </span>-i<span class="w"> </span>video.mp4<span class="w"> </span>-o<span class="w"> </span>./out<span class="w"> </span>--periodic-capture<span class="w"> </span><span class="m">15</span>
2163
<a id="__codelineno-2-10" name="__codelineno-2-10" href="#__codelineno-2-10"></a>
2164
<a id="__codelineno-2-11" name="__codelineno-2-11" href="#__codelineno-2-11"></a><span class="c1"># Disable periodic capture (rely only on change detection)</span>
2165
<a id="__codelineno-2-12" name="__codelineno-2-12" href="#__codelineno-2-12"></a>planopticon<span class="w"> </span>analyze<span class="w"> </span>-i<span class="w"> </span>video.mp4<span class="w"> </span>-o<span class="w"> </span>./out<span class="w"> </span>--periodic-capture<span class="w"> </span><span class="m">0</span>
2166
</code></pre></div>
2167
<p>Lower <code>change-threshold</code> = more frames kept. Higher <code>sampling-rate</code> = more candidates. Periodic capture catches content that changes too slowly for change detection (e.g., scrolling through a document during a screen share).</p>
2168
<p>People/webcam frames are automatically filtered out using face detection — no configuration needed.</p>
2169
<h2 id="focus-areas">Focus areas<a class="headerlink" href="#focus-areas" title="Permanent link">&para;</a></h2>
2170
<p>Limit processing to specific extraction types:</p>
2171
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>planopticon<span class="w"> </span>analyze<span class="w"> </span>-i<span class="w"> </span>video.mp4<span class="w"> </span>-o<span class="w"> </span>./out<span class="w"> </span>--focus<span class="w"> </span><span class="s2">&quot;diagrams,action-items&quot;</span>
2172
</code></pre></div>
2173
<h2 id="gpu-acceleration">GPU acceleration<a class="headerlink" href="#gpu-acceleration" title="Permanent link">&para;</a></h2>
2174
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>planopticon<span class="w"> </span>analyze<span class="w"> </span>-i<span class="w"> </span>video.mp4<span class="w"> </span>-o<span class="w"> </span>./out<span class="w"> </span>--use-gpu
2175
</code></pre></div>
2176
<p>Requires <code>planopticon[gpu]</code> extras installed.</p>
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
</article>
2191
</div>
2192
2193
2194
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
2195
2196
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
2197
</div>
2198
2199
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
2200
2201
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
2202
Back to top
2203
</button>
2204
2205
</main>
2206
2207
<footer class="md-footer">
2208
2209
<div class="md-footer-meta md-typeset">
2210
<div class="md-footer-meta__inner md-grid">
2211
<div class="md-copyright">
2212
2213
<div class="md-copyright__highlight">
2214
Copyright &copy; 2026 CONFLICT LLC
2215
</div>
2216
2217
2218
Made with
2219
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2220
Material for MkDocs
2221
</a>
2222
2223
</div>
2224
2225
2226
<div class="md-social">
2227
2228
2229
2230
2231
2232
2233
2234
2235
<a href="https://github.com/ConflictHQ/PlanOpticon" target="_blank" rel="noopener" title="github.com" class="md-social__link">
2236
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
2237
</a>
2238
2239
</div>
2240
2241
</div>
2242
</div>
2243
</footer>
2244
2245
</div>
2246
<div class="md-dialog" data-md-component="dialog">
2247
<div class="md-dialog__inner md-typeset"></div>
2248
</div>
2249
2250
2251
2252
2253
2254
<script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.instant", "navigation.tabs", "navigation.sections", "navigation.expand", "navigation.top", "search.suggest", "search.highlight", "content.code.copy", "content.tabs.link", "header.autohide"], "search": "../../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
2255
2256
2257
<script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
2258
2259
2260
</body>
2261
</html>

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button