flock Flock home

These are the docs of the beta, v1.1.0-beta.1. Some of it isn't in the stable release yet. Stable docs

Docs  /  Reference

Configuration

Most settings are changed from the Flock app or the CLI. This page describes where they are stored.

Project files

File Purpose
.flockrc PHP (php=8.5) and optionally Node (node=22) versions for the project. Commit it.
flock.yml How the project's git worktrees are set up. Commit it; flock.local.yml next to it holds your machine's settings.
.nvmrc / .node-version Node version, read the same way as by nvm and other tools. Only version numbers count; aliases like lts/* are ignored.

Project files are looked up from the current directory upwards. See Per-project versions.

Data directory

Flock keeps PHP and Node builds, service data, certificates, caught mail and logs in its data directory:

Platform Location
Windows %AppData%\Flock
macOS ~/Library/Application Support/Flock
Linux ~/.local/share/flock (or $XDG_DATA_HOME/flock)

Settings → General shows the exact path under Data, and Show in Finder (macOS), Show in Explorer (Windows) or Open (Linux) opens it.

config.json

Global settings live in config.json in the data directory. Edit them through the app or the CLI rather than by hand, because the daemon owns this file. It contains:

  • the TLD (default test),
  • the default PHP and Node versions,
  • the release channel (stable, beta), and the Xdebug and dump capture switches,
  • parked folders and linked sites, with their PHP and Node versions, HTTPS state and extra domains,
  • the ports Flock uses.

Ports

Port Used for
80 / 443 Web server (HTTP / HTTPS)
53535 DNS for .test (macOS and Linux; Windows uses 53)
2525 Mail catcher (SMTP)
9912 Dump server
9003 Xdebug client (your editor)
53531 Local API used by the apps (token protected)
5432, 3306, 6379, … Services, see Databases & services

Each service's port can be changed when you install it, or later (see Databases & services). Flock warns you, naming the program, if a port is already taken.

Settings → General shows the domain under Network.

php.ini

Each PHP version has its own php.ini, and Flock never overwrites your changes. See PHP.

Spotted a mistake? Edit this page on GitHub or let us know. Docs for v1.1.0-beta.1