Prerequisites
Before setting up Fystack, ensure your system meets the following requirements.
System Requirements
| Resource | Minimum | Recommended |
|---|---|---|
| CPU | 4 vCPU | 4+ vCPU |
| RAM | 8 GB | 8+ GB |
| Disk | 20 GB | 50 GB+ |
| OS | Linux, macOS, Windows (WSL2) | Ubuntu 22.04+ |
If you're indexing fast blockchains like BSC or Solana (which produce blocks every ~400ms), 4 vCPU and 8 GB RAM is the minimum to keep up with block processing without falling behind.
Required Software
Docker & Docker Compose
Fystack runs entirely in Docker containers. You need Docker Engine with the Compose plugin (v2).
Linux (Ubuntu/Debian):
# Install Docker
curl -fsSL https://get.docker.com | sh
# Add your user to the docker group (log out and back in after)
sudo usermod -aG docker $USER
# Verify installation
docker --version
docker compose version
macOS:
Install Docker Desktop for Mac. Docker Compose is included.
Windows:
Fystack on Windows requires WSL2. See Windows Setup below.
jq
jq is used by the setup scripts to parse JSON configuration.
# Ubuntu/Debian
sudo apt update && sudo apt install -y jq
# macOS
brew install jq
# Verify
jq --version
Git
# Ubuntu/Debian
sudo apt install -y git
# macOS
brew install git
Platform Support
| Platform | Status |
|---|---|
| Linux | Fully supported |
| macOS | Fully supported (requires Docker Desktop) |
| Windows | Supported via WSL2 |
Windows (WSL2) Setup
Non-Windows users can skip this section.
1. Install WSL2
Open PowerShell as Administrator:
wsl --install
This installs WSL2 with Ubuntu by default. Restart your machine when prompted.
2. Install Docker Desktop for Windows
Download and install Docker Desktop. During setup, ensure "Use the WSL 2 based engine" is checked (it's the default).
After installation, go to Docker Desktop Settings > Resources > WSL Integration and enable integration for your WSL2 distro (e.g., Ubuntu).
3. Install jq inside WSL2
Open your WSL2 terminal (Ubuntu):
sudo apt update && sudo apt install -y jq
4. Run all commands from WSL2
All subsequent commands must be run from within a WSL2 terminal, not from PowerShell or CMD:
wsl
Next Steps
Once your system meets these requirements, proceed to Third-Party Services to set up the API keys you'll need before installation.