FossilRepo

fossilrepo / site / architecture / overview / index.html
Source Rendered
Blame History Raw 1099 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="Self-hosted Fossil forge -- omnibus installer for production Fossil SCM hosting">
10
11
12
<meta name="author" content="CONFLICT LLC">
13
14
15
<link rel="canonical" href="https://fossilrepo.dev/architecture/overview/">
16
17
18
<link rel="prev" href="../../getting-started/first-repo/">
19
20
21
<link rel="next" href="../sync-bridge/">
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.6">
29
30
31
32
<title>Overview - Fossilrepo</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/css/custom.css">
59
60
<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>
61
62
63
64
65
66
</head>
67
68
69
70
71
72
73
74
75
76
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="custom" data-md-color-accent="custom">
77
78
79
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
80
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
81
<label class="md-overlay" for="__drawer"></label>
82
<div data-md-component="skip">
83
84
85
<a href="#architecture-overview" class="md-skip">
86
Skip to content
87
</a>
88
89
</div>
90
<div data-md-component="announce">
91
92
</div>
93
94
95
96
97
<header class="md-header" data-md-component="header">
98
<nav class="md-header__inner md-grid" aria-label="Header">
99
<a href="../.." title="Fossilrepo" class="md-header__button md-logo" aria-label="Fossilrepo" data-md-component="logo">
100
<div style="display: flex; align-items: center; gap: 0.6rem;">
101
<img src="../../assets/images/conflict-logo.svg" alt="CONFLICT" style="height: 1.4rem; width: auto;">
102
<img src="../../assets/images/fossilrepo-logo.svg" alt="Fossilrepo" style="height: 1.2rem; width: auto;">
103
</div>
104
</a>
105
<label class="md-header__button md-icon" for="__drawer">
106
107
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
108
</label>
109
<div class="md-header__title" data-md-component="header-title">
110
<div class="md-header__ellipsis">
111
<div class="md-header__topic">
112
<span class="md-ellipsis">
113
Fossilrepo
114
</span>
115
</div>
116
<div class="md-header__topic" data-md-component="header-topic">
117
<span class="md-ellipsis">
118
119
Overview
120
121
</span>
122
</div>
123
</div>
124
</div>
125
126
127
<form class="md-header__option" data-md-component="palette">
128
129
130
131
132
<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">
133
134
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
135
<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>
136
</label>
137
138
139
140
141
142
<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">
143
144
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_0" hidden>
145
<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>
146
</label>
147
148
149
</form>
150
151
152
153
<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>
154
155
156
157
158
159
<label class="md-header__button md-icon" for="__search">
160
161
<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>
162
</label>
163
<div class="md-search" data-md-component="search" role="dialog">
164
<label class="md-search__overlay" for="__search"></label>
165
<div class="md-search__inner" role="search">
166
<form class="md-search__form" name="search">
167
<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>
168
<label class="md-search__icon md-icon" for="__search">
169
170
<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>
171
172
<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>
173
</label>
174
<nav class="md-search__options" aria-label="Search">
175
176
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
177
178
<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>
179
</button>
180
</nav>
181
182
<div class="md-search__suggest" data-md-component="search-suggest"></div>
183
184
</form>
185
<div class="md-search__output">
186
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
187
<div class="md-search-result" data-md-component="search-result">
188
<div class="md-search-result__meta">
189
Initializing search
190
</div>
191
<ol class="md-search-result__list" role="presentation"></ol>
192
</div>
193
</div>
194
</div>
195
</div>
196
</div>
197
198
199
200
<div class="md-header__source">
201
<a href="https://github.com/ConflictHQ/fossilrepo" title="Go to repository" class="md-source" data-md-component="source">
202
<div class="md-source__icon md-icon">
203
204
<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>
205
</div>
206
<div class="md-source__repository">
207
ConflictHQ/fossilrepo
208
</div>
209
</a>
210
</div>
211
212
</nav>
213
214
</header>
215
216
<div class="md-container" data-md-component="container">
217
218
219
220
221
222
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
223
<div class="md-grid">
224
<ul class="md-tabs__list">
225
226
227
228
229
230
231
<li class="md-tabs__item">
232
<a href="../.." class="md-tabs__link">
233
234
235
236
237
238
Home
239
240
</a>
241
</li>
242
243
244
245
246
247
248
249
250
251
252
<li class="md-tabs__item">
253
<a href="../../getting-started/prerequisites/" class="md-tabs__link">
254
255
256
257
Getting Started
258
259
</a>
260
</li>
261
262
263
264
265
266
267
268
269
270
271
272
273
274
<li class="md-tabs__item md-tabs__item--active">
275
<a href="./" class="md-tabs__link">
276
277
278
279
Architecture
280
281
</a>
282
</li>
283
284
285
286
287
</ul>
288
</div>
289
</nav>
290
291
292
293
<main class="md-main" data-md-component="main">
294
<div class="md-main__inner md-grid">
295
296
297
298
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
299
<div class="md-sidebar__scrollwrap">
300
<div class="md-sidebar__inner">
301
302
303
304
305
306
307
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
308
<label class="md-nav__title" for="__drawer">
309
<a href="../.." title="Fossilrepo" class="md-nav__button md-logo" aria-label="Fossilrepo" data-md-component="logo">
310
<div style="display: flex; align-items: center; gap: 0.6rem;">
311
<img src="../../assets/images/conflict-logo.svg" alt="CONFLICT" style="height: 1.4rem; width: auto;">
312
<img src="../../assets/images/fossilrepo-logo.svg" alt="Fossilrepo" style="height: 1.2rem; width: auto;">
313
</div>
314
</a>
315
Fossilrepo
316
</label>
317
318
<div class="md-nav__source">
319
<a href="https://github.com/ConflictHQ/fossilrepo" title="Go to repository" class="md-source" data-md-component="source">
320
<div class="md-source__icon md-icon">
321
322
<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>
323
</div>
324
<div class="md-source__repository">
325
ConflictHQ/fossilrepo
326
</div>
327
</a>
328
</div>
329
330
<ul class="md-nav__list" data-md-scrollfix>
331
332
333
334
335
336
337
338
<li class="md-nav__item">
339
<a href="../.." class="md-nav__link">
340
341
342
343
<span class="md-ellipsis">
344
345
346
Home
347
348
349
350
</span>
351
352
353
354
</a>
355
</li>
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
<li class="md-nav__item md-nav__item--nested">
376
377
378
379
380
381
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
382
383
384
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
385
386
387
388
<span class="md-ellipsis">
389
390
391
Getting Started
392
393
394
395
</span>
396
397
398
399
<span class="md-nav__icon md-icon"></span>
400
</label>
401
402
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
403
<label class="md-nav__title" for="__nav_2">
404
<span class="md-nav__icon md-icon"></span>
405
406
407
Getting Started
408
409
410
</label>
411
<ul class="md-nav__list" data-md-scrollfix>
412
413
414
415
416
417
418
419
<li class="md-nav__item">
420
<a href="../../getting-started/prerequisites/" class="md-nav__link">
421
422
423
424
<span class="md-ellipsis">
425
426
427
Prerequisites
428
429
430
431
</span>
432
433
434
435
</a>
436
</li>
437
438
439
440
441
442
443
444
445
446
447
<li class="md-nav__item">
448
<a href="../../getting-started/installation/" class="md-nav__link">
449
450
451
452
<span class="md-ellipsis">
453
454
455
Installation
456
457
458
459
</span>
460
461
462
463
</a>
464
</li>
465
466
467
468
469
470
471
472
473
474
475
<li class="md-nav__item">
476
<a href="../../getting-started/configuration/" class="md-nav__link">
477
478
479
480
<span class="md-ellipsis">
481
482
483
Configuration
484
485
486
487
</span>
488
489
490
491
</a>
492
</li>
493
494
495
496
497
498
499
500
501
502
503
<li class="md-nav__item">
504
<a href="../../getting-started/first-repo/" class="md-nav__link">
505
506
507
508
<span class="md-ellipsis">
509
510
511
First Repository
512
513
514
515
</span>
516
517
518
519
</a>
520
</li>
521
522
523
524
525
</ul>
526
</nav>
527
528
</li>
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
554
555
556
557
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
558
559
560
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
561
562
563
564
<span class="md-ellipsis">
565
566
567
Architecture
568
569
570
571
</span>
572
573
574
575
<span class="md-nav__icon md-icon"></span>
576
</label>
577
578
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
579
<label class="md-nav__title" for="__nav_3">
580
<span class="md-nav__icon md-icon"></span>
581
582
583
Architecture
584
585
586
</label>
587
<ul class="md-nav__list" data-md-scrollfix>
588
589
590
591
592
593
594
595
596
597
<li class="md-nav__item md-nav__item--active">
598
599
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
600
601
602
603
604
605
<label class="md-nav__link md-nav__link--active" for="__toc">
606
607
608
609
<span class="md-ellipsis">
610
611
612
Overview
613
614
615
616
</span>
617
618
619
620
<span class="md-nav__icon md-icon"></span>
621
</label>
622
623
<a href="./" class="md-nav__link md-nav__link--active">
624
625
626
627
<span class="md-ellipsis">
628
629
630
Overview
631
632
633
634
</span>
635
636
637
638
</a>
639
640
641
642
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
643
644
645
646
647
648
649
<label class="md-nav__title" for="__toc">
650
<span class="md-nav__icon md-icon"></span>
651
Table of contents
652
</label>
653
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
654
655
<li class="md-nav__item">
656
<a href="#system-diagram" class="md-nav__link">
657
<span class="md-ellipsis">
658
659
System Diagram
660
661
</span>
662
</a>
663
664
</li>
665
666
<li class="md-nav__item">
667
<a href="#components" class="md-nav__link">
668
<span class="md-ellipsis">
669
670
Components
671
672
</span>
673
</a>
674
675
<nav class="md-nav" aria-label="Components">
676
<ul class="md-nav__list">
677
678
<li class="md-nav__item">
679
<a href="#fossil-server" class="md-nav__link">
680
<span class="md-ellipsis">
681
682
Fossil Server
683
684
</span>
685
</a>
686
687
</li>
688
689
<li class="md-nav__item">
690
<a href="#caddy" class="md-nav__link">
691
<span class="md-ellipsis">
692
693
Caddy
694
695
</span>
696
</a>
697
698
</li>
699
700
<li class="md-nav__item">
701
<a href="#django-management-layer" class="md-nav__link">
702
<span class="md-ellipsis">
703
704
Django Management Layer
705
706
</span>
707
</a>
708
709
</li>
710
711
<li class="md-nav__item">
712
<a href="#litestream" class="md-nav__link">
713
<span class="md-ellipsis">
714
715
Litestream
716
717
</span>
718
</a>
719
720
</li>
721
722
<li class="md-nav__item">
723
<a href="#celery-workers" class="md-nav__link">
724
<span class="md-ellipsis">
725
726
Celery Workers
727
728
</span>
729
</a>
730
731
</li>
732
733
</ul>
734
</nav>
735
736
</li>
737
738
<li class="md-nav__item">
739
<a href="#data-flow" class="md-nav__link">
740
<span class="md-ellipsis">
741
742
Data Flow
743
744
</span>
745
</a>
746
747
</li>
748
749
</ul>
750
751
</nav>
752
753
</li>
754
755
756
757
758
759
760
761
762
763
764
<li class="md-nav__item">
765
<a href="../sync-bridge/" class="md-nav__link">
766
767
768
769
<span class="md-ellipsis">
770
771
772
Sync Bridge
773
774
775
776
</span>
777
778
779
780
</a>
781
</li>
782
783
784
785
786
</ul>
787
</nav>
788
789
</li>
790
791
792
793
</ul>
794
</nav>
795
</div>
796
</div>
797
</div>
798
799
800
801
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
802
<div class="md-sidebar__scrollwrap">
803
<div class="md-sidebar__inner">
804
805
806
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
807
808
809
810
811
812
813
<label class="md-nav__title" for="__toc">
814
<span class="md-nav__icon md-icon"></span>
815
Table of contents
816
</label>
817
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
818
819
<li class="md-nav__item">
820
<a href="#system-diagram" class="md-nav__link">
821
<span class="md-ellipsis">
822
823
System Diagram
824
825
</span>
826
</a>
827
828
</li>
829
830
<li class="md-nav__item">
831
<a href="#components" class="md-nav__link">
832
<span class="md-ellipsis">
833
834
Components
835
836
</span>
837
</a>
838
839
<nav class="md-nav" aria-label="Components">
840
<ul class="md-nav__list">
841
842
<li class="md-nav__item">
843
<a href="#fossil-server" class="md-nav__link">
844
<span class="md-ellipsis">
845
846
Fossil Server
847
848
</span>
849
</a>
850
851
</li>
852
853
<li class="md-nav__item">
854
<a href="#caddy" class="md-nav__link">
855
<span class="md-ellipsis">
856
857
Caddy
858
859
</span>
860
</a>
861
862
</li>
863
864
<li class="md-nav__item">
865
<a href="#django-management-layer" class="md-nav__link">
866
<span class="md-ellipsis">
867
868
Django Management Layer
869
870
</span>
871
</a>
872
873
</li>
874
875
<li class="md-nav__item">
876
<a href="#litestream" class="md-nav__link">
877
<span class="md-ellipsis">
878
879
Litestream
880
881
</span>
882
</a>
883
884
</li>
885
886
<li class="md-nav__item">
887
<a href="#celery-workers" class="md-nav__link">
888
<span class="md-ellipsis">
889
890
Celery Workers
891
892
</span>
893
</a>
894
895
</li>
896
897
</ul>
898
</nav>
899
900
</li>
901
902
<li class="md-nav__item">
903
<a href="#data-flow" class="md-nav__link">
904
<span class="md-ellipsis">
905
906
Data Flow
907
908
</span>
909
</a>
910
911
</li>
912
913
</ul>
914
915
</nav>
916
</div>
917
</div>
918
</div>
919
920
921
922
<div class="md-content" data-md-component="content">
923
924
<article class="md-content__inner md-typeset">
925
926
927
928
929
930
931
932
933
<h1 id="architecture-overview">Architecture Overview<a class="headerlink" href="#architecture-overview" title="Permanent link">&para;</a></h1>
934
<p>Fossilrepo is a thin orchestration layer around Fossil SCM. Fossil does the heavy lifting -- fossilrepo handles provisioning, routing, backups, and the management UI.</p>
935
<h2 id="system-diagram">System Diagram<a class="headerlink" href="#system-diagram" title="Permanent link">&para;</a></h2>
936
<pre class="mermaid"><code>graph TB
937
subgraph Internet
938
User[User / Browser]
939
end
940
941
subgraph Fossilrepo Server
942
Caddy[Caddy&lt;br/&gt;SSL + Routing]
943
Django[Django&lt;br/&gt;Management UI]
944
Fossil[Fossil Server&lt;br/&gt;--repolist]
945
Celery[Celery Workers]
946
Redis[Redis]
947
Postgres[(PostgreSQL)]
948
Litestream[Litestream]
949
end
950
951
subgraph Storage
952
Repos["/data/repos/&lt;br/&gt;*.fossil files"]
953
S3[(S3 / MinIO)]
954
end
955
956
subgraph Mirrors
957
GitHub[GitHub]
958
GitLab[GitLab]
959
end
960
961
User --&gt; Caddy
962
Caddy --&gt;|"app.domain.com"| Django
963
Caddy --&gt;|"repo.domain.com"| Fossil
964
Django --&gt; Postgres
965
Django --&gt; Redis
966
Celery --&gt; Redis
967
Celery --&gt;|sync bridge| GitHub
968
Celery --&gt;|sync bridge| GitLab
969
Fossil --&gt; Repos
970
Litestream --&gt; Repos
971
Litestream --&gt; S3</code></pre>
972
<h2 id="components">Components<a class="headerlink" href="#components" title="Permanent link">&para;</a></h2>
973
<h3 id="fossil-server">Fossil Server<a class="headerlink" href="#fossil-server" title="Permanent link">&para;</a></h3>
974
<p>A single <code>fossil server --repolist /data/repos/</code> process serves all repositories. Each <code>.fossil</code> file is a self-contained SQLite database with VCS history, issues, wiki, and forum.</p>
975
<p>Adding a new repo is just <code>fossil init /data/repos/name.fossil</code> -- no restart needed.</p>
976
<h3 id="caddy">Caddy<a class="headerlink" href="#caddy" title="Permanent link">&para;</a></h3>
977
<p>Handles SSL termination and subdomain routing:</p>
978
<ul>
979
<li><code>your-domain.com</code> routes to the Django management UI</li>
980
<li><code>reponame.your-domain.com</code> routes directly to Fossil's web UI</li>
981
</ul>
982
<p>Caddy automatically provisions and renews Let's Encrypt certificates.</p>
983
<h3 id="django-management-layer">Django Management Layer<a class="headerlink" href="#django-management-layer" title="Permanent link">&para;</a></h3>
984
<p>Provides the administrative interface:</p>
985
<ul>
986
<li>Repository lifecycle (create, configure, archive)</li>
987
<li>User and organization management</li>
988
<li>Dashboard and analytics</li>
989
<li>Sync bridge configuration</li>
990
</ul>
991
<p>Django uses HTMX for interactive UI without a JavaScript framework.</p>
992
<h3 id="litestream">Litestream<a class="headerlink" href="#litestream" title="Permanent link">&para;</a></h3>
993
<p>Continuously replicates every <code>.fossil</code> SQLite file to S3-compatible storage. Provides:</p>
994
<ul>
995
<li><strong>Continuous backup</strong> -- WAL frames replicated in near-real-time</li>
996
<li><strong>Point-in-time recovery</strong> -- restore to any moment, not just snapshots</li>
997
<li><strong>Zero-config per repo</strong> -- new <code>.fossil</code> files are picked up automatically</li>
998
</ul>
999
<h3 id="celery-workers">Celery Workers<a class="headerlink" href="#celery-workers" title="Permanent link">&para;</a></h3>
1000
<p>Handle background tasks:</p>
1001
<ul>
1002
<li>Sync bridge execution (Fossil to Git mirroring)</li>
1003
<li>Scheduled sync jobs</li>
1004
<li>Upstream pull operations</li>
1005
</ul>
1006
<h2 id="data-flow">Data Flow<a class="headerlink" href="#data-flow" title="Permanent link">&para;</a></h2>
1007
<ol>
1008
<li><strong>User pushes to Fossil</strong> -- standard <code>fossil push</code> or <code>fossil sync</code></li>
1009
<li><strong>Fossil writes to <code>.fossil</code> file</strong> -- SQLite transactions</li>
1010
<li><strong>Litestream replicates</strong> -- WAL frames streamed to S3</li>
1011
<li><strong>Sync bridge runs</strong> -- Celery task mirrors changes to Git remotes</li>
1012
<li><strong>Django reflects state</strong> -- reads from Fossil SQLite for dashboards</li>
1013
</ol>
1014
<p>Fossil is always the source of truth. Everything else is derived.</p>
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
</article>
1029
</div>
1030
1031
1032
<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>
1033
1034
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
1035
</div>
1036
1037
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
1038
1039
<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>
1040
Back to top
1041
</button>
1042
1043
</main>
1044
1045
<footer class="md-footer">
1046
1047
<div class="md-footer-meta md-typeset">
1048
<div class="md-footer-meta__inner md-grid">
1049
<div class="md-copyright">
1050
1051
<div class="md-copyright__highlight">
1052
Copyright &copy; 2026 CONFLICT LLC
1053
</div>
1054
1055
1056
Made with
1057
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
1058
Material for MkDocs
1059
</a>
1060
1061
</div>
1062
1063
1064
<div class="md-social">
1065
1066
1067
1068
1069
1070
1071
1072
1073
<a href="https://github.com/ConflictHQ/fossilrepo" target="_blank" rel="noopener" title="github.com" class="md-social__link">
1074
<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>
1075
</a>
1076
1077
</div>
1078
1079
</div>
1080
</div>
1081
</footer>
1082
1083
</div>
1084
<div class="md-dialog" data-md-component="dialog">
1085
<div class="md-dialog__inner md-typeset"></div>
1086
</div>
1087
1088
1089
1090
1091
1092
<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>
1093
1094
1095
<script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
1096
1097
1098
</body>
1099
</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