Project Setup

Get the Fystack codebase and prepare the configuration files.

1. Docker Login

Fystack Docker images are hosted on Docker Hub under the fystacklabs organization. Authenticate first:

docker login -u fystacklabs

When prompted, enter the password provided to you.

Need access?

Join the Fystack Telegram community to get Docker access credentials.

2. Clone the Repository

git clone git@github.com:fystack/fystack-selfhost-scripts.git
cd fystack-selfhost-scripts

3. Copy Configuration Templates

cp ./dev/config.yaml.template ./dev/config.yaml
cp ./dev/config.rescanner.yaml.template ./dev/config.rescanner.yaml
cp ./dev/config.indexer.yaml.template ./dev/config.indexer.yaml

This creates three configuration files from the provided templates:

File	Purpose
config.yaml	Main Apex API configuration — networks, CORS, keys, prices, email
config.indexer.yaml	Multichain indexer — which chains to index, RPC endpoints
config.rescanner.yaml	Rescanner — block gap recovery (primarily Solana)

Next Steps

Before starting Fystack, you need to understand the configuration and set up your API keys:

1. Configuration Overview — understand what each field in config.yaml does
2. Third-Party Services — set up CoinMarketCap (mandatory) and other services
3. Start Fystack — run the startup script