Installation Guide¶
Deployment Options¶
| Method | Best For | Complexity |
|---|---|---|
| Docker Compose | Development, small deployments | Low |
| Docker Compose (Production) | Single-server production | Medium |
| Kubernetes + Helm | Multi-node, high availability | High |
Docker Compose¶
Prerequisites¶
- Docker 24.0+
- Docker Compose v2.20+
- 4 GB RAM minimum
Steps¶
# 1. Clone repository
git clone https://github.com/stefanposs/file-flux.git
cd file-flux
# 2. Configure environment
cp .env.example .env
# Edit .env with your settings (especially JWT_SECRET and passwords)
# 3. Start services
docker compose up -d
# 4. Verify
docker compose ps
curl http://localhost:3001/health
Initial Setup¶
- Open
http://localhost:3000 - Login with default admin credentials
- Change the admin password immediately
- Create agent tokens
- Install agents on endpoint machines
Kubernetes¶
Prerequisites¶
- Kubernetes 1.28+
- Helm 3.x
kubectlconfigured
Helm Installation¶
# Add FileFlux helm repo
helm repo add fileflux https://stefanposs.github.io/file-flux/charts
# Install
helm install fileflux fileflux/file-flux \
--namespace fileflux \
--create-namespace \
--set backend.jwtSecret="your-secret-here" \
--set postgresql.auth.password="db-password"
# Verify
kubectl -n fileflux get pods
See Production for hardening guidance.