Installing Faraday¶
Choose the installation method that best fits your environment. Docker Compose is the recommended approach for most users.
Installation Methods¶
| Method | Best For | Edition | Difficulty |
|---|---|---|---|
| Docker Compose | Production & development | Community, Pro, Corp | Easy |
| Ubuntu / Debian / Kali | Bare-metal Linux servers | Pro, Corp | Medium |
| RHEL 8+ / CentOS / Rocky | Enterprise Linux servers | Pro, Corp | Medium |
| Community (pip / source) | Community edition, contributors | Community | Medium |
System Requirements¶
Before installing, review the System Requirements page. Key minimums:
| Component | Minimum | Recommended |
|---|---|---|
| CPU | Quad-core 2 GHz | Octa-core |
| RAM | 4 GB | 8 GB (16 GB for large networks) |
| Disk | 40 GB | 80 GB+ (PostgreSQL data grows with usage) |
| OS | 64-bit Linux | Ubuntu 22.04 LTS, RHEL 8/9 |
| PostgreSQL | 12+ | 14+ |
| Redis | 6.0+ | 7.x |
| Python | 3.9+ (bare-metal only) | 3.11 |
Quick Start (Docker Compose)¶
The fastest way to get Faraday running:
# 1. Save the docker-compose.yaml from the Faraday repository
curl -O https://raw.githubusercontent.com/infobyte/faraday/master/docker-compose.yaml
# 2. Launch all services
docker compose up -d
# 3. Check logs for the auto-generated admin password
docker compose logs faraday-server | grep "Admin password"
Faraday will be available at http://localhost:5985.
For detailed instructions, see the Docker Compose Installation Guide.
Post-Installation¶
After installing Faraday using any method:
- Access the Web UI at
http://<your-server>:5985 - Log in with the credentials generated during setup
- Change the default password immediately
- Follow the First Steps guide to create your first workspace and import scan data
Additional Setup¶
| Guide | Description |
|---|---|
| NGINX / SSL / WebSocket Setup | Reverse proxy with TLS termination |
| Updating Faraday | Upgrading to a newer version |
| Troubleshooting | Common installation issues |
Architecture Overview¶
Faraday consists of the following components:
- Faraday Server — Flask-based REST API (port 5985)
- PostgreSQL — Primary data store
- Redis — Message broker for Celery task queues
- Celery Workers — Background task processing (vulnerability ingestion, report generation)
- WebSocket Service — Real-time notifications to the UI
For a detailed architecture description, see the Architecture page.
