FossilRepo

fossilrepo / site / getting-started / installation / index.html
Source Rendered
Blame History Raw 1089 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/installation/">
16
17
18
<link rel="prev" href="../prerequisites/">
19
20
21
<link rel="next" href="../configuration/">
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>Installation - 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="#installation" 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
Installation
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
451
452
<li class="md-nav__item md-nav__item--active">
453
454
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
455
456
457
458
459
460
<label class="md-nav__link md-nav__link--active" for="__toc">
461
462
463
464
<span class="md-ellipsis">
465
466
467
Installation
468
469
470
471
</span>
472
473
474
475
<span class="md-nav__icon md-icon"></span>
476
</label>
477
478
<a href="./" class="md-nav__link md-nav__link--active">
479
480
481
482
<span class="md-ellipsis">
483
484
485
Installation
486
487
488
489
</span>
490
491
492
493
</a>
494
495
496
497
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
498
499
500
501
502
503
504
<label class="md-nav__title" for="__toc">
505
<span class="md-nav__icon md-icon"></span>
506
Table of contents
507
</label>
508
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
509
510
<li class="md-nav__item">
511
<a href="#clone-the-repository" class="md-nav__link">
512
<span class="md-ellipsis">
513
514
Clone the Repository
515
516
</span>
517
</a>
518
519
</li>
520
521
<li class="md-nav__item">
522
<a href="#environment-configuration" class="md-nav__link">
523
<span class="md-ellipsis">
524
525
Environment Configuration
526
527
</span>
528
</a>
529
530
</li>
531
532
<li class="md-nav__item">
533
<a href="#start-the-stack" class="md-nav__link">
534
<span class="md-ellipsis">
535
536
Start the Stack
537
538
</span>
539
</a>
540
541
<nav class="md-nav" aria-label="Start the Stack">
542
<ul class="md-nav__list">
543
544
<li class="md-nav__item">
545
<a href="#development" class="md-nav__link">
546
<span class="md-ellipsis">
547
548
Development
549
550
</span>
551
</a>
552
553
</li>
554
555
<li class="md-nav__item">
556
<a href="#production" class="md-nav__link">
557
<span class="md-ellipsis">
558
559
Production
560
561
</span>
562
</a>
563
564
</li>
565
566
</ul>
567
</nav>
568
569
</li>
570
571
<li class="md-nav__item">
572
<a href="#verify-installation" class="md-nav__link">
573
<span class="md-ellipsis">
574
575
Verify Installation
576
577
</span>
578
</a>
579
580
</li>
581
582
<li class="md-nav__item">
583
<a href="#common-issues" class="md-nav__link">
584
<span class="md-ellipsis">
585
586
Common Issues
587
588
</span>
589
</a>
590
591
</li>
592
593
</ul>
594
595
</nav>
596
597
</li>
598
599
600
601
602
603
604
605
606
607
608
<li class="md-nav__item">
609
<a href="../configuration/" class="md-nav__link">
610
611
612
613
<span class="md-ellipsis">
614
615
616
Configuration
617
618
619
620
</span>
621
622
623
624
</a>
625
</li>
626
627
628
629
630
631
632
633
634
635
636
<li class="md-nav__item">
637
<a href="../first-repo/" class="md-nav__link">
638
639
640
641
<span class="md-ellipsis">
642
643
644
First Repository
645
646
647
648
</span>
649
650
651
652
</a>
653
</li>
654
655
656
657
658
</ul>
659
</nav>
660
661
</li>
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
<li class="md-nav__item md-nav__item--nested">
682
683
684
685
686
687
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
688
689
690
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
691
692
693
694
<span class="md-ellipsis">
695
696
697
Architecture
698
699
700
701
</span>
702
703
704
705
<span class="md-nav__icon md-icon"></span>
706
</label>
707
708
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
709
<label class="md-nav__title" for="__nav_3">
710
<span class="md-nav__icon md-icon"></span>
711
712
713
Architecture
714
715
716
</label>
717
<ul class="md-nav__list" data-md-scrollfix>
718
719
720
721
722
723
724
725
<li class="md-nav__item">
726
<a href="../../architecture/overview/" class="md-nav__link">
727
728
729
730
<span class="md-ellipsis">
731
732
733
Overview
734
735
736
737
</span>
738
739
740
741
</a>
742
</li>
743
744
745
746
747
748
749
750
751
752
753
<li class="md-nav__item">
754
<a href="../../architecture/sync-bridge/" class="md-nav__link">
755
756
757
758
<span class="md-ellipsis">
759
760
761
Sync Bridge
762
763
764
765
</span>
766
767
768
769
</a>
770
</li>
771
772
773
774
775
</ul>
776
</nav>
777
778
</li>
779
780
781
782
</ul>
783
</nav>
784
</div>
785
</div>
786
</div>
787
788
789
790
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
791
<div class="md-sidebar__scrollwrap">
792
<div class="md-sidebar__inner">
793
794
795
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
796
797
798
799
800
801
802
<label class="md-nav__title" for="__toc">
803
<span class="md-nav__icon md-icon"></span>
804
Table of contents
805
</label>
806
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
807
808
<li class="md-nav__item">
809
<a href="#clone-the-repository" class="md-nav__link">
810
<span class="md-ellipsis">
811
812
Clone the Repository
813
814
</span>
815
</a>
816
817
</li>
818
819
<li class="md-nav__item">
820
<a href="#environment-configuration" class="md-nav__link">
821
<span class="md-ellipsis">
822
823
Environment Configuration
824
825
</span>
826
</a>
827
828
</li>
829
830
<li class="md-nav__item">
831
<a href="#start-the-stack" class="md-nav__link">
832
<span class="md-ellipsis">
833
834
Start the Stack
835
836
</span>
837
</a>
838
839
<nav class="md-nav" aria-label="Start the Stack">
840
<ul class="md-nav__list">
841
842
<li class="md-nav__item">
843
<a href="#development" class="md-nav__link">
844
<span class="md-ellipsis">
845
846
Development
847
848
</span>
849
</a>
850
851
</li>
852
853
<li class="md-nav__item">
854
<a href="#production" class="md-nav__link">
855
<span class="md-ellipsis">
856
857
Production
858
859
</span>
860
</a>
861
862
</li>
863
864
</ul>
865
</nav>
866
867
</li>
868
869
<li class="md-nav__item">
870
<a href="#verify-installation" class="md-nav__link">
871
<span class="md-ellipsis">
872
873
Verify Installation
874
875
</span>
876
</a>
877
878
</li>
879
880
<li class="md-nav__item">
881
<a href="#common-issues" class="md-nav__link">
882
<span class="md-ellipsis">
883
884
Common Issues
885
886
</span>
887
</a>
888
889
</li>
890
891
</ul>
892
893
</nav>
894
</div>
895
</div>
896
</div>
897
898
899
900
<div class="md-content" data-md-component="content">
901
902
<article class="md-content__inner md-typeset">
903
904
905
906
907
908
909
910
911
<h1 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">&para;</a></h1>
912
<h2 id="clone-the-repository">Clone the Repository<a class="headerlink" href="#clone-the-repository" title="Permanent link">&para;</a></h2>
913
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/ConflictHQ/fossilrepo.git
914
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="nb">cd</span><span class="w"> </span>fossilrepo
915
</code></pre></div>
916
<h2 id="environment-configuration">Environment Configuration<a class="headerlink" href="#environment-configuration" title="Permanent link">&para;</a></h2>
917
<p>Copy the example environment file and configure it:</p>
918
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>cp<span class="w"> </span>.env.example<span class="w"> </span>.env
919
</code></pre></div>
920
<p>Edit <code>.env</code> with your settings:</p>
921
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="c1"># Django</span>
922
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="na">SECRET_KEY</span><span class="o">=</span><span class="s">your-secret-key-here</span>
923
<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="na">DEBUG</span><span class="o">=</span><span class="s">True</span>
924
<a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a><span class="na">ALLOWED_HOSTS</span><span class="o">=</span><span class="s">localhost,127.0.0.1</span>
925
<a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a>
926
<a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a><span class="c1"># Database</span>
927
<a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></a><span class="na">POSTGRES_DB</span><span class="o">=</span><span class="s">fossilrepo</span>
928
<a id="__codelineno-2-8" name="__codelineno-2-8" href="#__codelineno-2-8"></a><span class="na">POSTGRES_USER</span><span class="o">=</span><span class="s">fossilrepo</span>
929
<a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a><span class="na">POSTGRES_PASSWORD</span><span class="o">=</span><span class="s">your-db-password</span>
930
<a id="__codelineno-2-10" name="__codelineno-2-10" href="#__codelineno-2-10"></a>
931
<a id="__codelineno-2-11" name="__codelineno-2-11" href="#__codelineno-2-11"></a><span class="c1"># Redis</span>
932
<a id="__codelineno-2-12" name="__codelineno-2-12" href="#__codelineno-2-12"></a><span class="na">REDIS_URL</span><span class="o">=</span><span class="s">redis://redis:6379/0</span>
933
<a id="__codelineno-2-13" name="__codelineno-2-13" href="#__codelineno-2-13"></a>
934
<a id="__codelineno-2-14" name="__codelineno-2-14" href="#__codelineno-2-14"></a><span class="c1"># Fossil</span>
935
<a id="__codelineno-2-15" name="__codelineno-2-15" href="#__codelineno-2-15"></a><span class="na">FOSSIL_REPO_DIR</span><span class="o">=</span><span class="s">/data/repos</span>
936
<a id="__codelineno-2-16" name="__codelineno-2-16" href="#__codelineno-2-16"></a><span class="na">FOSSIL_BASE_URL</span><span class="o">=</span><span class="s">https://your-domain.com</span>
937
</code></pre></div>
938
<h2 id="start-the-stack">Start the Stack<a class="headerlink" href="#start-the-stack" title="Permanent link">&para;</a></h2>
939
<h3 id="development">Development<a class="headerlink" href="#development" title="Permanent link">&para;</a></h3>
940
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="c1"># Build and start all services</span>
941
<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a>make<span class="w"> </span>build
942
<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a>
943
<a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a><span class="c1"># Run database migrations</span>
944
<a id="__codelineno-3-5" name="__codelineno-3-5" href="#__codelineno-3-5"></a>make<span class="w"> </span>migrate
945
<a id="__codelineno-3-6" name="__codelineno-3-6" href="#__codelineno-3-6"></a>
946
<a id="__codelineno-3-7" name="__codelineno-3-7" href="#__codelineno-3-7"></a><span class="c1"># Create an admin user</span>
947
<a id="__codelineno-3-8" name="__codelineno-3-8" href="#__codelineno-3-8"></a>make<span class="w"> </span>superuser
948
<a id="__codelineno-3-9" name="__codelineno-3-9" href="#__codelineno-3-9"></a>
949
<a id="__codelineno-3-10" name="__codelineno-3-10" href="#__codelineno-3-10"></a><span class="c1"># Load sample data (optional)</span>
950
<a id="__codelineno-3-11" name="__codelineno-3-11" href="#__codelineno-3-11"></a>make<span class="w"> </span>seed
951
</code></pre></div>
952
<p>The development stack includes:</p>
953
<ul>
954
<li>Django dev server on <code>http://localhost:8000</code></li>
955
<li>PostgreSQL 16</li>
956
<li>Redis</li>
957
<li>Celery worker + beat</li>
958
<li>Mailpit on <code>http://localhost:8025</code></li>
959
</ul>
960
<h3 id="production">Production<a class="headerlink" href="#production" title="Permanent link">&para;</a></h3>
961
<p>For production, you'll also configure Caddy and Litestream:</p>
962
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="c1"># Copy production configs</span>
963
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>cp<span class="w"> </span>docker/Caddyfile.example<span class="w"> </span>docker/Caddyfile
964
<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a>cp<span class="w"> </span>docker/litestream.yml.example<span class="w"> </span>docker/litestream.yml
965
<a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a>
966
<a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a><span class="c1"># Edit with your domain and S3 credentials</span>
967
<a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a><span class="c1"># Then start with the production compose file</span>
968
<a id="__codelineno-4-7" name="__codelineno-4-7" href="#__codelineno-4-7"></a>docker<span class="w"> </span>compose<span class="w"> </span>-f<span class="w"> </span>docker-compose.yml<span class="w"> </span>-f<span class="w"> </span>docker-compose.prod.yml<span class="w"> </span>up<span class="w"> </span>-d
969
</code></pre></div>
970
<h2 id="verify-installation">Verify Installation<a class="headerlink" href="#verify-installation" title="Permanent link">&para;</a></h2>
971
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="c1"># Check all services are running</span>
972
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a>docker<span class="w"> </span>compose<span class="w"> </span>ps
973
<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a>
974
<a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a><span class="c1"># Hit the health endpoint</span>
975
<a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a>curl<span class="w"> </span>http://localhost:8000/health/
976
<a id="__codelineno-5-6" name="__codelineno-5-6" href="#__codelineno-5-6"></a>
977
<a id="__codelineno-5-7" name="__codelineno-5-7" href="#__codelineno-5-7"></a><span class="c1"># Open the dashboard</span>
978
<a id="__codelineno-5-8" name="__codelineno-5-8" href="#__codelineno-5-8"></a>open<span class="w"> </span>http://localhost:8000
979
</code></pre></div>
980
<div class="admonition success">
981
<p class="admonition-title">You should see</p>
982
<p>The fossilrepo dashboard with navigation, login page, and (after seeding) sample repositories.</p>
983
</div>
984
<h2 id="common-issues">Common Issues<a class="headerlink" href="#common-issues" title="Permanent link">&para;</a></h2>
985
<details class="question">
986
<summary>Port 8000 already in use</summary>
987
<p>Change the Django port mapping in <code>docker-compose.yml</code>:
988
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="nt">ports</span><span class="p">:</span>
989
<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&quot;8001:8000&quot;</span>
990
</code></pre></div></p>
991
</details>
992
<details class="question">
993
<summary>Database connection refused</summary>
994
<p>Ensure PostgreSQL has started before Django:
995
<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>docker<span class="w"> </span>compose<span class="w"> </span>logs<span class="w"> </span>postgres
996
</code></pre></div>
997
The Django container waits for Postgres to be ready, but network issues on some Docker Desktop versions can cause timeouts. Restart with <code>make down &amp;&amp; make up</code>.</p>
998
</details>
999
<details class="question">
1000
<summary>Permission denied on /data/repos</summary>
1001
<p>The Fossil repo directory needs to be writable by the container user:
1002
<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>sudo<span class="w"> </span>chown<span class="w"> </span>-R<span class="w"> </span><span class="m">1000</span>:1000<span class="w"> </span>/data/repos
1003
</code></pre></div></p>
1004
</details>
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
</article>
1019
</div>
1020
1021
1022
<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>
1023
1024
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
1025
</div>
1026
1027
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
1028
1029
<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>
1030
Back to top
1031
</button>
1032
1033
</main>
1034
1035
<footer class="md-footer">
1036
1037
<div class="md-footer-meta md-typeset">
1038
<div class="md-footer-meta__inner md-grid">
1039
<div class="md-copyright">
1040
1041
<div class="md-copyright__highlight">
1042
Copyright &copy; 2026 CONFLICT LLC
1043
</div>
1044
1045
1046
Made with
1047
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
1048
Material for MkDocs
1049
</a>
1050
1051
</div>
1052
1053
1054
<div class="md-social">
1055
1056
1057
1058
1059
1060
1061
1062
1063
<a href="https://github.com/ConflictHQ/fossilrepo" target="_blank" rel="noopener" title="github.com" class="md-social__link">
1064
<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>
1065
</a>
1066
1067
</div>
1068
1069
</div>
1070
</div>
1071
</footer>
1072
1073
</div>
1074
<div class="md-dialog" data-md-component="dialog">
1075
<div class="md-dialog__inner md-typeset"></div>
1076
</div>
1077
1078
1079
1080
1081
1082
<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>
1083
1084
1085
<script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
1086
1087
1088
</body>
1089
</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