Quickstart¶

This page describes how to start the stack for local development and how to use starter templates.

Local development (fast):

1. Copy example environment and prepare data folder:

cp templates/.env .env
mkdir -p data/reflex/app && touch data/reflex/requirements.txt

1. Start a subset or all services using compose profiles. Example — start everything:

docker compose --profile all up -d

1. Visit the services you need (see Services for ports and addresses).

Using templates:

• Starter templates are under templates/. For example templates/reflex contains a basic entrypoint and a systemd unit example.
• Copy or adapt files from templates/* to your deployment configuration or into appropriate directories under deploy/.

Deployment (production-ish):

• The deploy compose file is deploy/compose/compose.yml. It is intended for production-like deployments and does not bind host ports directly.
• Before first start, ensure persistent host directories exist and have correct ownership:

bash deploy/compose/zerostart.sh

• Copy the example env for deploy compose into deploy/compose and adjust values:

cp templates/deploy/compose/.env deploy/compose/.env

Notes: - The deploy compose intentionally expects a reverse proxy or tunnel (no host-facing ports). Use the appropriate reverse-proxy configuration for your hosting environment. - If you prefer, you can reuse the local compose.yaml for small single-server deployments but review and adjust port mappings and secrets.