FossilRepo

fossilrepo / site / getting-started / configuration / index.html
Source Rendered
Blame History Raw 1288 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/getting-started/configuration/">
16
17
18
<link rel="prev" href="../installation/">
19
20
21
<link rel="next" href="../first-repo/">
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>Configuration - 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="#configuration" 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
Configuration
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
253
254
<li class="md-tabs__item md-tabs__item--active">
255
<a href="../prerequisites/" class="md-tabs__link">
256
257
258
259
Getting Started
260
261
</a>
262
</li>
263
264
265
266
267
268
269
270
271
272
273
274
<li class="md-tabs__item">
275
<a href="../../architecture/overview/" 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
376
377
378
379
380
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
381
382
383
384
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
385
386
387
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
388
389
390
391
<span class="md-ellipsis">
392
393
394
Getting Started
395
396
397
398
</span>
399
400
401
402
<span class="md-nav__icon md-icon"></span>
403
</label>
404
405
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
406
<label class="md-nav__title" for="__nav_2">
407
<span class="md-nav__icon md-icon"></span>
408
409
410
Getting Started
411
412
413
</label>
414
<ul class="md-nav__list" data-md-scrollfix>
415
416
417
418
419
420
421
422
<li class="md-nav__item">
423
<a href="../prerequisites/" class="md-nav__link">
424
425
426
427
<span class="md-ellipsis">
428
429
430
Prerequisites
431
432
433
434
</span>
435
436
437
438
</a>
439
</li>
440
441
442
443
444
445
446
447
448
449
450
<li class="md-nav__item">
451
<a href="../installation/" class="md-nav__link">
452
453
454
455
<span class="md-ellipsis">
456
457
458
Installation
459
460
461
462
</span>
463
464
465
466
</a>
467
</li>
468
469
470
471
472
473
474
475
476
477
478
479
480
<li class="md-nav__item md-nav__item--active">
481
482
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
483
484
485
486
487
488
<label class="md-nav__link md-nav__link--active" for="__toc">
489
490
491
492
<span class="md-ellipsis">
493
494
495
Configuration
496
497
498
499
</span>
500
501
502
503
<span class="md-nav__icon md-icon"></span>
504
</label>
505
506
<a href="./" class="md-nav__link md-nav__link--active">
507
508
509
510
<span class="md-ellipsis">
511
512
513
Configuration
514
515
516
517
</span>
518
519
520
521
</a>
522
523
524
525
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
526
527
528
529
530
531
532
<label class="md-nav__title" for="__toc">
533
<span class="md-nav__icon md-icon"></span>
534
Table of contents
535
</label>
536
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
537
538
<li class="md-nav__item">
539
<a href="#environment-variables" class="md-nav__link">
540
<span class="md-ellipsis">
541
542
Environment Variables
543
544
</span>
545
</a>
546
547
<nav class="md-nav" aria-label="Environment Variables">
548
<ul class="md-nav__list">
549
550
<li class="md-nav__item">
551
<a href="#django-settings" class="md-nav__link">
552
<span class="md-ellipsis">
553
554
Django Settings
555
556
</span>
557
</a>
558
559
</li>
560
561
<li class="md-nav__item">
562
<a href="#database" class="md-nav__link">
563
<span class="md-ellipsis">
564
565
Database
566
567
</span>
568
</a>
569
570
</li>
571
572
<li class="md-nav__item">
573
<a href="#redis-celery" class="md-nav__link">
574
<span class="md-ellipsis">
575
576
Redis &amp; Celery
577
578
</span>
579
</a>
580
581
</li>
582
583
<li class="md-nav__item">
584
<a href="#fossil" class="md-nav__link">
585
<span class="md-ellipsis">
586
587
Fossil
588
589
</span>
590
</a>
591
592
</li>
593
594
<li class="md-nav__item">
595
<a href="#caddy-production" class="md-nav__link">
596
<span class="md-ellipsis">
597
598
Caddy (Production)
599
600
</span>
601
</a>
602
603
</li>
604
605
<li class="md-nav__item">
606
<a href="#litestream-backups" class="md-nav__link">
607
<span class="md-ellipsis">
608
609
Litestream (Backups)
610
611
</span>
612
</a>
613
614
</li>
615
616
<li class="md-nav__item">
617
<a href="#sync-bridge" class="md-nav__link">
618
<span class="md-ellipsis">
619
620
Sync Bridge
621
622
</span>
623
</a>
624
625
</li>
626
627
</ul>
628
</nav>
629
630
</li>
631
632
<li class="md-nav__item">
633
<a href="#caddy-configuration" class="md-nav__link">
634
<span class="md-ellipsis">
635
636
Caddy Configuration
637
638
</span>
639
</a>
640
641
</li>
642
643
<li class="md-nav__item">
644
<a href="#litestream-configuration" class="md-nav__link">
645
<span class="md-ellipsis">
646
647
Litestream Configuration
648
649
</span>
650
</a>
651
652
</li>
653
654
</ul>
655
656
</nav>
657
658
</li>
659
660
661
662
663
664
665
666
667
668
669
<li class="md-nav__item">
670
<a href="../first-repo/" class="md-nav__link">
671
672
673
674
<span class="md-ellipsis">
675
676
677
First Repository
678
679
680
681
</span>
682
683
684
685
</a>
686
</li>
687
688
689
690
691
</ul>
692
</nav>
693
694
</li>
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
<li class="md-nav__item md-nav__item--nested">
715
716
717
718
719
720
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
721
722
723
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
724
725
726
727
<span class="md-ellipsis">
728
729
730
Architecture
731
732
733
734
</span>
735
736
737
738
<span class="md-nav__icon md-icon"></span>
739
</label>
740
741
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
742
<label class="md-nav__title" for="__nav_3">
743
<span class="md-nav__icon md-icon"></span>
744
745
746
Architecture
747
748
749
</label>
750
<ul class="md-nav__list" data-md-scrollfix>
751
752
753
754
755
756
757
758
<li class="md-nav__item">
759
<a href="../../architecture/overview/" class="md-nav__link">
760
761
762
763
<span class="md-ellipsis">
764
765
766
Overview
767
768
769
770
</span>
771
772
773
774
</a>
775
</li>
776
777
778
779
780
781
782
783
784
785
786
<li class="md-nav__item">
787
<a href="../../architecture/sync-bridge/" class="md-nav__link">
788
789
790
791
<span class="md-ellipsis">
792
793
794
Sync Bridge
795
796
797
798
</span>
799
800
801
802
</a>
803
</li>
804
805
806
807
808
</ul>
809
</nav>
810
811
</li>
812
813
814
815
</ul>
816
</nav>
817
</div>
818
</div>
819
</div>
820
821
822
823
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
824
<div class="md-sidebar__scrollwrap">
825
<div class="md-sidebar__inner">
826
827
828
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
829
830
831
832
833
834
835
<label class="md-nav__title" for="__toc">
836
<span class="md-nav__icon md-icon"></span>
837
Table of contents
838
</label>
839
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
840
841
<li class="md-nav__item">
842
<a href="#environment-variables" class="md-nav__link">
843
<span class="md-ellipsis">
844
845
Environment Variables
846
847
</span>
848
</a>
849
850
<nav class="md-nav" aria-label="Environment Variables">
851
<ul class="md-nav__list">
852
853
<li class="md-nav__item">
854
<a href="#django-settings" class="md-nav__link">
855
<span class="md-ellipsis">
856
857
Django Settings
858
859
</span>
860
</a>
861
862
</li>
863
864
<li class="md-nav__item">
865
<a href="#database" class="md-nav__link">
866
<span class="md-ellipsis">
867
868
Database
869
870
</span>
871
</a>
872
873
</li>
874
875
<li class="md-nav__item">
876
<a href="#redis-celery" class="md-nav__link">
877
<span class="md-ellipsis">
878
879
Redis &amp; Celery
880
881
</span>
882
</a>
883
884
</li>
885
886
<li class="md-nav__item">
887
<a href="#fossil" class="md-nav__link">
888
<span class="md-ellipsis">
889
890
Fossil
891
892
</span>
893
</a>
894
895
</li>
896
897
<li class="md-nav__item">
898
<a href="#caddy-production" class="md-nav__link">
899
<span class="md-ellipsis">
900
901
Caddy (Production)
902
903
</span>
904
</a>
905
906
</li>
907
908
<li class="md-nav__item">
909
<a href="#litestream-backups" class="md-nav__link">
910
<span class="md-ellipsis">
911
912
Litestream (Backups)
913
914
</span>
915
</a>
916
917
</li>
918
919
<li class="md-nav__item">
920
<a href="#sync-bridge" class="md-nav__link">
921
<span class="md-ellipsis">
922
923
Sync Bridge
924
925
</span>
926
</a>
927
928
</li>
929
930
</ul>
931
</nav>
932
933
</li>
934
935
<li class="md-nav__item">
936
<a href="#caddy-configuration" class="md-nav__link">
937
<span class="md-ellipsis">
938
939
Caddy Configuration
940
941
</span>
942
</a>
943
944
</li>
945
946
<li class="md-nav__item">
947
<a href="#litestream-configuration" class="md-nav__link">
948
<span class="md-ellipsis">
949
950
Litestream Configuration
951
952
</span>
953
</a>
954
955
</li>
956
957
</ul>
958
959
</nav>
960
</div>
961
</div>
962
</div>
963
964
965
966
<div class="md-content" data-md-component="content">
967
968
<article class="md-content__inner md-typeset">
969
970
971
972
973
974
975
976
977
<h1 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">&para;</a></h1>
978
<h2 id="environment-variables">Environment Variables<a class="headerlink" href="#environment-variables" title="Permanent link">&para;</a></h2>
979
<p>All configuration is done through environment variables, loaded from <code>.env</code> in development.</p>
980
<h3 id="django-settings">Django Settings<a class="headerlink" href="#django-settings" title="Permanent link">&para;</a></h3>
981
<table>
982
<thead>
983
<tr>
984
<th>Variable</th>
985
<th>Default</th>
986
<th>Description</th>
987
</tr>
988
</thead>
989
<tbody>
990
<tr>
991
<td><code>SECRET_KEY</code></td>
992
<td>--</td>
993
<td>Django secret key (required)</td>
994
</tr>
995
<tr>
996
<td><code>DEBUG</code></td>
997
<td><code>False</code></td>
998
<td>Enable debug mode</td>
999
</tr>
1000
<tr>
1001
<td><code>ALLOWED_HOSTS</code></td>
1002
<td><code>localhost</code></td>
1003
<td>Comma-separated list of allowed hosts</td>
1004
</tr>
1005
<tr>
1006
<td><code>TIME_ZONE</code></td>
1007
<td><code>UTC</code></td>
1008
<td>Server timezone</td>
1009
</tr>
1010
</tbody>
1011
</table>
1012
<h3 id="database">Database<a class="headerlink" href="#database" title="Permanent link">&para;</a></h3>
1013
<table>
1014
<thead>
1015
<tr>
1016
<th>Variable</th>
1017
<th>Default</th>
1018
<th>Description</th>
1019
</tr>
1020
</thead>
1021
<tbody>
1022
<tr>
1023
<td><code>POSTGRES_DB</code></td>
1024
<td><code>fossilrepo</code></td>
1025
<td>Database name</td>
1026
</tr>
1027
<tr>
1028
<td><code>POSTGRES_USER</code></td>
1029
<td><code>fossilrepo</code></td>
1030
<td>Database user</td>
1031
</tr>
1032
<tr>
1033
<td><code>POSTGRES_PASSWORD</code></td>
1034
<td>--</td>
1035
<td>Database password (required)</td>
1036
</tr>
1037
<tr>
1038
<td><code>POSTGRES_HOST</code></td>
1039
<td><code>postgres</code></td>
1040
<td>Database host</td>
1041
</tr>
1042
<tr>
1043
<td><code>POSTGRES_PORT</code></td>
1044
<td><code>5432</code></td>
1045
<td>Database port</td>
1046
</tr>
1047
</tbody>
1048
</table>
1049
<h3 id="redis-celery">Redis &amp; Celery<a class="headerlink" href="#redis-celery" title="Permanent link">&para;</a></h3>
1050
<table>
1051
<thead>
1052
<tr>
1053
<th>Variable</th>
1054
<th>Default</th>
1055
<th>Description</th>
1056
</tr>
1057
</thead>
1058
<tbody>
1059
<tr>
1060
<td><code>REDIS_URL</code></td>
1061
<td><code>redis://redis:6379/0</code></td>
1062
<td>Redis connection URL</td>
1063
</tr>
1064
<tr>
1065
<td><code>CELERY_BROKER_URL</code></td>
1066
<td><code>$REDIS_URL</code></td>
1067
<td>Celery broker (defaults to Redis URL)</td>
1068
</tr>
1069
</tbody>
1070
</table>
1071
<h3 id="fossil">Fossil<a class="headerlink" href="#fossil" title="Permanent link">&para;</a></h3>
1072
<table>
1073
<thead>
1074
<tr>
1075
<th>Variable</th>
1076
<th>Default</th>
1077
<th>Description</th>
1078
</tr>
1079
</thead>
1080
<tbody>
1081
<tr>
1082
<td><code>FOSSIL_REPO_DIR</code></td>
1083
<td><code>/data/repos</code></td>
1084
<td>Directory where <code>.fossil</code> files are stored</td>
1085
</tr>
1086
<tr>
1087
<td><code>FOSSIL_BASE_URL</code></td>
1088
<td>--</td>
1089
<td>Base URL for Fossil web UI (e.g., <code>https://code.example.com</code>)</td>
1090
</tr>
1091
<tr>
1092
<td><code>FOSSIL_BINARY</code></td>
1093
<td><code>fossil</code></td>
1094
<td>Path to the Fossil binary</td>
1095
</tr>
1096
</tbody>
1097
</table>
1098
<h3 id="caddy-production">Caddy (Production)<a class="headerlink" href="#caddy-production" title="Permanent link">&para;</a></h3>
1099
<table>
1100
<thead>
1101
<tr>
1102
<th>Variable</th>
1103
<th>Default</th>
1104
<th>Description</th>
1105
</tr>
1106
</thead>
1107
<tbody>
1108
<tr>
1109
<td><code>CADDY_DOMAIN</code></td>
1110
<td>--</td>
1111
<td>Your domain (e.g., <code>example.com</code>)</td>
1112
</tr>
1113
<tr>
1114
<td><code>CADDY_EMAIL</code></td>
1115
<td>--</td>
1116
<td>Email for Let's Encrypt certificates</td>
1117
</tr>
1118
</tbody>
1119
</table>
1120
<h3 id="litestream-backups">Litestream (Backups)<a class="headerlink" href="#litestream-backups" title="Permanent link">&para;</a></h3>
1121
<table>
1122
<thead>
1123
<tr>
1124
<th>Variable</th>
1125
<th>Default</th>
1126
<th>Description</th>
1127
</tr>
1128
</thead>
1129
<tbody>
1130
<tr>
1131
<td><code>LITESTREAM_ACCESS_KEY_ID</code></td>
1132
<td>--</td>
1133
<td>S3 access key</td>
1134
</tr>
1135
<tr>
1136
<td><code>LITESTREAM_SECRET_ACCESS_KEY</code></td>
1137
<td>--</td>
1138
<td>S3 secret key</td>
1139
</tr>
1140
<tr>
1141
<td><code>LITESTREAM_BUCKET</code></td>
1142
<td>--</td>
1143
<td>S3 bucket name</td>
1144
</tr>
1145
<tr>
1146
<td><code>LITESTREAM_ENDPOINT</code></td>
1147
<td>--</td>
1148
<td>S3 endpoint (for MinIO/B2)</td>
1149
</tr>
1150
<tr>
1151
<td><code>LITESTREAM_REGION</code></td>
1152
<td><code>us-east-1</code></td>
1153
<td>S3 region</td>
1154
</tr>
1155
</tbody>
1156
</table>
1157
<h3 id="sync-bridge">Sync Bridge<a class="headerlink" href="#sync-bridge" title="Permanent link">&para;</a></h3>
1158
<table>
1159
<thead>
1160
<tr>
1161
<th>Variable</th>
1162
<th>Default</th>
1163
<th>Description</th>
1164
</tr>
1165
</thead>
1166
<tbody>
1167
<tr>
1168
<td><code>GITHUB_TOKEN</code></td>
1169
<td>--</td>
1170
<td>GitHub personal access token (for mirroring)</td>
1171
</tr>
1172
<tr>
1173
<td><code>GITLAB_TOKEN</code></td>
1174
<td>--</td>
1175
<td>GitLab personal access token (for mirroring)</td>
1176
</tr>
1177
</tbody>
1178
</table>
1179
<h2 id="caddy-configuration">Caddy Configuration<a class="headerlink" href="#caddy-configuration" title="Permanent link">&para;</a></h2>
1180
<p>The Caddyfile controls SSL termination and subdomain routing. Each Fossil repo gets its own subdomain:</p>
1181
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>{$CADDY_DOMAIN} {
1182
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> reverse_proxy django:8000
1183
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>}
1184
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>
1185
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>*.{$CADDY_DOMAIN} {
1186
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> reverse_proxy fossil:8080
1187
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a>}
1188
</code></pre></div>
1189
<p>Caddy automatically provisions Let's Encrypt certificates for all subdomains.</p>
1190
<h2 id="litestream-configuration">Litestream Configuration<a class="headerlink" href="#litestream-configuration" title="Permanent link">&para;</a></h2>
1191
<p>Litestream continuously replicates every <code>.fossil</code> SQLite file to S3:</p>
1192
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="nt">dbs</span><span class="p">:</span>
1193
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/data/repos/*.fossil</span>
1194
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="w"> </span><span class="nt">replicas</span><span class="p">:</span>
1195
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">s3</span>
1196
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="w"> </span><span class="nt">bucket</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${LITESTREAM_BUCKET}</span>
1197
<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="w"> </span><span class="nt">endpoint</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${LITESTREAM_ENDPOINT}</span>
1198
<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a><span class="w"> </span><span class="nt">region</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${LITESTREAM_REGION}</span>
1199
</code></pre></div>
1200
<div class="admonition tip">
1201
<p class="admonition-title">Point-in-time recovery</p>
1202
<p>Litestream replicates WAL frames continuously. You can restore any <code>.fossil</code> file to any point in time, not just the latest snapshot.</p>
1203
</div>
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
</article>
1218
</div>
1219
1220
1221
<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>
1222
1223
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
1224
</div>
1225
1226
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
1227
1228
<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>
1229
Back to top
1230
</button>
1231
1232
</main>
1233
1234
<footer class="md-footer">
1235
1236
<div class="md-footer-meta md-typeset">
1237
<div class="md-footer-meta__inner md-grid">
1238
<div class="md-copyright">
1239
1240
<div class="md-copyright__highlight">
1241
Copyright &copy; 2026 CONFLICT LLC
1242
</div>
1243
1244
1245
Made with
1246
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
1247
Material for MkDocs
1248
</a>
1249
1250
</div>
1251
1252
1253
<div class="md-social">
1254
1255
1256
1257
1258
1259
1260
1261
1262
<a href="https://github.com/ConflictHQ/fossilrepo" target="_blank" rel="noopener" title="github.com" class="md-social__link">
1263
<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>
1264
</a>
1265
1266
</div>
1267
1268
</div>
1269
</div>
1270
</footer>
1271
1272
</div>
1273
<div class="md-dialog" data-md-component="dialog">
1274
<div class="md-dialog__inner md-typeset"></div>
1275
</div>
1276
1277
1278
1279
1280
1281
<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>
1282
1283
1284
<script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
1285
1286
1287
</body>
1288
</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