|
1
|
# Prerequisites |
|
2
|
|
|
3
|
Before installing fossilrepo, ensure your server meets these requirements. |
|
4
|
|
|
5
|
## System Requirements |
|
6
|
|
|
7
|
| Requirement | Minimum | |
|
8
|
|---|---| |
|
9
|
| **OS** | Linux (Ubuntu 22.04+, Debian 12+, RHEL 9+) or macOS 13+ | |
|
10
|
| **CPU** | 1 vCPU | |
|
11
|
| **RAM** | 1 GB | |
|
12
|
| **Disk** | 10 GB (scales with repo count) | |
|
13
|
| **Python** | 3.12+ | |
|
14
|
|
|
15
|
## Required Software |
|
16
|
|
|
17
|
### Docker & Docker Compose |
|
18
|
|
|
19
|
Fossilrepo runs its infrastructure stack via Docker Compose. |
|
20
|
|
|
21
|
=== "Ubuntu/Debian" |
|
22
|
|
|
23
|
```bash |
|
24
|
# Install Docker |
|
25
|
curl -fsSL https://get.docker.com | sh |
|
26
|
sudo usermod -aG docker $USER |
|
27
|
|
|
28
|
# Verify |
|
29
|
docker compose version |
|
30
|
``` |
|
31
|
|
|
32
|
=== "macOS" |
|
33
|
|
|
34
|
```bash |
|
35
|
# Install Docker Desktop |
|
36
|
brew install --cask docker |
|
37
|
|
|
38
|
# Verify |
|
39
|
docker compose version |
|
40
|
``` |
|
41
|
|
|
42
|
### Git |
|
43
|
|
|
44
|
Required for the sync bridge (mirroring to GitHub/GitLab). |
|
45
|
|
|
46
|
```bash |
|
47
|
git --version # 2.30+ |
|
48
|
``` |
|
49
|
|
|
50
|
### Make |
|
51
|
|
|
52
|
Used for running common commands. |
|
53
|
|
|
54
|
```bash |
|
55
|
make --version |
|
56
|
``` |
|
57
|
|
|
58
|
## Optional: S3-Compatible Storage |
|
59
|
|
|
60
|
For continuous backups via Litestream, you need an S3-compatible bucket: |
|
61
|
|
|
62
|
- **AWS S3** |
|
63
|
- **MinIO** (self-hosted) |
|
64
|
- **Backblaze B2** |
|
65
|
- **DigitalOcean Spaces** |
|
66
|
|
|
67
|
!!! info "Local development" |
|
68
|
S3 is not required for local development. Litestream is disabled by default in the dev Docker Compose configuration. |
|
69
|
|
|
70
|
## Ports |
|
71
|
|
|
72
|
The following ports are used by the stack: |
|
73
|
|
|
74
|
| Port | Service | |
|
75
|
|---|---| |
|
76
|
| `8000` | Django (management UI) | |
|
77
|
| `443` | Caddy (HTTPS, production) | |
|
78
|
| `80` | Caddy (HTTP redirect, production) | |
|
79
|
| `5432` | PostgreSQL | |
|
80
|
| `6379` | Redis | |
|
81
|
| `8025` | Mailpit (dev only) | |
|
82
|
|