Install redfish
By the end of this page redfish runs on your machine and you can sign in with the first operator account.
Requirements
Section titled “Requirements”Docker with the compose plugin. Nothing else: no Node, no build toolchain on the host. Everything builds and runs in containers.
Quick start
Section titled “Quick start”Clone the repository, create the secrets file, and start the stack.
git clone https://github.com/selfhostr/redfish.gitcd redfishcp .env.example .envOpen .env and set REDFISH_SECRET_KEY to a high-entropy value of at least 32 bytes. Generate one with:
openssl rand -base64 32The key is validated at startup: a missing or weak value stops the application before it serves anything. It encrypts the sending-profile secrets stored in the database, so keep it and back it up. See Configuration for the full list of variables.
Start the services:
docker compose up -dThe default Compose file runs two services for development, app and worker, both from the dev build target. For a production image without the code volume, use the prod profile:
docker compose --profile prod up -d web worker-prodThe web service applies the database migrations at startup, and the worker waits until web is healthy.
First sign in
Section titled “First sign in”The application answers on http://localhost:3000. A health check is available at GET /health, which returns {"status":"ok"}. Create the first operator account on your first visit, then create your first organization and import targets. See Campaigns.
By default the application listens on port 3000, published as 3000:3000 in Compose. In production you put a reverse proxy in front of it and serve the operator dashboard and the public tracking links on two separate host names. See host isolation in Configuration.
Where the data lives
Section titled “Where the data lives”redfish uses a single SQLite database at data/redfish.db, mounted from the data/ folder in the repository. Everything you create lives there: organizations, targets, campaigns, events and encrypted sending-profile secrets. Back up that folder, or enable continuous replication. See Operations for retention and backup.